头图

为什么 husky 放弃了传统的 JS 配置

前端森林
English

前言

husky想必大家都不陌生。作为前端工程化中一个不可或缺的的工具,它可以向我们的项目中添加git hooks。同时配合lint-staged可以方便的在代码提交前进行lint

最近要对一个老项目添加commit-msg校验,同时要在commit前进行eslint校验。之前我也写过一篇类似的文章你可能已经忽略的 git commit 规范,就直接上手了。

大致流程就是先安装依赖:

npm i husky -D

然后在package.json配置:

{
  "husky": {
    "hooks": {
      "pre-commit": "npm run test", // 在commit之前先执行npm run test命令
      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS" // 校验commit时添加的备注信息是否符合我们要求的规范
    }
  }
}

然后测试了一下commit操作,好家伙,直接commit成功了。根本没有对commit-msg做校验。

我就纳闷了,之前不都是这样搞的吗 🤔

没办法,去查一下文档吧。

然后就看到了这个:

原来在 husky(6.0.0)版本做了Breaking change。再看下项目中安装的版本号:"husky": "^7.0.1"。难怪不生效了,,

之前写你可能已经忽略的 git commit 规范文章时,用的还是1.0.1的版本。😏

既然这样,我们先来看下作者为什么要做这样的改动吧:

这是作者写的一篇Why husky has dropped conventional JS config,也就是为什么 husky 放弃了传统的 JS 配置。下面简单概括一下。

为什么 husky 放弃了传统的 JS 配置

v4 版本之前 husky的工作方式是这样的:为了能够让用户设置任何类型的git hookshusky不得不创建所有类型的git hooks

这样做的好处就是无论用户设置什么类型的git hookhusky都能确保其正常运行。但是缺点也是显而易见的,即使用户没有设置任何git hookhusky也向git中添加了所有类型的git hook

在当时 husky 有过这样的设想:有没有可能让husky只添加我们需要的git hook呢?作者尝试过解决这个问题,但是失败了。

因为husky需要在两个地方进行配置才能完成一个完整的git hook功能。一个是在package.json中配置git hook所要执行的真正命令,一个是在.git/hooks/中配置相对应的git hook。也就是说无论是添加还是删除git hook就要保证在这两个地方同步执行对应的操作。作者无法找到一个可靠的方法来同步这两个地方的配置,因此失败了。

新版 husky 的工作原理又是什么呢?

直到 2016 年,Git 2.9引进了core.hooksPath,可以设置Git hooks脚本的目录,这个引进也就是新版husky改进的基础:

  • 可以使用husky installgit hooks的目录指定为.husky/
  • 使用husky add命令向.husky/中添加hook

通过这种方式我们就可以只添加我们需要的git hook,而且所有的脚本都保存在了一个地方(.husky/目录下)因此也就不存在同步文件的问题了。

ok,了解了这么多,我想你也大概理解作者为什么要做这种破坏性更新的原因了吧。那么我们接着上面的按照新版husky的配置规则对我们的项目进行配置。

新版 husky 实践

我们可以直接按照官方文档的指引来进行。

安装

Install husky

npm install husky --save-dev

Enable Git hooks

npx husky install

如果想安装后自动启用hooks,可以执行:

npm set-script prepare "husky install"

这样就会在package.json里面添加一条脚本:

// package.json
{
  "scripts": {
    "prepare": "husky install"
  }
}
prepareNPM 操作生命周期中的一环,在执行 install 的时候会按生命周期顺序执行相应钩子:
NPM7: preinstall -> install -> postinstall -> prepublish -> preprepare -> prepare -> postprepare

这样就会在代码根目录生成如下所示的结构:

添加 hook

我们可以使用husky add <file> [cmd]指令来添加一条hook

commit-msg

在项目中我们会使用commit-msg这个git hook来校验我们commit时添加的备注信息是否符合规范。在以前我们通常是这样配置的:

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS" // 校验commit时添加的备注信息是否符合我们要求的规范
    }
  }
}

在新版husky$HUSKY_GIT_PARAMS这个变量不再使用了,取而代之的是$1。所以我们要做如下操作:

执行npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'会在.husky下生成一个commit-msgshell文件:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
echo "========= 执行commit-msg校验 ======="
npx --no-install commitlint --edit $1

此时如果执行git commit操作,会有如下报错:

提示我们缺少commitlint.config.js文件,这里先安装依赖:

npm install --save-dev @commitlint/cli @commitlint/config-conventional

然后在根目录新建一个commitlint.config.js文件并加入如下内容:

module.exports = {
  extends: ["@commitlint/config-conventional"]
};

这时再执行commit就会发现已经生效了:

pre-commit

commit前,我们可以执行测试用例、eslint 校验等,只有这些通过了,才允许提交。这也就是在pre-commit这个钩子里需要做的事情。

执行npx husky add .husky/pre-commit "npm run test:unit"就会在.husky下生成一个pre-commit的 shell 文件:

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

echo "========= 执行pre-commit操作(如执行测试用例、eslint校验等,可自行添加) ======="
npm run test:unit

让我们再做一次commit操作:

至此,我们就基于新版husky,完成了项目中commit-msgpre-commit两个钩子的添加。

阅读 919

前端森林公众号
一个有温度的前端号,关注行业前沿。从基础到架构,携手你我共同成长。
2.2k 声望
11.8k 粉丝
0 条评论
2.2k 声望
11.8k 粉丝
文章目录
宣传栏