你可能會(huì)忽略的Git提交規(guī)范
一直是 ESLint 的忠實(shí)用戶，深知規(guī)范的重要性。然而，在新項(xiàng)目交接中，我被 Git Commit 規(guī)范逼瘋了。才意識(shí)到自己的疏忽，于是便有了一探究竟的想法。
一、為什么需要規(guī)范?
無(wú)規(guī)矩不成方圓，編程也一樣。
如果你有一個(gè)項(xiàng)目，從始至終都是自己寫，那么你想怎么寫都可以，沒(méi)有人可以干預(yù)你?？墒侨绻趫F(tuán)隊(duì)協(xié)作中，大家都張揚(yáng)個(gè)性，那么代碼將會(huì)是一團(tuán)糟，好好的項(xiàng)目就被糟踐了。不管是開(kāi)發(fā)還是日后維護(hù)，都將是災(zāi)難。
這時(shí)候，有人提出了何不統(tǒng)一標(biāo)準(zhǔn)，大家都按照這個(gè)標(biāo)準(zhǔn)來(lái)。于是 ESLint，JSHint 等代碼工具如雨后春筍般涌現(xiàn)，成為了項(xiàng)目構(gòu)建的必備良品。
Git Commit 規(guī)范可能并沒(méi)有那么夸張，但如果你在版本回退的時(shí)候看到一大段糟心的 Commit，恐怕會(huì)懊惱不已吧。所以，嚴(yán)格遵守規(guī)范，利人利己。
二、具體規(guī)則
先來(lái)看看公式：
- <type>(<scope>): <subject>
type
用于說(shuō)明 commit 的類別，只允許使用下面7個(gè)標(biāo)識(shí)。
- feat：新功能(feature)
- fix：修補(bǔ)
- bugdocs：文檔(documentation)
- style： 格式(不影響代碼運(yùn)行的變動(dòng))
- refactor：重構(gòu)(即不是新增功能，也不是修改bug的代碼變動(dòng))
- test：增加測(cè)試
- chore：構(gòu)建過(guò)程或輔助工具的變動(dòng)
scope
用于說(shuō)明 commit 影響的范圍，比如數(shù)據(jù)層、控制層、視圖層等等，視項(xiàng)目不同而不同。
subject
是 commit 目的的簡(jiǎn)短描述，不超過(guò)50個(gè)字符。
- 以動(dòng)詞開(kāi)頭，使用***人稱現(xiàn)在時(shí)，比如change，而不是changed或changes
- ***個(gè)字母小寫
- 結(jié)尾不加句號(hào)(.)
三、異常處理
我們先來(lái)看看這個(gè)異常提醒：
- INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" !
- jartto:fix bug
這里之所以報(bào)出這個(gè)警告，是因?yàn)槲业奶峤怀霈F(xiàn)了兩個(gè)問(wèn)題：
- 其一，使用了規(guī)范外的關(guān)鍵字;
- 其二，很細(xì)節(jié)的問(wèn)題，jartto：后少了空格;
這時(shí)候我才回憶起來(lái)，當(dāng)時(shí)提交一直失敗，情急之下直接強(qiáng)制提交，所以以后的提交都會(huì)抱出這個(gè)異常。大致意思就是：
- 你的之前的 Commit 不合格～你的之前的 Commit 不合格～你的之前的 Commit 不合格
這時(shí)候就很煩了，我們只能去將之前的錯(cuò)誤修正，那么如何操作呢?
四、如何修改之前的 commit 信息?
其實(shí)并不復(fù)雜，我們只需要這樣做:
1、將當(dāng)前分支無(wú)關(guān)的工作狀態(tài)進(jìn)行暫存
- git stash
2、將 HEAD 移動(dòng)到需要修改的 commit 上
- git rebase 9633cf0919^ --interactive
3、找到需要修改的 commit ,將首行的 pick 改成 edit
4、開(kāi)始著手解決你的 bug
5、 git add 將改動(dòng)文件添加到暫存
6、 git commit –amend 追加改動(dòng)到提交
7、git rebase –continue 移動(dòng) HEAD 回***的 commit
8、恢復(fù)之前的工作狀態(tài)
- git stash pop
大功告成，是不是想把整個(gè) Commit 都修改一遍，逃～
五、項(xiàng)目中使用
這時(shí)候問(wèn)題又來(lái)了，為什么我提交的時(shí)候會(huì)有警告，這個(gè)又是如何做到的呢?
這時(shí)候，我們需要一款 Node 插件 validate-commit-msg 來(lái)檢查項(xiàng)目中 Commit message 是否規(guī)范。
1.首先，安裝插件：
- npm install --save-dev validate-commit-msg
2.使用方式一，建立 .vcmrc 文件：
- {
- "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
- }
3.使用方式二：寫入 package.json
- {
- "config": {
- "validate-commit-msg": {
- /* your config here */
- }
- }
- }
4.可是我們?nèi)绻胱詣?dòng)使用 ghooks 鉤子函數(shù)呢?
- {
- …
- "config": {
- "ghooks": {
- "pre-commit": "gulp lint",
- "commit-msg": "validate-commit-msg",
- "pre-push": "make test",
- "post-merge": "npm install",
- "post-rewrite": "npm install",
- …
- }
- }
- …
- }
在 ghooks 中我們可以做很多事情，當(dāng)然不只是 validate-commit-msg 哦。
更多細(xì)節(jié)請(qǐng)參考：validate-commit-msg
六、Commit 規(guī)范的作用
- 提供更多的信息，方便排查與回退;
- 過(guò)濾關(guān)鍵字，迅速定位;
- 方便生成文檔;
七、生成 Change log
正如上文提到的生成文檔，如果我們的提交都按照規(guī)范的話，那就很簡(jiǎn)單了。生成的文檔包括以下三個(gè)部分：
- New features
- Bug fixes
- Breaking changes.
每個(gè)部分都會(huì)羅列相關(guān)的 commit ，并且有指向這些 commit 的鏈接。當(dāng)然，生成的文檔允許手動(dòng)修改，所以發(fā)布前，你還可以添加其他內(nèi)容。
這里需要使用工具 Conventional Changelog 生成 Change log ：
- npm install -g conventional-changelog
- cd jartto-domo
- conventional-changelog -p angular -i CHANGELOG.md -w
為了方便使用，可以將其寫入 package.json 的 scripts 字段。
- {
- "scripts": {
- "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
- }
- }
這樣，使用起來(lái)就很簡(jiǎn)單了：
- npm run changelog
到這里，我們所有的問(wèn)題都搞明白了，🍻Cheers～
八、總結(jié)
看完文章，你還會(huì)如此放蕩不羈嗎?你還會(huì)隨心所欲的編寫 Commit 嗎?你還會(huì)如此 git commit -m "hello jartto"提交嗎?
答案是否定的，因?yàn)槭褂昧算^子函數(shù)，你沒(méi)有機(jī)會(huì)了，否則將是無(wú)窮無(wú)盡的恢復(fù) Commit。這倒可以養(yǎng)成良好的提交習(xí)慣~~
