husky规范代码提交

• 当您提交或推送时，您可以使用它来 lint 提交消息、运行测试、lint 代码等。
• Husky 支持所有 Git 钩子。
• husky (opens new window)

v7.0.0 使用

1. 暂不讨论其它版本
2. 这个版本和v4不同的区别在于 该版本不需要在 package.json 中添加

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

安装

1. npm install husky@7.0.0 -D
2. npx husky-init，运行之后会新增一个 .husky 目录，同时在 package.json 中的 script 对象中新增一条 "prepare": "husky install"的命令
3. npm install

添加 git 钩子

pre-commit

项目要使用 git 进行代码提交时

1. npx husky add .husky/pre-commit 'npm run test'
2. 其实不推荐这种新增的写法，正确写法应该分两步进行，如下：
3. npx husky add .husky/pre-commit，.husky 目录中新增一个 pre-commit 文件
4. 修改 pre-commit 文件的内容

# pre-commit 文件

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

npm run lint:fix # 修改这里，上面的内容一般不需要动

commit-msg

验证提交信息是否符合规范

1. npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'，经测试，这样会报错；这时应该分两步来完成
2. npx husky add .husky/commit-msg，在 .husky 目录下新建一个 commit-msg 文件
3. 打开 .husky/commit-msg 文件修改其内容

# commig-msg 文件

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

npx --no-install commitlint --edit $1 # 你要修改的信息

4. 安装commitlint：npm install @commitlint/cli @commitlint/config-conventional -D
   1. commitlint官网 (opens new window)
5. 根目录新增 commitlint.config.js 文件，内容如下：

// commitlint.config.js

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

至此就配置好了