module-template
用于给基础模块建设使用的模板
- ✨ 让模块更加的规范, 更容易维护;
- 📦 使用 Rollup 打包, 输出 cjs, esm, umd 模块;
- 🔰 同步前端规范: eslint + prettier;
- 🛠️ 控制提交信息: husky + commitizen + commitlint;
- ℹ️ 规范更改日志: conventional-changelog;
- 📘 生成文档:jsdoc-to-markdown
- ⚙️ 接入单元测试:jest, 可根据文档自动生成对应的测试用例脚本
How to use
# 安装
npm i
# dev / build
npm run dev / build
# 生成文档及对应的测试用例
npm run generator
# test(先执行generator,才会有相应的测试用例)
npm run test:unit
# 测试覆盖率
npm run test:coverage
目录结构
.
├── docs // 文档
├── scripts // 构建脚本
└── src // 源码目录
└── main.js // 主入口文件
├── .husky // husky目录
├── jest.config.js // jest配置文件
├── jsdoc2md.json // jsdoc2md配置
├── rollup.config.js // rollup配置文件
├── commitlint.config.js // commitlint配置
├── eslintrc.js // eslint配置
├── .prettierrc // prettier配置
├── .babelrc // babel配置
├── CHANGELOG.md // 更新日志
└── README.md