為代碼提交前加上代碼檢測

本文講述的是如何利用三方插件進行代碼檢測,

準備工作

  1. 了解eslint的基本用法
  2. 了解git鉤子
  3. 使用第三方husky,lint-staged
git鉤子是什么

git 鉤子是git為我們提供的事件的回調,這些文件在 文件的根目錄中的.git/hooks中大多是.sample后綴的文件夾,這些都是shell命令,通過出去這個后綴即可觸發
.git這個文件需要通過文件夾設置查看隱藏文件即可看到
git官網鉤子介紹

我們的目的是想在提交前使用eslint來驗證是否正確,正確才是其提交這樣的話就需要用到pre-commit這個鉤子

husky與lint-staged是什么如何用

husky 是檢測鉤子函數的一個工具目前最新的是@1.0.1, lint-staged則是檢測git暫存區的工具
兩者的使用也非常簡單:
npm i husky lint-staged eslint -D
注意一點,husky在安裝的時候會通過你的命令來初始化.git/hooks中的鉤子,所以一定要先讓自己的文件受git的控制,如果沒被控制只需要git init即可,如果因為某些原因需要重新初始化,則可以node ./node_modules/husky/lib/installer/bin.js install或者重新安裝husky這樣就能初始化了

配置husky與lint-staged

// package.json
// linters中的"src/**/*.js"這個是檢測的文件夾可以修改這個的意思是檢測src下所有層級的js
// 需要注意的lint-staged這個如果報錯則創建一個.lintstagedrc把 { "linters" : {...} }放進去即可
"scripts": {
    "precommit": "lint-staged"
  },
  "lint-staged": {
    "linters": {
      "src/**/*.js": [
        "./node_modules/.bin/eslint --fix",
        "git add"
      ]
    }
  }
內網中搭建

本次是在內網中搭建的著實麻煩,首先要吧對應的npm包按照層級保存在內網的包中,如果大家公司條件好點可以開代理或者白名單,如果和筆主一樣苦逼只能通過壓縮好了放入這種方式稱之為離線安裝,由于husky在首次安裝的時候會初始化.git/hooks中的文件,所以一定要注意存在.git否則會不成功,如果通過cnpm 會有下劃線開頭,也會多一個重復的包,./node_modules/.bin中的對應的名稱與.cmd的文件也就是下劃線的可以通過其內容來恢復

當然每個項目手動去初始化肯定是不好的,可以通過在script start 中去初始化與氣動項目使用node ./node_modules/lib/installer/bin.js && 啟動你的項目來操作,這個的意思是先啟動前者之后在啟動項目,如果是webpack 啟動的就要注意不要把初始化放在后面,這樣它可能誤識別成參數了 。

在啟動bin.js 同層級的index.js中可以通過修改源碼(不建議,不得已為之)通過使用fs.existsSync(path)來判斷pre-commit是否存在如果不存在就初始化,如果存在了就不做處理這樣就完成了一次內網搭建與排除各種小問題

demo非內網

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

推薦閱讀更多精彩內容