详解如何在项目中使用git Hooks(husky、yorkie)

14,527 阅读8分钟

本文主要解决以下问题:

  1. 什么是git Hooks钩子?
  2. 如何更方便地使用git Hooks钩子,与他人共享?

此文对应的github代码仓库:github.com/eyunhua/cod…

前言

在我们的日常开发过程中,通常都会使用git(分布式版本控制工具)去管理我们的项目,便于多人随时随地进行协同工作。开发完一个功能后,就需要通过git commit -m 'xxx'命令向代码库中提交代码,此时就涉及到对提交的代码和message进行检查,是否符合定义的规范。

此文我们就将重点介绍gitHooks钩子的作用和使用,结合代码提交时的检查、使用工具生成message、自动生成changelog这一篇文章,来使得我们提交代码的过程更规范!

git hooks钩子

什么是git hooks钩子

git hooks是一些自定义的脚本,用于控制git工作的流程,分为客户端钩子和服务端钩子。

客户端钩子

客户端钩子分为很多种。 下面把它们分为:提交工作流钩子、电子邮件工作流钩子和其它钩子。主要介绍提交工作流钩子:pre-commit、prepare-commit-msg、commit-msg、post-commit。

pre-commit(常用)

在键入提交信息前运行。 它用于检查即将提交的快照。例如,检查是否有所遗漏,确保测试运行,以及核查代码。 如果该钩子以非零值退出,Git 将放弃此次提交,不过你可以用 git commit --no-verify 来绕过这个环节。 你可以利用该钩子,来检查代码风格是否一致(运行类似 lint 的程序)、尾随空白字符是否存在(自带的钩子就是这么做的),或新方法的文档是否适当。

prepare-commit-msg

在启动提交信息编辑器之前,默认信息被创建之后运行。 它允许你编辑提交者所看到的默认信息。 该钩子接收一些选项:存有当前提交信息的文件的路径、提交类型和修补提交的提交的 SHA-1 校验。 它对一般的提交来说并没有什么用;然而对那些会自动产生默认信息的提交,如提交信息模板、合并提交、压缩提交和修订提交等非常实用。 你可以结合提交模板来使用它,动态地插入信息。

commit-msg(常用)

接收一个参数,此参数即上文提到的,存有当前提交信息的临时文件的路径。 如果该钩子脚本以非零值退出,Git 将放弃提交,因此,可以用来在提交通过前验证项目状态或提交信息

post-commit

在整个提交过程完成后运行。 它不接收任何参数,但你可以很容易地通过运行 git log -1 HEAD 来获得最后一次的提交信息。 该钩子一般用于通知之类的事情

服务端钩子

除了客户端钩子,作为系统管理员,你还可以使用若干服务器端的钩子对项目强制执行各种类型的策略。 这些钩子脚本在推送到服务器之前和之后运行。 推送到服务器前运行的钩子可以在任何时候以非零值退出,拒绝推送并给客户端返回错误消息,还可以依你所想设置足够复杂的推送策略。钩子包括:pre-receive、update、post-receive。

pre-receive

处理来自客户端的推送操作时,最先被调用的脚本是 pre-receive。 它从标准输入获取一系列被推送的引用。如果它以非零值退出,所有的推送内容都不会被接受。 你可以用这个钩子阻止对引用进行非快进(non-fast-forward)的更新,或者对该推送所修改的所有引用和文件进行访问控制。

update

update 脚本和 pre-receive 脚本十分类似,不同之处在于它会为每一个准备更新的分支各运行一次。 假如推送者同时向多个分支推送内容,pre-receive 只运行一次,相比之下 update 则会为每一个被推送的分支各运行一次。 它不会从标准输入读取内容,而是接受三个参数:引用的名字(分支),推送前的引用指向的内容的 SHA-1 值,以及用户准备推送的内容的 SHA-1 值。 如果 update 脚本以非零值退出,只有相应的那一个引用会被拒绝;其余的依然会被更新。

post-receive

post-receive 挂钩在整个过程完结以后运行,可以用来更新其他系统服务或者通知用户。 它接受与 pre-receive 相同的标准输入数据。 它的用途包括给某个邮件列表发信,通知持续集成(continous integration)的服务器, 或者更新问题追踪系统(ticket-tracking system) —— 甚至可以通过分析提交信息来决定某个问题(ticket)是否应该被开启,修改或者关闭。 该脚本无法终止推送进程,不过客户端在它结束运行之前将保持连接状态, 所以如果你想做其他操作需谨慎使用它,因为它将耗费你很长的一段时间。

