SlugTeam

# 通用组件脚手架

快速启动通用组件编写，默认支持 typescript，注释文档导出，jest 单元测试等专业工具集成。

# 用法

从 git（http://git.code.oa.com/slugteam/comStage.git）上克隆项目到本地，既可开始使用

# 目录说明

  • dist //组件输出目录
  • node_modules //依赖包
  • src //源码
  • template //调用示例
  • test //测试用例

# 特性

  • 0 配置
  • 基于 rollup 打包，组件输出体积小
  • 支持 TS，只需将.js 改为.ts 即可
  • 基于 jest 单元测试
  • 基于 jeDOC 根据注释自动输出 html,md 等格式的文档
  • 支持输出 esm,umd,cjs 格式
  • 集成开发环境，自动构建组件，热更新调用模板

# 脚本命令

需要 node v10 以上版本支持，拉取项目到本地，生成基本的 package.json、template、test 等目录

  • npm i //安装辅助依赖
  • npm run dev //启动本地服务
  • npm run doc //输出 markdown 格式的文档
  • npm run watch //监听源代码变化，自动构建组件输出
  • npm run test //跑通测试用例吧
  • npm run build //构建生产环境版本输出

如果 npm 安装失败，可以参考此文章（https://www.cnblogs.com/liangxiaojie/p/4595406.html）的解决办法

未来计划改造成自动安装模式，可以选择接入 vue 或 react 等其他框架的可选配置项目，进一步简化接入的逻辑和安装成本。