preitter +eslint+vscode插件+git hooks的配置方法

preittier和eslint有npm包也有vscode插件懒豹,平時應該怎么搭配使用这溅,還有prettier格式化代碼和eslint會產(chǎn)生規(guī)則沖突的問題。比如你在prettier中設置了semi:false,而eslint的推薦規(guī)則是強調(diào)你必須在行尾加分號的。就會產(chǎn)生沖突踢涌。

解決eslint和prettier的沖突問題

有兩種方法兼蜈,一個是直接放棄使用prettier攘残,反正eslint也能格式化代碼,把js加入prettier忽略的文件里面

另一個是使用prettier官方的解決方案eslint-config-prettier,他的原理是將eslint里面和prettier重疊的配置都關掉为狸。

npm install --save-dev eslint-config-prettier

在eslint的配置文件r.eslintrc.* 里面歼郭,進行配置,只需在extends里面放在最后一行辐棒,因為要保證覆蓋前面的配置病曾。

{
  "extends": [
    "some-other-config-you-use",
    "prettier"
  ]
}

單獨使用vscode插件的不安裝npm包的方法

不想安裝npm包的理由很簡單,因為你每個項目都要npm install這么一下漾根,多了一大堆文件泰涂,你搭腳手架的等待時間變長。你刪除文件花的時間也變長辐怕,要是能在vscode插件上直接配好不是很方便嗎逼蒙。

prettier的vscode插件 esbenp.prettier-vscode

prettier的vscode的插件是集成了功能的,可以獨立使用寄疏。并且可以讀取當前項目目錄的配置文件其做,優(yōu)先級高于你在編輯器的配置。并且你在項目安裝了prettier赁还,他會優(yōu)先讀取妖泄,并且有個配置項配置了 prettier.resolveGlobalModules為true,他也會從全局下載的npm包中找prettier艘策,都找不到了才會用編輯器綁定的prettier蹈胡。

而官方推薦的方式是在項目目錄中安裝本地開發(fā)依賴

關于配置文件讀取的優(yōu)先級如下:

  1. Prettier configuration file
  2. .editorconfig
  3. Visual Studio Code Settings (Ignored if any other configuration is present)

所以,prettier 可以單獨使用,但是還是建議安裝本地開發(fā)依賴

eslint的vscode插件dbaeumer.vscode-eslint

eslint的vscode插件并不能單獨使用罚渐,你只能全局安裝一個或者項目文件夾里面安裝一個却汉。

全局安裝一個就能正常使用了npm install -g eslint

綜上,如果要講prettier+eslint一起使用荷并,你至少要在項目文件夾中安裝個eslint-config-prettier配置好合砂,并且全局安裝eslint

然后最推薦的方式還是在項目文件夾安裝,因為作為開發(fā)依賴,你需要把它記錄到package.json中保持一致性腊嗡。比如說你把這個項目傳到git侨舆,然后過一陣子有人下載下來,要用eslint缘屹,版本跟你用的不一樣,可能就會因為配置變化多一堆報錯侠仇。轻姿。。

另外開發(fā)依賴里面你還需要一個git hook逻炊,這些都是在本地配置比較方便互亮。

作為開發(fā)依賴安裝eslint+prettier的流程

01.安裝prettier相關

npm install prettier --save-dev
npm install eslint-config-prettier --save-dev

然后把你寫的prettier文件復制過來,我對默認配置只改了兩項余素。

//.prettierrc.js
module.exports = {
  semi: false,
  singleQuote: true,
}

02.安裝eslint相關

npm install eslint --save-dev

然后安裝你想用的js代碼風格之類的胳挎,可以用npx eslint --init,他預設了一些配置的選項給你選,包括typescript也可以支持溺森。

配置完eslint慕爬,你就可以配置和prettier的兼容了。

.eslintrc.js里extends里面最后加上prettier

{
  "extends": [
    "some-other-config-you-use",
    "prettier"
  ]
}

03.配置git hooks

這里介紹一種用lint-stage進行配置的方法,

直接安裝npm install --save-dev lint-staged husky

husky現(xiàn)在的版本號是6.0屏积,配置方式已經(jīng)發(fā)生了變化医窿,網(wǎng)上很多教程是4的版本號已經(jīng)不適用了。

# 執(zhí)行完這樣代碼會多出一個.husky目錄
npx husky install
# 后面字符串參數(shù)就是pre-commit階段里面會執(zhí)行的命令炊林,你也可以直接編輯pre-commit文件添加命令
npx husky add .husky/pre-commit "npx lint-staged"

然后在package.json文件里添加lint-staged的配置姥卢,注意prettier要放在最后執(zhí)行

"lint-staged": {
    "**/*.js": [
      "eslint ",
      "prettier  --write"
    ]
  },
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市渣聚,隨后出現(xiàn)的幾起案子独榴,更是在濱河造成了極大的恐慌,老刑警劉巖奕枝,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件棺榔,死亡現(xiàn)場離奇詭異,居然都是意外死亡隘道,警方通過查閱死者的電腦和手機症歇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進店門郎笆,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人忘晤,你說我怎么就攤上這事宛蚓。” “怎么了设塔?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵凄吏,是天一觀的道長。 經(jīng)常有香客問我闰蛔,道長痕钢,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任钞护,我火速辦了婚禮盖喷,結果婚禮上爆办,老公的妹妹穿的比我還像新娘难咕。我一直安慰自己,他們只是感情好距辆,可當我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布余佃。 她就那樣靜靜地躺著,像睡著了一般跨算。 火紅的嫁衣襯著肌膚如雪爆土。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天诸蚕,我揣著相機與錄音步势,去河邊找鬼。 笑死背犯,一個胖子當著我的面吹牛坏瘩,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播漠魏,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼倔矾,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了柱锹?” 一聲冷哼從身側響起哪自,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎禁熏,沒想到半個月后壤巷,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡瞧毙,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年隙笆,在試婚紗的時候發(fā)現(xiàn)自己被綠了锌蓄。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡撑柔,死狀恐怖瘸爽,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情铅忿,我是刑警寧澤剪决,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站檀训,受9級特大地震影響柑潦,放射性物質發(fā)生泄漏。R本人自食惡果不足惜峻凫,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一渗鬼、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧荧琼,春花似錦譬胎、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至脐恩,卻和暖如春镐侯,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背驶冒。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工苟翻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人骗污。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓崇猫,卻偏偏與公主長得像,于是被迫代替她去往敵國和親身堡。 傳聞我的和親對象是個殘疾皇子邓尤,可洞房花燭夜當晚...
    茶點故事閱讀 45,691評論 2 361

推薦閱讀更多精彩內(nèi)容