使用ESLint構(gòu)建團(tuán)隊(duì)代碼規(guī)則

前言

js是一門動(dòng)態(tài)弱類型語(yǔ)言被饿,程序中的錯(cuò)誤要在代碼運(yùn)行時(shí)才能發(fā)現(xiàn)当宴。而ESLint就是能在編譯中發(fā)現(xiàn)代碼錯(cuò)誤的工具,在團(tuán)隊(duì)協(xié)作中辆它,避免低級(jí) Bug瘪撇,產(chǎn)出風(fēng)格統(tǒng)一的代碼获茬。

工具需要的是合適

ESLint是最新的工具,支持配置倔既,自定義規(guī)則恕曲,報(bào)告錯(cuò)誤,文檔詳盡渤涌,支持ES6語(yǔ)法最廣佩谣,支持JSX語(yǔ)法。那Airbnb ESLint又是什么呢歼捏,為什么這么多人推薦?這是我一開(kāi)始的疑惑笨篷,其實(shí)這是Airbnb公司自身定制的標(biāo)準(zhǔn)瞳秽。ESLint默認(rèn)有一套規(guī)則eslint:recommended,每個(gè)團(tuán)隊(duì)可以根據(jù)自身需求率翅,進(jìn)行部分配置修改练俐。如果你很喜歡大廠那一套,可以自己安裝配置進(jìn)ESLint工具中使用冕臭,但這里建議不要迷信權(quán)威腺晾,Airbnb的標(biāo)準(zhǔn)是高度定制的,不一定適合你的項(xiàng)目辜贵,所以學(xué)好怎么配置自己的標(biāo)準(zhǔn)才是重要的悯蝉。

安裝

ESLint是一個(gè)運(yùn)行在node環(huán)境的工具,使用npm進(jìn)行安裝

  1. 全局安裝
npm install -g eslint
  1. 本地安裝
npm install eslint --save-dev

我喜歡都安裝托慨,因?yàn)槿职惭b能多個(gè)工程直接使用命令鼻由,本地安裝能為后續(xù)提供靈活配置。

生成配置文件

工具基本都有配置文件厚棵,告訴工具該做什么蕉世,怎么做。如npm的就是package.json文件婆硬,而ESLint的配置文件就是.eslintrc狠轻。

進(jìn)入項(xiàng)目根目錄,終端執(zhí)行

eslint --init

之后程序會(huì)詢問(wèn)你一些問(wèn)題彬犯,以創(chuàng)建符合你風(fēng)格的配置文件向楼,最終生成配置文件查吊,其格式會(huì)有JavaScript、YAML蜜自、JSON菩貌、package.json等等。這里我們把生成的文件重命名一下為.eslintrc重荠,為后續(xù)在IDE中進(jìn)行配置箭阶。

配置文件

打開(kāi)配置文件,可以看到以下內(nèi)容戈鲁,我使用的是JSON格式

{
    "env": {
        "browser": true
    },
    "extends": "eslint:recommended",
    "rules": {
        "indent": [
            "error",
            "tab"
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "double"
        ],
        "semi": [
            "error",
            "always"
        ]
    },
    Globals: {
    }
}

解析以下參數(shù)的意思

  1. env:指定你的js代碼在哪個(gè)運(yùn)行環(huán)境中檢測(cè)(每個(gè)運(yùn)行環(huán)境都有一組預(yù)定義的全局變量)仇参;
  2. extends:擴(kuò)展配置規(guī)則,我這里擴(kuò)展的是eslint的推薦規(guī)則婆殿,可以使用Airbnb的規(guī)則诈乒;
  3. rules:指定檢測(cè)規(guī)則。這是最重要的部分婆芦,也是你的自定義js代碼監(jiān)測(cè)規(guī)則的地方怕磨,格式為:規(guī)則名: 規(guī)則。比如:
"indent": ["error","tab"]

這里indent就是規(guī)則名消约,它定義了縮進(jìn)應(yīng)該使用tab肠鲫,規(guī)則內(nèi)的第一個(gè)值error指的是錯(cuò)誤等級(jí),它有三個(gè)等級(jí)或粮,分別是

error level 對(duì)應(yīng)數(shù)值 含義
error 2 錯(cuò)誤
warn 1 提醒
off 0 關(guān)閉該規(guī)則

具體請(qǐng)參考eslint官網(wǎng)导饲。

  1. Globals:指定腳本執(zhí)行過(guò)程中訪問(wèn)的附加全局變量(比如jquery)

運(yùn)行工具

到上面為止,已經(jīng)完成基本配置了氯材,在終端運(yùn)行

eslint yourfile.js

便可以對(duì)該文件進(jìn)行檢測(cè)渣锦,如果有問(wèn)題,終端會(huì)提示相關(guān)錯(cuò)誤的代碼和錯(cuò)誤類型氢哮,可以運(yùn)行

eslint yourfile.js --fix

進(jìn)行自動(dòng)修復(fù)袋毙,但這只是局限于部分規(guī)則。

更多項(xiàng)目中的應(yīng)用請(qǐng)查看《如何在WebStorm中配置ESLint》《利用 git 鉤子做代碼提交前的檢查》冗尤,謝謝支持娄猫!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市生闲,隨后出現(xiàn)的幾起案子媳溺,更是在濱河造成了極大的恐慌,老刑警劉巖碍讯,帶你破解...
    沈念sama閱讀 218,755評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件悬蔽,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡捉兴,警方通過(guò)查閱死者的電腦和手機(jī)蝎困,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門录语,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人禾乘,你說(shuō)我怎么就攤上這事澎埠。” “怎么了始藕?”我有些...
    開(kāi)封第一講書人閱讀 165,138評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵蒲稳,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我伍派,道長(zhǎng)江耀,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 58,791評(píng)論 1 295
  • 正文 為了忘掉前任诉植,我火速辦了婚禮祥国,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘晾腔。我一直安慰自己舌稀,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布灼擂。 她就那樣靜靜地躺著壁查,像睡著了一般。 火紅的嫁衣襯著肌膚如雪缤至。 梳的紋絲不亂的頭發(fā)上潮罪,一...
    開(kāi)封第一講書人閱讀 51,631評(píng)論 1 305
  • 那天康谆,我揣著相機(jī)與錄音领斥,去河邊找鬼。 笑死沃暗,一個(gè)胖子當(dāng)著我的面吹牛月洛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播孽锥,決...
    沈念sama閱讀 40,362評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼嚼黔,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了惜辑?” 一聲冷哼從身側(cè)響起唬涧,我...
    開(kāi)封第一講書人閱讀 39,264評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎盛撑,沒(méi)想到半個(gè)月后碎节,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡抵卫,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年狮荔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了胎撇。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,040評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡殖氏,死狀恐怖晚树,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情雅采,我是刑警寧澤爵憎,帶...
    沈念sama閱讀 35,742評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站总滩,受9級(jí)特大地震影響纲堵,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜闰渔,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評(píng)論 3 330
  • 文/蒙蒙 一席函、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧冈涧,春花似錦茂附、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,944評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至愚隧,卻和暖如春蒂阱,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背狂塘。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,060評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工录煤, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人荞胡。 一個(gè)月前我還...
    沈念sama閱讀 48,247評(píng)論 3 371
  • 正文 我出身青樓妈踊,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親泪漂。 傳聞我的和親對(duì)象是個(gè)殘疾皇子廊营,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評(píng)論 2 355

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