前端代码自动格式化之Git hooks

Posted 2021-09-13 夜月孤狼

随着前端项目工程越来越复杂，团队共同开发是无法避免的。然而每个人都有自己的编码风格和习惯，这样也往往导致提交到git上的代码风格多样化、不一致；特别是当有人和你的代码风格不一致的时候，在开发时格式化了代码，这样即使他只修改了一行代码，提交上到git上的也是整个文件几乎都改动了，对CR非长的不友好；

怎样才能保证提交到git上的代码风格保持一致呢？强制要求每个人使用同一种编码风格是不现实的；此时我们就可以借助git hook来帮助我们处理这个问题；

git hooks 是什么呢？

简单的说就是在git 做一些重要动作的时候，会触发自定义脚本；我们就可以利用它，来做一些事情，下面来看一些常用的git hooks，和它们在什么时候触发；

git hooks分为两种：客户端钩子和服务器端钩子

客户端钩子：是由诸如提交和合并这样的操作所调用；

服务器端钩子：是诸如接受被推送的提交这样的联网操作；

安装钩子

在你使用git init 初始化一个新版本库的时候，git 就会默认在项目根目录下.git/hooks目录中生成一些示例脚本，这些脚本都是shell脚本，这些脚本都以.sample结尾，如果你想启用某个脚本，就需要移除这个脚本的后缀；这些脚本还可以使用像Rbuy、Python或者任何你熟悉的语言编写它们；

将一个正确命名（不带扩展名）且可执行的文件放入到项目的根目录下的.git/hooks目录中，即可激活该钩子脚本。这样以来它就能被git调用。接下来我们记录一些常用的钩子；

客户端钩子

提交相关的钩子

pre-commit钩子是在键入提交信息前运行，它用于检查即将提交的快照；例如检查是否遗漏，确保测试运行，以及核查代码；如果该钩子以非0值退出，git将放弃此次提交；不过你可以使用--no-verify来绕过这个环节。你可以利用该钩子来检查代码风格是否一致(运行类似lint的程序)、尾随空白字符是否存在等等；

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

commit-msg钩子接收一个参数，存有当前提交信息的临时文件的路径。如果该钩子以非零值退出，git将放弃提交。因此可以用来在提交通过前验证项目状态或提交信息；例如验证提交的信息是否符合规范；

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

其他客户端钩子

pre-rebase钩子运行于变基之前，以非零值退出可以终止变基的过程。你可以使用这个钩子来禁止对已经推送的提交变基。git自带的pre-rebase钩子示例就是这么做的，不过它所做的一些假设可能与你的工作不匹配。

post-rewrite钩子被那些会替换提交记录的命令调用，比如git commit --amend 和git rebase，不包括git filter-branch。它唯一的参数是触发重写的命令名，同时从标准输入中接收一系列重写的提交记录。这个钩子的用途很大程度上根post-checkout和post-merge差不多；

post-checkout钩子会在你成功运行git checkout命令后触发。你可以根据你的项目环境用它调整你的工作目录。其中包括放入大的二进制文件、自动生成文档或进行其他类似这样的操作。

post-merge钩子会在你成功运行git merge命令后触发。你可以用它恢复git无法跟踪的工作区数据，比如权限数据。这个钩子也可以用来验证某些在git控制之外的文件是否存在，这样你就能在工作区改变时，把这些文件复制过来。

pre-push钩子会在git push运行期间，更新了远程引用但尚未传送对象时被调用。它接收远程分支的名字和位置作为参数，同时从标准输入中读取一系列待更新的引用。你可以在推送开始之前，用它验证对引用的更新操作。返回一个非零值退出码将终止推送过程。

服务器钩子

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

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

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

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

总结

以上就是一些常用的git hooks和它的简单介绍，暂时不需要太深入的了解它，只需要知道，在提交代码到仓库的时候，可以利用钩子脚本触发时机来做一些事情，比如我们一开始提到的问题，我们就可以在pre-commit钩子里来处理，不过我们还需要借助一些其他工具，例如husky、prettier、lint_staged等，我们后续会介绍；

后续

对常用的钩子深入理解，并且将每个常用的钩子进行实操，我也会将过程进行分享。

参考

Git 钩子