本文已参与「新人创作礼」活动，一起开启掘金创作之路。

husky7.0.4——提交信息规范

1、安装

npm install -D husky

2、添加script命令

在package.json文件中添加一个命令，使之在执行npm i安装依赖后，执行husky install

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

3、运行命令

npm run prepare 执行完命令之后，项目根目录会出现一个.husky文件夹

4、添加git hook

添加commit-msg这个git hook来校验我们commit时添加的备注信息是否符合规范。因为是无法执行命令npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"' 安装，所以直接在.husky文件夹里面添加文件commit-msg, 在文件里添加:

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

npx --no-install commitlint --edit $1

5、添加规范commitlint

检测提交 commit 提交记录是否符合规范需要 commitlint 安装：npm install -D @commitlint/config-conventional @commitlint/cli 在项目根目录新建文件:commitlint.config.js 文件内容(可根据需要自己添加修改)：

module.exports = {
  // 继承的规则
  extends: ['@commitlint/config-conventional'],
  // 定义规则类型
  rules: {
    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
    'type-enum': [
      2,
      'always',
      [
        'feat', // 新功能 feature
        'fix', // 修复 bug
        'docs', // 文档注释
        'style', // 代码格式(不影响代码运行的变动)
        'refactor', // 重构(既不增加新功能，也不是修复bug)
        'perf', // 性能优化
        'test', // 增加测试
        'chore', // 构建过程或辅助工具的变动
        'revert', // 回退
        'build' // 打包
      ]
    ],
    // subject 大小写不做校验
    'subject-case': [0]
  }
}

6、测试

在这里插入图片描述

husky 7.0.4 使用记录