爲你的項目添加 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