2020-4-23 seo達人
隨著項目體積的增加,參與到項目中的同學越來越多,每個人都有自己的打 git log 的習慣:
add: 添加...
[add]: 添加...
Add 添加...
為了形成統一的規范,達成共識,從而降低協作開發成本,需要對 git commit 記錄進行規范。
規范 git commit 記錄,需要做兩件事情:
問:既然已經交互式生成了規范記錄,為什么需要在 hooks 進行檢查?
交互式生成 commit 記錄,需要用戶調用自定義的 npm scripts,例如npm run commit
。但還是可以直接調用原生 git 命令 git commit
來提交記錄。而檢查是在正式提交前進行的,因此不符合要求的記錄不會生效,需要重新 commit。
前期調研結果,關于 commit 提示有兩種做法:
方法 1 的優缺點:
優點 1: 直接安裝對應的 adapter 即可
優點 2: 無開發成本
缺點 1: 無法定制,不一定滿足團隊需要
方法 2 的優缺點:
優點 1: 可定制,滿足開發需求
優點 2: 單獨成庫,發布 tnpm,作為技術建設
缺點 1: 需要單獨一個倉庫(但開發成本不高)
在實際工作中,發現方法 1 中的常用規范,足夠覆蓋團隊日常開發場景。所以,選擇了方法 1.
step1: 安裝 npm 包
npm i --save-dev commitizen cz-conventional-changelog @commitlint/cli @commitlint/config-conventional husky
添加 package.json 的配置:
"scripts": { "commit": "git-cz" }, "husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" }
}, "config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog" }
}
在項目根目錄下創建commitlint.config.js
:
module.exports = { extends: ["@commitlint/config-conventional"]
};
使用方法:不再使用git commit -m ...
,而是調用npm run commit
。
<img src="https://tva1.sinaimg.cn/large/006tNbRwly1gbjcfr3xb5j30cw00tjrd.jpg" style="width: 100% !important;"/>