ESLint - 簡(jiǎn)介

ESLint是一個(gè)用來(lái)識(shí)別 ECMAScript 并且按照規(guī)則給出報(bào)告的代碼檢測(cè)工具揖赴,使用它可以避免低級(jí)錯(cuò)誤和統(tǒng)一代碼的風(fēng)格雪位。ESLint被設(shè)計(jì)為完全可配置的竭钝,主要有兩種方式來(lái)配置ESLint:

  • 在注釋中配置:使用JavaScript注釋直接把配置嵌入到JS文件中。
  • 配置文件:使用下面任一的文件來(lái)為全部的目錄和它的子目錄指定配置信息雹洗。
    • javascript:使用.eslintrc.js文件并導(dǎo)出一個(gè)包含配置的對(duì)象香罐。
    • YAML:.eslintrc.yaml或者.eslintrc.yml
    • JSON:.eslintrc.json,并且此文件允許使用JS形式的注釋
    • 廢棄的用法:.eslintrc时肿,此文件可以是JSON或者YAML
    • package.json:在package.json文件中創(chuàng)建eslintConfig屬性庇茫,所有的配置包含在此屬性中。

這些文件的優(yōu)先級(jí)則是按照以上出現(xiàn)的順序(.eslintrc.js > .eslintrc.yaml > .eslintrc.yml > .eslintrc.json > .eslintrc > package.json)螃成。

可以被配置的信息主要分為3類:

  • Environments:你的 javascript 腳步將要運(yùn)行在什么環(huán)境(如:nodejs旦签,browser,commonjs等)中寸宏。
  • Globals:執(zhí)行代碼時(shí)腳步需要訪問(wèn)的額外全局變量宁炫。
  • Rules:開(kāi)啟某些規(guī)則,也可以設(shè)置規(guī)則的等級(jí)氮凝。

安裝


  • 全局安裝
npm i -g eslint
  • 局部安裝(推薦)
npm i -D eslint

安裝完畢后羔巢,接下來(lái)新建一個(gè)配置文件.eslintrc.js,或者使用如下的命令行來(lái)自動(dòng)生成罩阵。

eslint --init

配置


指定執(zhí)行環(huán)境

JavaScript 代碼可以運(yùn)行在瀏覽器或 nodejs 等環(huán)境中竿秆,每個(gè)環(huán)境的全局變量都不盡相同(如 nodejs 中沒(méi)有 DOM 相關(guān)的全局變量)。在配置文件中可以自由的指定執(zhí)行環(huán)境稿壁。

// .eslintrc.js
module.exports = {
  env: {
    browser: true,
    node: true,
  },
};

所有的環(huán)境可以在官網(wǎng)上查詢幽钢。

指定全局變量

可以在配置文件或注釋中指定額外的全局變量,false表明變量只讀:

  • 使用注釋來(lái)配置:
/* global var1, var2 */
/* global var1:false, var2:false */
  • 使用配置文件來(lái)配置:
// .eslintrc.js
module.exports = {
  globals: {
    var1: true,
    var2: true,
  },
};

規(guī)則

在配置文件中可以設(shè)置一些規(guī)則傅是。

這些規(guī)則的等級(jí)有三種:

  • "off" 或者 0:關(guān)閉規(guī)則匪燕。
  • "warn" 或者 1:打開(kāi)規(guī)則,并且作為一個(gè)警告(不影響exit code)落午。
  • "error" 或者 2:打開(kāi)規(guī)則谎懦,并且作為一個(gè)錯(cuò)誤(exit code將會(huì)是1)肚豺。

例如:

  • 使用配置文件來(lái)配置
// .eslintrc.js
module.exports = {
  rules: {
    eqeqeq: 'off',
    curly: 'error',
  },
};
  • 使用注釋來(lái)配置
/* eslint eqeqeq: "off", curly: "error" */
/* eslint eqeqeq: 0, curly: 2 */

也可以在注釋中關(guān)閉所有或者某個(gè)規(guī)則:

/* eslint-disable */
/* eslint-enable */

/* eslint-disable no-alert, no-console */
/* eslint-enable no-alert, no-console */

