安装依赖

1
2
3
4
5
6
7
8
9
10
11
12
{
    "devDependencies": {
        "@commitlint/cli": "^13.1.0",
        "@commitlint/config-conventional": "^13.1.0",
        "husky": "^4.3.8"
    },
    "husky": {
        "hooks": {
            "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"
        }
    },
}

创建 commitlint.config.js文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['update', 'feat', 'fix', 'refactor','pref', 'docs', 'chore', 'style', 'revert'],
    ],
    '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],
  },
}

使用方法

提交commit的时候，我们可以使用 以下关键字 ‘update’, ‘feat’, ‘fix’, ‘refactor’,’pref’, ‘docs’, ‘chore’, ‘style’, ‘revert’

由于commit信息会严格按照规则校验，格式不正确无法提交，注意冒号后面是有空格的

egg：我本次提交新功能开发的需求 ：git commit -m “feat： 新功能提交”

eg：修复缺陷本次提交：git commit -m “fix： 修复GB201，点击按钮时候无反应”