关于husky8.0 与 4.0的配置

husky的场景使用很多，一般大多场景是在配置git commit 命令拦截hook, 校验 commit-msg 格式规范。以下环境默认：git >= 2.27.0, node >=14

1、安装[email protected]

bash 复制代码

npm install --save-dev [email protected]

2、初始化配置文件

在package.json scripts 属性中添加命令并保存：

javascript 复制代码

"scripts": {
	"prepare": "npx husky install"
}

在控制台输入：npm run prepare 初始化 husky, 则在工程根目录创建.husky目录 ,如下图：

初始化commit-msg函数配置文件

bash 复制代码

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

在./husky/commit-msg文件中生成

bash 复制代码

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npx --no-install commitlint --edit $1

初始化pre-commit函数配置文件

bash 复制代码

npx husky add .husky/pre-commit "npx lint-staged"

在./husky/pre-commit文件中生成

bash 复制代码

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npx lint-staged

以上：钩子函数已经配置完毕，执行 git commit 命令之后，会被拦截开始执行./husky/下 pre-commit、commit-msg 配置文件中脚本

3、配置自定义的git commit-msg格式规范

commitlint 提交校验安装配置

bash 复制代码

npm install --save-dev @commitlint/[email protected] @commitlint/[email protected]

在工程目录创建commitlint.config.js文件

javascript 复制代码

'use strict';
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'feat', 
        'fix', 
        'docs', 
        'style', 
        'refactor', 
        'perf', 
        'test', 
        'chore', 
        'revert', 
        'build', 
        "impr", 
        "ci", 
        "jvm", 
        "pom", 
        "apm", 
        "conf", 
        "typo", 
        "wip", 
      ]
    ],
    'type-case': [0],
    'type-empty': [0],
    'scope-empty': [0],
    'scope-case': [0],
    'subject-full-stop': [0, 'never'],
    'subject-case': [0, 'never'],
    'header-max-length': [0, 'always', 72]
  }
};

以下是4.0的配置

4、安装[email protected]

bash 复制代码

npm install --save-dev [email protected]

5、初始化配置文件

在package.json scripts 属性中添加命令并保存：

javascript 复制代码

{
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
}

6、配置自定义的git commit-msg格式规范

commitlint 提交校验安装配置

bash 复制代码

npm install --save-dev @commitlint/[email protected] @commitlint/[email protected]

注意：高版本与低版本的husky有冲突

请检查根目录下.git/config 文件中是否含有高版本husky的字段配置，若有则注释掉husky的配置