配置 Git hooks

Git hooks 简介

Git hooks 是 Git 在执行特定操作时触发的脚本，借助 Git hooks 可以实现代码检查、自动化测试、代码格式化等功能。

GIt hooks 脚本文件存放在 git 仓库根目录的.git/hooks/目录下，每个文件对应一个 Git hooks。例如pre-commit文件对应 pre-commit hooks。

默认情况下，所有的 Git hooks 脚本文件都带有一个.sample后缀，表示该文件是示例文件，不生效。如果需要启用某个 Git hooks，需要将.sample后缀去掉。编写 Git hooks 脚本文件时，需要使用 bash 语言。

常用的 Git hooks

Hook 名称	调用时机	说明
pre-commit	git commit执行前（--no-verify可绕过）	可用于检查代码是否通过测试、是否有未暂存的更改等
commit-msg	git commit执行前，但在提交信息准备完成后（--no-verify可绕过）	验证提交信息是否符合特定格式或内容要求
post-commit	git commit执行后	可用于通知、部署等操作，但不影响提交结果
prepare-commit-msg	git commit执行后，编辑器打开之前	准备或修改提交信息
pre-rebase	git rebase执行前（--no-verify可绕过）	检查是否满足 rebase 的条件
post-checkout/post-switch	git checkout或git switch执行后（在某些情况下，如git clone之后也会执行；在执行git pull时，如果包含git merge，则post-merge也会被调用）	更新工作环境等
post-merge	git merge或git pull（包含git fetch和git merge）导致的合并操作完成后	处理合并后的操作
pre-push	git push执行前	检查远程仓库的权限或状态等
pre-receive	git-receive-pack处理git push操作前	检查推送的分支或标签等
update	当git-receive-pack对git push作出反应并更新仓库中的引用时	执行更新操作（此钩子可能多次被调用，因为一次推送可能更新多个引用）
post-receive	当git-receive-pack更新仓库中的引用后（以及当推送试图更新当前被签出的分支且receive.denyCurrentBranch配置被设置为updateInstead时）	通知、部署等操作
pre-auto-gc	git gc --auto执行前	配置或检查垃圾回收的条件
sendemail-validate	git send-email发送邮件前	验证邮件发送的配置或内容

完整的 Git hooks 列表：https://git-scm.com/docs/githooks

配置 Git hooks

默认情况下，Git hooks 的脚本都需要存放在.git/hooks/目录下。但是.git/目录的文件属于本地仓库并不会同步到远程仓库。这样就造成一个问题：当其他开发者克隆仓库时，这些 hooks 脚本并不会被克隆下来。

对于这个问题由两个解决方案：

1. 将 hooks 脚本存放在其他目录，然后通过core.hooksPath配置项指定 hooks 脚本的存放路径。
2. 使用工具来管理 hooks 脚本，如Husky。

core.hooksPath

通过设置core.hooksPath，可以将 Git hooks 的脚本存放在其他目录。这样我们就可以把 hooks 脚本存放在项目的根目录下，这样其他开发者克隆仓库时，这些 hooks 脚本也会被克隆下来。不过，这种方式有个弊端就是需要每个开发者都需要手动设置core.hooksPath，并不是特别方便。而husky工具则可以完全避免这个问题。

Husky

Husky 是一个让配置 Git 钩子变得更简单的工具。它允许开发者在项目根目录中编写一个配置文件，然后在安装 Husky 时将该配置文件与 Git Hook 关联起来。这样，开发者就可以在团队中方便地使用 Git Hook，而无需在每个开发者的本地环境中手动配置 Hooks。

Husky 原理

Husky 的原理很简单，就是通过在安装 Husky 时，将会在.husky/目录下创建一个.husky/_/目录，然后将 Husky 的 Git Hook 脚本复制到其中中，并将core.hooksPath改为.husky/_/。这样，当 Git Hook 被触发时，Husky 的脚本就会被执行。

所以在使用 Husky 时，我们只需要在项目根目录下创建一个.husky/目录，然后在其中创建 Git Hook 的脚本即可。

Husky 使用说明

1. 安装 Husky

yarn add husky --dev

2. 初始化 Husky

npx husky init

init 命令简化了项目中的 husky 设置。它会在 .husky/ 中创建 pre-commit 脚本，并更新 package.json 中的 prepare 脚本。

所使用的 Husky 版本

• husky：9.1.7。

INFO

更多 Husky 知识可查看：https://typicode.github.io/husky/

项目实战

了解了 Git hooks 的原理和使用方法后，我们就可以在项目中使用 Git hooks 来实现一些自动化操作。比如前面所说的，为了保证 commit message 可读性，我们给 commit message 制定的一套规范。现在我们就可以借助 Husky 在提交代码时自动检查 commit message 是否符合规范，如果不符合规范，则阻止提交。

具体需求:

1. 由于需要对 commit message 进行检查, 因此需要新增 commit-msg 钩子
2. 采用commitlint工具进行 commit message 格式检查
3. 采用husky工具管理 Git hooks

安装依赖

yarn add @commitlint/{cli,config-conventional} husky --dev

所使用的 commitlint 插件版本

• @commitlint/cli: 19.6.1
• @commitlint/config-conventional: 19.6.0

配置 commitlint

执行以下命令，在项目根目录下创建一个commitlint.config.js文件，并添加内容：

echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

配置 Husky

执行以下命令，在.husky/目录下创建一个commit-msg文件，并添加内容：

echo "yarn commitlint --edit \$1" > .husky/commit-msg

完成以上步骤后，我们就可以在提交代码时自动检查 commit message 是否符合规范了。如果不符合规范，则阻止提交。

此时，commitlint 采用的是@commitlint/config-conventional规范。根据《第 4 章：git 篇-commit 规范》的要求，需要对commitlint.config.js文件做如下调整：

INFO

commitlint 配置项说明文档：https://commitlint.js.org/reference/configuration.html

// commitlint 配置项说明：https://commitlint.js.org/reference/configuration.html
export default {
  extends: ['@commitlint/config-conventional'],

  /**
   * 自定义 commitlint 规则。详见：https://commitlint.js.org/reference/rules.html
   *
   * type-enum 限定的提交类型。
   *
   * feat：新增功能（feature）
   * fix：修补 bug
   * docs：文档（documentation）
   * style： 格式（不影响代码运行的变动）
   * refactor：重构（即不是新增功能，也不是修改 bug 的代码变动）
   * perf：改进性能的代码更改
   * test：增加测试用例
   * chore：构建过程或辅助工具的变动
   * delete：删除功能或者文件
   * modify：修改功能
   * build：改变构建流程，新增依赖库、工具等
   * ci：自动化流程配置更改
   * revert：代码回滚
   */
  rules: {
    'type-enum': [
      2,
      'always',
      ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'delete', 'modify', 'build', 'ci', 'revert']
    ]
  }
}

写在最后

本文主要阐述了 Git hooks 的基本原理及其操作方式，并深入探讨了如何利用 Husky 来高效管理这些 Git hooks。在项目开发流程中，Git hooks 能够助力我们实现自动化操作，例如，在代码提交阶段自动验证 commit message 是否遵循既定规范或者结合 lint-staged 实现代码校验等。在构建前端工程化体系时，Git hooks 无疑是一个举足轻重的工具，它不仅能够提升代码质量管理水平，还能促进团队协作的顺畅进行，且可根据实际需求灵活配置与应用。

本章节涉及的代码可查看：

待补充

参考

• https://commitlint.js.org/reference/configuration.html
• https://typicode.github.io/husky/
• https://git-scm.com/docs/githooks