代码提交描述（commitlint）

用到的工具：

1. commitlint：用于检查提交信息
2. husky：是git hooks工具

安装commitlint

yarn add @commitlint/config-conventional @commitlint/cli -D

创建commitlint.config.js 文件

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

打开 commitlint.config.js ， 增加配置项（ config-conventional 默认配置点击可查看 ）：

   module.exports = {
     // 继承的规则
     extends: ['@commitlint/config-conventional'],
     // 定义规则类型
     rules: {
       // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
       'type-enum': [
         2,
         'always',
         [
           'feat', // 新功能 feature
           'fix', // 修复 bug
           'docs', // 文档注释
           'style', // 代码格式(不影响代码运行的变动)
           'refactor', // 重构(既不增加新功能，也不是修复bug)
           'perf', // 性能优化
           'test', // 增加测试
           'chore', // 构建过程或辅助工具的变动
           'revert', // 回退
           'build' // 打包
         ]
       ],
       // subject 大小写不做校验
       'subject-case': [0]
     }
   }

此时提交代码时还不会进行检测，还需要配合git hook 工具。

安装husky

npm install husky --save-dev
# or
yarn add husky --dev

启动husky，生成.husky文件夹

npx husky install
# or
yarn husky install

增加 commit-msg 勾子

将commitlint的hook到husky中，并指令在commit-msg的hooks下执行npx --no -- commitlint --edit ${1}

使用下面命令增加一个 git 提交信息的勾子，会在 .husky目录下创建一个 commit-msg 文件。

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

测试