用commitlint規(guī)范團(tuán)隊(duì)的git提交信息

閱讀完本文預(yù)計(jì)需要5分鐘附鸽,讀完一定要記得實(shí)踐哦。

在一個(gè)團(tuán)隊(duì)中文虏,每個(gè)人的git的commit信息都不一樣侣诺,五花八門,沒有一個(gè)機(jī)制很難保證規(guī)范化氧秘,如何才能規(guī)范化呢年鸳?可能你想到的是git的hook機(jī)制,去寫shell腳本去實(shí)現(xiàn)丸相。這當(dāng)然可以搔确,其實(shí)JavaScript有一個(gè)很好的工具可以實(shí)現(xiàn)這個(gè)模板,它就是commitlint灭忠。

接下來將會講解如何一步步的使用commitlint膳算。

一般情況下,commitlint會用在git的hook回調(diào)中弛作,最簡單的就是和 husky一起使用涕蜂。

前提條件是工程是通過git管理的,如果沒有先自己創(chuàng)建一個(gè)demo工程映琳,用git初始化一下机隙。

比如創(chuàng)建一個(gè)commitlint-test工程:

mkdir commitlint-test
cd commitlint-test
git init

npm 工程初始化

npm init

安裝commitlint

安裝依賴

npm install --save-dev @commitlint/{cli,config-conventional}

在工程更目錄添加配置文件commitlint.config.js

echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

commitlint.config.js文件內(nèi)容如下:

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

extends字段表示擴(kuò)展子@commitlint/config-conventional的配置蜘拉。一般擴(kuò)展這個(gè)就足夠了,這是利用的commitlint的配置擴(kuò)展機(jī)制有鹿,可以繼承其他人的配置旭旭。

安裝husky

husky是一個(gè)git hook的管理工具,實(shí)現(xiàn)了大部分的git hook葱跋,有興趣的可以自行g(shù)oogle持寄。

npm install --save-dev husky

在package.json中配置husky. hooks

// package.json
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }  
  }
}

通過HUSKY_GIT_PARAMS傳遞參數(shù),-E|--env用于指向相關(guān)的編輯文件娱俺。

測試

如果不符合規(guī)則际看,將無法使用git進(jìn)行commit,比如下面的矢否,如果想知道有什么規(guī)則仲闽,可以繼續(xù)往下看。

git commit -m "foo: this will fail"
husky > npm run -s commitmsg
?   input: foo: this will fail
?   type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]
?   found 1 problems, 0 warnings
husky > commit-msg hook failed (add --no-verify to bypass)
git commit -m "chore: lint on commitmsg"
husky > npm run -s commitmsg
?   input: chore: lint on commitmsg
?   found 0 problems, 0 warnings

規(guī)則

git commit的消息這樣組成:
其中header是必須有的僵朗,body赖欣,footer可選。

header 
--空一行
body
--空一行
footer

header的規(guī)則

Commit message格式验庙,注意冒號后面有空格

<type>: <subject>

type
用于說明 commit 的類別顶吮,只允許使用下面7個(gè)標(biāo)識,也可以自己在配置文件中更改或者擴(kuò)展粪薛。
標(biāo)準(zhǔn)類型如下:
feat:新功能(feature)
fix:修補(bǔ)bug
docs:文檔(documentation)
style: 格式方面的優(yōu)化
refactor:重構(gòu)
test:測試
chore:構(gòu)建過程或輔助工具的變動(dòng)

subject
subject是 commit 的簡短描述悴了,不能超過50個(gè)字符,且結(jié)尾不加英文句號违寿。

如果type為feat和fix湃交,則該 commit 將肯定出現(xiàn)在 Change log 之中。

參考:
https://conventional-changelog.github.io/commitlint/#/
https://conventional-changelog.github.io/commitlint/#/reference-rules

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末藤巢,一起剝皮案震驚了整個(gè)濱河市搞莺,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌掂咒,老刑警劉巖才沧,帶你破解...
    沈念sama閱讀 219,188評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異绍刮,居然都是意外死亡温圆,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評論 3 395
  • 文/潘曉璐 我一進(jìn)店門孩革,熙熙樓的掌柜王于貴愁眉苦臉地迎上來岁歉,“玉大人,你說我怎么就攤上這事嫉戚∨亳桑” “怎么了澈圈?”我有些...
    開封第一講書人閱讀 165,562評論 0 356
  • 文/不壞的土叔 我叫張陵彬檀,是天一觀的道長帆啃。 經(jīng)常有香客問我,道長窍帝,這世上最難降的妖魔是什么努潘? 我笑而不...
    開封第一講書人閱讀 58,893評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮坤学,結(jié)果婚禮上疯坤,老公的妹妹穿的比我還像新娘。我一直安慰自己深浮,他們只是感情好压怠,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著飞苇,像睡著了一般菌瘫。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上布卡,一...
    開封第一講書人閱讀 51,708評論 1 305
  • 那天雨让,我揣著相機(jī)與錄音,去河邊找鬼忿等。 笑死栖忠,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的贸街。 我是一名探鬼主播庵寞,決...
    沈念sama閱讀 40,430評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼薛匪!你這毒婦竟也來了皇帮?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,342評論 0 276
  • 序言:老撾萬榮一對情侶失蹤蛋辈,失蹤者是張志新(化名)和其女友劉穎属拾,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體冷溶,經(jīng)...
    沈念sama閱讀 45,801評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡渐白,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了逞频。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片纯衍。...
    茶點(diǎn)故事閱讀 40,115評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖苗胀,靈堂內(nèi)的尸體忽然破棺而出襟诸,到底是詐尸還是另有隱情瓦堵,我是刑警寧澤,帶...
    沈念sama閱讀 35,804評論 5 346
  • 正文 年R本政府宣布歌亲,位于F島的核電站菇用,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏陷揪。R本人自食惡果不足惜惋鸥,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望悍缠。 院中可真熱鬧卦绣,春花似錦、人聲如沸飞蚓。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,008評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽趴拧。三九已至溅漾,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間八堡,已是汗流浹背樟凄。 一陣腳步聲響...
    開封第一講書人閱讀 33,135評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留兄渺,地道東北人缝龄。 一個(gè)月前我還...
    沈念sama閱讀 48,365評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像挂谍,于是被迫代替她去往敵國和親叔壤。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評論 2 355