四、标准化编程规范解决方案之阻止不合规的提交消息

Git Hooks

上一节中我们使用了 git cz 来代替了 git commit 实现了规范化的提交诉求，但是依然存在着有人会忘记使用的问题。

那么这一节我们就来看一下这样的问题，我们应该如何去进行解决。

先来明确一下我们最终要实现的效果：

我们希望：

当《提交描述信息》不符合 约定式提交规范 的时候，阻止当前的提交，并抛出对应的错误提示

而要实现这个目的，我们就需要先来了解一个概念，叫做 Git hooks（git 钩子 || git 回调方法）

也就是：git 在执行某个事件之前或之后进行一些其他额外的操作

而我们所期望的 阻止不合规的提交消息，那么就需要使用到 hooks 的钩子函数。

下面是我整理出来的所有的 hooks ，大家可以进行一下参考，其中加粗的是常用到的 hooks：

PS：详细的 HOOKS介绍 可点击这里查看

整体的 hooks 非常多，但是我们其中用的比较多的其实只有两个：

简单来说这两个钩子：

1. commit-msg：可以用来规范化标准格式，并且可以按需指定是否要拒绝本次提交
2. pre-commit：会在提交前被调用，并且可以按需指定是否要拒绝本次提交

而我们接下来要做的关键，就在这两个钩子上面。使用 husky + commitlint 检查提交描述是否符合规范要求

在上一小节中，我们了解了 git hooks 的概念，那么接下来我们就使用 git hooks 来去校验我们的提交信息。

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

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

注意：npm 需要在 7.x 以上版本！！！！！

查看npm版本
npm -v

升级npm
npm i -g npm

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 提交的 type 必须在以下类型范围内
       'type-enum': [
         // 当前验证的错误级别，2代表错误级别的错误
         2,
         // 在什么情况下进行验证，always表示任何情况下都进行验证
         'always',
         // 泛型内容, 对应cz-config定义的types
         [
           'feat', // 新功能 feature
           'fix', // 修复 bug
           'docs', // 文档注释
           'style', // 代码格式(不影响代码运行的变动)
           'refactor', // 重构(既不增加新功能，也不是修复bug)
           'perf', // 性能优化
           'test', // 增加测试
           'chore', // 构建过程或辅助工具的变动
           'revert', // 回退
           'build' // 打包
         ]
       ],
       // 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 将不再可提交：

那么到这里我们的 规范化目标 就完成了吗？

当然没有！

现在我们还缺少一个 规范化的处理 ，那就是 代码格式提交规范处理！

有朋友看到这里可能说，咦！ 这个怎么看着这么眼熟啊？这个事情我们之前不是做过了吗？还需要在处理什么？

请看下一节分享《标准化编程规范解决方案之代码格式提交规范处理》