git提交规范工具git hooks+husky+lint-staged+commitlint

屿正
511 阅读4分钟

1.什么是git hooks？

git hooks也可以说是git钩子或git的回调方法，在git执行某个事件之前或者之后进行一些其他额外的操作，如果希阻止一些不合规的提交信息，那么就需要使用到hooks的钩子函数。

详细的hooks介绍，可以查看官网文档：
英文：git-scm.com/book/en/v2/…
中文：git-scm.com/book/zh/v2/…

其中比较常用的一般只有两个：

Git hook调用时机说明
pre-commitgit commit执行之前
它不接受任何参数，并且在获取提交日志消息并进行提交之前被调用。例如，检查是否有所遗漏，确保测试运行，以及核查代码。 如果该钩子以非零值退出，Git 将放弃此次提交。		可以用 git commit --no-verify 来绕过这个环节
commit-msggit commit执行之前
钩子接收一个参数，可以用来规范化标准格式，并且可以按需指定是否要拒绝本次提交		可以用 git commit --no-verify 来绕过这个环节

2.使用husky + commitlint检查提交描述信息是否符合规范

需要使用到两个工具

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

  1. 安装 commitlint
npm install @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4 --save-dev

创建commitlint.config.js文件

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]
  }
}
  1. 安装 husky
npm install husky@7.0.1 --save-dev

启用hooks，生成.husky文件夹

npx husky install

image.png

在package.json中生成prepare脚本（需要npm > 7.0版本）

npm set-script prepare "husky install"

image.png

执行prepare命令，提示成功

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

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

image.png

到此为止，不符合规范的commit将不可再提交

image.png

3.通过pre-commit检测提交代码规范

Eslint和Prettier配合使用可以解决在本地代码格式问题，但是这样的一个格式处理问题，他只能够在本地进行处理，并且我们还需要 手动在 VSCode 中配置自动保存 才可以。那么这样就会存在一个问题，忘记配置这个东西了怎么办呢？那岂不是把写的乱七八糟的代码直接就提交了。

想要解决这个问题需要使用 husky 配合 eslint 才可以实现。

  • 我们期望通过 husky 监测 pre-commit 钩子，在该钩子下执行 npx eslint --ext .js,.vue src 指令来去进行相关检测：
// 执行脚本
npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src"

执行后生成对应文件pre-commit image.png

  • 关闭 VSCode 的自动保存操作
  • 修改一处代码，使其不符合 ESLint 校验规则
  • 执行 提交操作 会发现，抛出一系列的错误，代码无法提交

3.lint-staged 自动修复格式错误

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

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

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

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

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

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

修改package.json配置

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

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

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

修改 .husky/pre-commit 文件

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged

配置完成之后，再次提交代码，发现暂存区中不符合Eslint的内容，被自动修复。

参考链接：juejin.cn/post/741700…

avatar
文章
阅读
粉丝