具體的規(guī)則可以在官網(wǎng)上找到溃斋,或者使用別人寫(xiě)好的配置,例如eslint-config-airbnb吸申。

使用方法


命令行

通過(guò)命令行工具來(lái)使用 eslint 梗劫。

eslint [options] file.js [file.js] [dir]

編輯器

配合相應(yīng)的插件享甸,在vscode中直接顯示錯(cuò)誤和警告。

lint

除了上述梳侨,還可以配合gulp蛉威、webpack等工具來(lái)使用。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末走哺,一起剝皮案震驚了整個(gè)濱河市蚯嫌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌丙躏,老刑警劉巖择示,帶你破解...
    沈念sama閱讀 207,113評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異晒旅,居然都是意外死亡栅盲,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門(mén)废恋,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)谈秫,“玉大人,你說(shuō)我怎么就攤上這事鱼鼓∧馓蹋” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,340評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵迄本,是天一觀的道長(zhǎng)构灸。 經(jīng)常有香客問(wèn)我,道長(zhǎng)岸梨,這世上最難降的妖魔是什么喜颁? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,449評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮曹阔,結(jié)果婚禮上半开,老公的妹妹穿的比我還像新娘。我一直安慰自己赃份,他們只是感情好寂拆,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,445評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著抓韩,像睡著了一般纠永。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上谒拴,一...
    開(kāi)封第一講書(shū)人閱讀 49,166評(píng)論 1 284
  • 那天尝江,我揣著相機(jī)與錄音,去河邊找鬼英上。 笑死炭序,一個(gè)胖子當(dāng)著我的面吹牛啤覆,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播惭聂,決...
    沈念sama閱讀 38,442評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼窗声,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了辜纲?” 一聲冷哼從身側(cè)響起笨觅,我...
    開(kāi)封第一講書(shū)人閱讀 37,105評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎耕腾,沒(méi)想到半個(gè)月后屋摇,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,601評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡幽邓,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,066評(píng)論 2 325
  • 正文 我和宋清朗相戀三年炮温,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片牵舵。...
    茶點(diǎn)故事閱讀 38,161評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡柒啤,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出畸颅,到底是詐尸還是另有隱情担巩,我是刑警寧澤,帶...
    沈念sama閱讀 33,792評(píng)論 4 323
  • 正文 年R本政府宣布没炒,位于F島的核電站涛癌,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏送火。R本人自食惡果不足惜拳话,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,351評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望种吸。 院中可真熱鬧弃衍,春花似錦、人聲如沸坚俗。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,352評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)猖败。三九已至速缆,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間恩闻,已是汗流浹背艺糜。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,584評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人倦踢。 一個(gè)月前我還...
    沈念sama閱讀 45,618評(píng)論 2 355
  • 正文 我出身青樓送滞,卻偏偏與公主長(zhǎng)得像侠草,于是被迫代替她去往敵國(guó)和親辱挥。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,916評(píng)論 2 344

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

  • ESLint 配置 ESlint 被設(shè)計(jì)為完全可配置的边涕,這意味著你可以關(guān)閉每一個(gè)規(guī)則而只運(yùn)行基本語(yǔ)法驗(yàn)證晤碘,或混合和...
    靜默虛空閱讀 41,248評(píng)論 3 14
  • EsLint入門(mén)學(xué)習(xí)整理 這兩天因?yàn)楣疽螅蛯?duì)ESLint進(jìn)行了初步的了解功蜓,網(wǎng)上的內(nèi)容基本上都差不多园爷,但是內(nèi)容...
    點(diǎn)柈閱讀 26,009評(píng)論 3 42
  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)式撼,斷路器童社,智...
    卡卡羅2017閱讀 134,601評(píng)論 18 139
  • 兩個(gè)月之前在項(xiàng)目中就開(kāi)始使用 Eslint ,當(dāng)時(shí)直接 copy 別人的 .eslintrc.js 文件著隆,感覺(jué)好復(fù)...
    dkvirus閱讀 111,890評(píng)論 33 190
  • ESLint最初是由Nicholas C. Zakas 于2013年6月創(chuàng)建的開(kāi)源項(xiàng)目扰楼。它的目標(biāo)是提供一個(gè)插件化的...
    gavinDu閱讀 1,783評(píng)論 1 1