无星的前端之旅（二十三）—— 手把手教你配置git hook

背景

要求对git的message作限制，要求要以

['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'revert', 'types']:

作开头标记

思路

git存在hook，在每一个步骤后面都会执行对应的🪝

所以咱们能够考虑经过git hook去完成这项校验

实际上，在平时的开发过程当中，就已经有于此相关的内容了，就是不知道同窗们留意到没有

举个🌰

好比在Vue项目中，若是在建立项目中，选择了eslint，并选择了保存并格式化

在进行git commit时，代码会自动作一次格式化。

究其缘由，其实是来自Vue的默认配置

那么Vue是怎么作的，实际上，翻开文档，咱们可以找到相关内容

git-hook

其实是尤🌧️溪 fork 了 husky，稍作改造造成了yorkie

可是咱们能够看到，yorkie已经好久没有更新了，而且没有文档，想要直接使用yorkie是比较困难的

所以咱们回到最初的库，husky

husky

husky自己也是一个久负盛名的库，专一于git hook

那么就让咱们来集成它，完成咱们的需求

集成

npx husky-init && npm install       # npm
npx husky-init && yarn              # Yarn 1
yarn dlx husky-init --yarn2 && yarn # Yarn 2
复制代码

集成之后，项目依赖会添加husky，且项目根目录下会添加.husky文件夹

编写hook

.husky文件夹下，默认添加了一个pre-commit的hook文件

pre-commit

咱们能够先将Vue的默认配置转移进去

pre-commit

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

npm run lint
git add .
复制代码

而后移除package.json中的gitHooks属性

新增其余hook

npx husky add [fileName]
# 若是没有其余config上的变更，能够理解为照着以下写法写
# npx husky add .husky/hooks名称
复制代码

举个🌰

npx husky add .husky/commit-msg
复制代码

git hooks名称和做用

可能有些旁友不知道有哪些hook能够添加，我这里教你们怎么看

• git 文档

• 直接查看.git文件夹中hooks内容

完成需求

1.添加commit-msg

npx husky add .husky/commit-msg
复制代码

2.正则编写

commit-msg内容：

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

MSG=`awk '{printf("%s",$0)}' $1`
echo $MSG
if [[ $MSG =~ ^(feat|fix|docs|style|refactor|perf|test|build|ci|revert|types):.*$ ]]
then
    echo '成功'
else
    echo '失败'
fi
复制代码

额外内容

不够保险

由于上述行为的hook是在项目中作的

换句话说是在开发成员的本地电脑上作的

一旦开发人员不爽，把hook删了，那就无从约束

因此更保险的方式，应该是由git平台上去作检测

仅测试hook

能够在hook文件的最后添加

exit 1
复制代码

会停止本次git行为

test-hooks

commitlint

commitlint，见名知意，commit内容的lint

咱们能够使用其中的风格和工具作拓展

好比咱们这里选择集成以下工具和风格

@commitlint/cli
@commitlint/config-conventional
复制代码

若是须要达成上述需求，咱们能够这么作

• 根目录下新建commitlint.config.js文件

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'revert', 'types'],
    ],
  },
}

复制代码

• commit-msg内容

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

npx commitlint --edit $1

复制代码

Done