使用husky+ commitlint检查提交描述是否符合规范要求

要完成这么个目标，那么我们需要使用两个工具:

1. commitlint:用于检查提交信息
2. husky:是gits hook 工具

注意:npm 需要在7.x 以上版本!!!!!

那么下面我们分别来去安装一下这两个工具:

commitlint

1. 安装依赖：

npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4

2. 创建 commitlint.config.js 

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

3.打开 commitlint.config.js,增加配置项(config-conventional默认配置点击可查看):

module.exports = {// 继承规则extends: ['@commitlint/config-conventional'],// 自定义规则rules: {//type类型定义，表示git commit的type必须在以下类型范围内'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', 'revert']],//subject大小写不做校验'subject-case': [0]}
}

**注意:确保保存为`UTF-8`的编码格式*，否则可能会出现错误！

接下来安装husky:

1.安装依赖

npm install husky@7.0.1 --save-dev

2.启动 hooks , 生成.husky文件夹

npx husky install

3.在 package.json 中生成`prepare'指令(需要npm>7.0版本)
 

npm set-script prepare "husky install"

4.执行prepare命令 

npm  run prepare

5.执行成功提示

6. 添加 commitlint 的 hook 到`husky`中，并指令在commit-msg 的 hooks 下执行 npx --no-install commitlint --edit"$1”指令

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit"$1"'

7.此时的.husky 文件 

至此不符合commit规范的，将不能提交

PS F:\xxxxxxxxxxxxxxxxxxx\imooc-admin> git commit -m 'test'F:\xxxxxxxxxxxxxxxx\imooc-admin\src\views\Home.vue13:9  error  Strings must use singlequote  quotes✖ 1 problem (1 error, 0 warnings)1 error and 0 warnings potentially fixable with the `--fix` option.husky - pre-commit hook exited with code 1 (error)

我们通过 pre-commit 处理了 检测代码的提交规范问题，当我们进行代码提交时，会检测所有的代码格式规范 。

但是这样会存在两个问题：

1. 我们只修改了个别的文件，没有必要检测所有的文件代码格式
2. 它只能给我们提示出对应的错误，我们还需要手动的进行代码修改

那么这一小节，我们就需要处理这两个问题

那么想要处理这两个问题，就需要使用另外一个插件 lint-staged ！

lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送

lint-staged 无需单独安装，我们生成项目时，vue-cli 已经帮助我们安装过了，所以我们直接使用就可以了

1. 修改 package.json 配置

   "lint-staged": {"src/**/*.{js,vue}": ["eslint --fix","git add"]}

2. 如上配置，每次它只会在你本地 commit 之前，校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint )，校验会出现两种结果：

   1. 如果符合规则：则会提交成功。
   2. 如果不符合规则：它会自动执行 eslint --fix 尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。

3. 修改 .husky/pre-commit 文件

   #!/bin/sh
   . "$(dirname "$0")/_/husky.sh"npx lint-staged

4. 再次执行提交代码

5. 发现 暂存区中 不符合 ESlint 的内容，被自动修复