git hooks安装

当你用git init初始化一个新版本库时,Git 默认会在这个目录中放置一些示例脚本,进入.git/hooks后会看到一些hooks的官方示例,他们都是以.sample结尾的文件名。

git hooks存储位置

git hooks被存储在Git目录下的.hooks子目录中,即绝大部分项目中的.git/hooks

git hooks示例

.git/hooks目录下的示例脚本除了本身可以被调用外,它们还透露了被触发时所传入的参数。 所有的示例都是shell脚本,其中一些还混杂了Perl代码,不过,任何正确命名的可执行脚本都可以正常使用 —— 你可以用Ruby Python,或任何你熟悉的语言编写它们。

git init后生成的示例脚本,如下图 image.png

调用git hooks

注意这些以.sample结尾的示例脚本默认是不会执行的,只有把一个正确命名(不带扩展名.sample)且可执行的文件放入 .git/hooks 目录中,才会激活该钩子脚本,生效且被git调用。

本地.git/hooks的缺陷

【不能共享】由于.git文件夹是不会被git跟踪的,所以.git/hooks目录下的hooks钩子无法提交,就不能和他人共享钩子脚本。


如果我们使用了git hooks钩子,那就需要在代码库内共享钩子。针对这一问题,接下来我们看两种可方便指定git Hooks钩子的方式。

husky

介绍

Husky可以将git内置的钩子暴露出来,很方便地进行钩子命令注入,而不需要在.git/hooks目录下自己写shell脚本了。您可以使用它来lint您的提交消息、运行测试、lint代码等。当你commitpush的时候。husky触发所有git钩子脚本。

Install

自动安装 (recommended)

husky init命令将使用husky快速初始化项目。

npx husky-init && npm install

手动安装

  1. install husky
npm install husky --save-dev
  1. 启用husky
npx husky install
  1. 要在安装后自动启用Git钩子,编辑package.json
npm set-script prepare "husky install"

执行完上述安装命令后,将会发生如下几个变化:

  1. .git同级目录生成.husky文件夹,文件夹下有一个可以编辑的示例pre-commit钩子
  2. package.json中的scripts中添加了"prepare": "husky install"
  3. 更改git配置项core.hooksPath.husky

如下图: image.png

创建一个hook

要添加另一个钩子,请使用husky add

示例:

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

更新hooks脚本

修改.husky文件夹下的hooks脚本即可。

如下图: image.png

调用hooks

运行git commit时会自动调用husky添加的hook

卸载并还原husky

npm uninstall husky
// 删除.husky文件夹,并且重置core.hooksPath
rm -rf .husky && git config --unset core.hooksPath

yorkie

介绍

fork自husky,做了一些改动,如下:

  1. 优先考虑位于.git目录旁边的package.json,而不是硬编码的向上搜索。避免了在lerna 仓库中的根包和子包都依赖于husky的问题,它会混淆并用错误的路径,双重更新根git钩子。
  2. 更改在package.jsonhooks的位置 before:
{
  "scripts": {
    "precommit": "foo"
  }
}

After:

{
  "gitHooks": {
    "pre-commit": "foo"
  }
}

Install

vue脚手架vue-cli在初始化完项目后,@vue/cli-service 会自动安装 yorkie,它会让你在 package.jsongitHooks 字段中方便地指定 Git hook

{
  "gitHooks": {
    "pre-commit": "lint-staged" // 配置脚本
  },
   "lint-staged": {
    "*.{js,vue}": [
      "vue-cli-service lint",
      "git add"
    ]
  }
}

注意

yorkie fork 自 husky 并且与后者不兼容。

husky与yorkie的不同

  • husky v7版本仅支持修改.husky/xxx目录下的配置脚本,v4版本支持package.json中通过husky: {hooks: {"pre-commit": xxx} }的方式更新脚本
  • yorkie支持在package.json中通过"gitHooks": {"pre-commit": xxx}的方式更新脚本。

跳过hooks

有时候我们因为一些原因,想绕过hooks检查,可通过下方命令实现:

git commit -m 'xxx' --no-verify

接下一篇:juejin.cn/post/697689… ,介绍如何进行代码检查,生成commit message,生成changelog,使得整个项目提交流程更规范。