使用Git hooks+ESLint做團隊代碼強制校驗

在多人合作的項目團隊中,根據開發規范,統一代碼風格,是打造一支規范化技術團隊必不可少的一部分。

在一個npm項目中,我們常用ESLint來做代碼檢查:

  • 項目根目錄下創建ESLint配置文件
# 項目
cd project
touch .eslintrc.js

根據ESLlint規則在.eslintrc.js文件中創建代碼校驗規則。

  • 創建npm校驗腳本
vi package.json
# 在scripts中新增一行
scripts: {
    "lint": "eslint --ext .js,.vue --ignore-path .gitignore .",
},

這樣,就可以通過npm run lint來按照配置的ESLint規則檢測代碼的規范性。

  • 利用 Git pre-commint 鉤子實現強制校驗

團隊中人員水平和意識參差不齊,某些同事在客觀和主觀上會或多或少地疏漏代碼校驗這個環節。那么,如何去強制校驗呢?

設想下,如果在代碼提交時觸發代碼校驗腳本,不通過則不能提交,不就實現了強制校驗了嗎?

Git 能在特定的重要動作發生時觸發自定義腳本,詳情見Git hooks。在這里,我們要在提交前檢查其代碼快照,所以采用pre-commit hooks

如果你是一位精通shell腳本的大神,可以直接去修改Git pre-commit hooks的源文件:

cd .git/hooks
ls
# applypatch-msg.sample post-commit.simple pre-commit.simple ...

.simple擴展名結尾的文件都是Git提供的示例。如果想讓他們生效,需要移除`.simple

# 復制 pre-commit.simple 文件并去掉擴展名
cp pre-commit.simple pre-commit
# 寫入你要執行的腳本
vi pre-commit
# xxx... 此處省略大神shell腳本,感興趣的可以去 Google

同時,為了兼容快發人員快捷提交命令git commit -am"xxx",還需要在pre-applypatch這個鉤子下去做相同的配置。

大多數碼農朋友對于shell腳本不是很精通,寫起來也費時費力。這里推薦使用 husky,通過配置npm腳本,來自動生成pre-commit文件

npm i husky -D

# 在package.json 的 scripts中繼續新增一行
scripts: {
    "lint": "eslint --ext .js,.vue --ignore-path .gitignore .",
    "precommit": "npm run lint"
},

打開.git/hooks目錄,發現生成了pre-commit文件。

自此,每次執行git commit -m 'xxx'操作,就會觸發npm run lint。若鉤子返回結果為false,則無法提交,修改代碼直至通過校驗后,方可提交通過。

相關資料:
Git hooks
husky
ESLint

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,835評論 6 534
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,676評論 3 419
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,730評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,118評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,873評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,266評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,330評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,482評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,036評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,846評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,025評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,575評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,279評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,684評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,953評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,751評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,016評論 2 375

推薦閱讀更多精彩內容