为你的项目添加 commitlint

为了使项目提交message更加规范和便于维护。可以给项目添加 commitlint 规范。

添加校验

1、安装依赖

yarn add @commitlint/cli @commitlint/config-conventional --dev

2、在根目录创建 commitlint.config.js 文件，并添加配置

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

3、配置钩子

vue-cli3 项目：

修改 package.json 配置：

"gitHooks": {
    "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"
},

非 vue-cli3 项目：

• 安装 husky 依赖

yarn add husky --dev

• 修改 package.json 配置：

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

工具使用

添加了 commitlint 后每次提交信息时，都会对提交信息进行格式校验。手敲这些格式，很容易失误。

所以这里有个工具可以让我们按步骤选择提交信息，并能通过格式校验。这就是 commitizen。

1、全局安装

yarn  global add commitizen git-cz

2、在命令行执行 git cz 或者 git-cz 来代替 git commit。

也可以本地安装，请参考： https://github.com/commitizen/cz-cli