提交规范工具:https://github.com/commitizen/cz-cli
git hooks husky:https://github.com/typicode/husky
一.commitizen
1.安装git提交规范工具(在项目中安装)
npm install --save-dev commitizen
npx commitizen init cz-conventional-changelog --save-dev --save-exact
2.在package.json中配置npm脚本
"scripts": {
"cm": "cz"
}
3.使用
git add .
npm run cm //或者 npx cz
4.效果
5.说明
值 | 描述 |
---|---|
feat | 新增一个功能 |
fix | 修复一个bug |
docs | 文档变更 |
style | 代码格式(不影响功能) |
refactor | 代码重构 |
perf | 改善性能 |
test | 测试 |
build | 构建或新增依赖 |
ci | 更改持续集成软件的配置文件和package中的scripts命令,例如scopes: Travis, Circle等 |
chore | 变更构建流程或辅助工具 |
revert | 代码回退 |
二.husky
1.安装husky
npx husky-init && npm install # npm
npx husky-init && yarn # Yarn 1
yarn dlx husky-init --yarn2 && yarn # Yarn 2
2.添加eslint修复命令
在项目根目录下的.husky/pre-commit中添加 npm run lint --fix
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npm run lint --fix