Commitizen —— git commit 規範工具
阿新 • • 發佈:2018-12-16
1.commitizen
拉取線上程式碼庫,執行
sudo cnpm install -g commitizen
生成 package.json 檔案
npm init --yes
然後,執行下面命令,使其支援Angular的Commit message格式。
commitizen init cz-conventional-changelog --save --save-exact
執行 git 操作
git add .
棄用 git commit -m 改為 git cz
出現以下選項供選擇:
之後還會詢問其它選項,填寫資訊。。
git push origin master
到此,提交工具配置完成。如果想加入 commit 校驗功能,繼續 - ->
2.validate-commit-msg
校驗 commit 是否符合規範
安裝 validate-commit-msg
npm install --save-dev validate-commit-msg
安裝 ghooks
cnpm install ghooks --save-dev
在 package.json 配置 ghooks
"config": { "ghooks": { "commit-msg": "validate-commit-msg" }, "validate-commit-msg": { "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"], "scope": { "required": false, "allowed": ["*"], "validate": false, "multiple": false }, "warnOnFail": false, "maxSubjectLength": 100, "subjectPattern": ".+", "subjectPatternErrorMsg": "subject does not match subject pattern!", "helpMessage": "", "autoFix": false } }
配置如下圖:
此時,如果修改檔案 再次寫 git commit -m “***”,會報錯
此時,我們的校驗功能就實現了!!!如果想看更改日誌 (change log),請繼續 - ->
3.change log
安裝 changelog
sudo cnpm install -g conventional-changelog
在 package.json
的 scripts
欄位寫入:
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
如圖:
執行 npm run changelog 檢視更改日誌。