使用Eslint來規(guī)范你的代碼

作為一個(gè)前端開發(fā)er闸衫,寫的代碼最多的估計(jì)是javascript了献丑,由于javascript語言本身的特性末捣,寫代碼時(shí)是相當(dāng)?shù)撵`活,寫起來很爽创橄,但就很容易踩坑塔粒,很多的坑往往都是由于代碼不規(guī)范引起的,比如比較常見的一個(gè)錯(cuò)誤是xx is undefined筐摘。為了避免代碼不規(guī)范引起的錯(cuò)誤盔几,以及能讓我們寫出漂亮的代碼量没,就出現(xiàn)了很多的代碼檢測(cè)工具,比較常用的有JSLintJSHint蟹腾,JSCSESLint并扇。針對(duì)這些工具钾麸,今天就不做對(duì)比了茁影,今天主要介紹的是ESLint

1. 安裝

使用npm進(jìn)行全局安裝

npm install -g eslint

2.設(shè)置配置文件

使用如下命令設(shè)置一個(gè)配置文件

eslint --init

執(zhí)行完后确沸,會(huì)在目錄下生成一個(gè).eslintrc.js捌锭,如下所示:

module.exports = {
    "env": {//指定想啟用的環(huán)境,
        "browser": true,//瀏覽器環(huán)境
        "es6": true//es6環(huán)境
    },
    "extends": "eslint:recommended",//啟用一系列核心規(guī)
    "globals": {//腳本在執(zhí)行期間訪問的額外的全局變量
        "Atomics": "readonly",
        "SharedArrayBuffer": "readonly"
    },
    "parserOptions": {
        "ecmaVersion": 2018//用來指定es的版本號(hào)
    },
    "rules": {//啟用的規(guī)則及其各自的錯(cuò)誤級(jí)別
    }
};

如果創(chuàng)建的項(xiàng)目沒有package.json文件罗捎,需要先用npm init創(chuàng)建一個(gè)package.json文件观谦。

3.執(zhí)行

使用eslint 文件.js命令來檢測(cè)js文件,如果檢測(cè)到有不符合規(guī)范的桨菜,將在控制臺(tái)輸入錯(cuò)誤信息豁状,如下所示:

  1:10  error  'EslintDemo' is defined but never used  no-unused-vars
  2:14  error  'add' is defined but never used         no-unused-vars

JS文件的代碼是這樣的:

function EslintDemo() {
    function add(a,b) {
        var result = a + b;
        return result;
    }
}

4.webstorm開啟eslint

webstorm自帶了eslint,只需開啟就行了倒得,具體如下所示:

webstorm.png

但是開啟后泻红,webstorm會(huì)報(bào)錯(cuò)

TypeError: this.CliEngine is not a constructor

碰到這樣的錯(cuò)誤時(shí),需要修改/languageService/eslint/bin/eslint-plugin.js文件霞掺。如下所示:

//this.CliEngine = require(this.basicPath + "lib/cli-engine");
this.CliEngine = require(this.basicPath + "lib/cli-engine").CLIEngine;

修改后重啟webstorm

5.eslint驗(yàn)證規(guī)則

eslint中驗(yàn)證規(guī)則有很多谊路,這里主要介紹一些常見的規(guī)則。設(shè)置規(guī)則的開啟與關(guān)閉是在.eslintrc.js中修改rules的相關(guān)屬性菩彬,下面是vue.js默認(rèn)生成的一些規(guī)則:

rules: {
    // 強(qiáng)制 generator 函數(shù)中 * 號(hào)周圍使用一致的空格
    'generator-star-spacing': 'off',
    // 禁用 debugger
    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
  }
  • "off" 或 0 - 關(guān)閉規(guī)則
  • "warn" 或 1 - 開啟規(guī)則缠劝,使用警告級(jí)別的錯(cuò)誤:warn (不會(huì)導(dǎo)致程序退出)
  • "error" 或 2 - 開啟規(guī)則,使用錯(cuò)誤級(jí)別的錯(cuò)誤:error (當(dāng)被觸發(fā)的時(shí)候挤巡,程序會(huì)退出)
    常用驗(yàn)證規(guī)則
  • semi: 要求或禁止使用分號(hào)代替 ASI剩彬,比如在開啟該規(guī)則后酷麦,如果在代碼結(jié)束行后加了分號(hào)矿卑,將提示錯(cuò)誤。
  • comma-dangle:要求或禁止末尾逗號(hào)沃饶。比始在{}后面添加了逗號(hào)母廷,將提示錯(cuò)誤轻黑。
  • comma-spacing:強(qiáng)制在逗號(hào)前后使用一致的空格。比如定義一個(gè)數(shù)組:var arr = [1, 2, 3, 4]琴昆,如果在逗號(hào)后沒加空格氓鄙,將報(bào)錯(cuò)。
  • no-unused-vars:禁止出現(xiàn)未使用過的變量业舍。定義的變量抖拦,如果沒使用過,將提示錯(cuò)誤舷暮。
  • space-infix-ops:要求操作符周圍有空格态罪,比如for循環(huán)for (var i = 0; i <arr.length; i++),在<的前后沒有空格時(shí)下面,將提示錯(cuò)誤复颈。
  • space-before-blocks:強(qiáng)制在塊之前使用一致的空格。比如for循環(huán)for (var i = 0; i <arr.length; i++){{前沒有空格時(shí)沥割,將提示錯(cuò)誤耗啦。
  • no-redeclare:禁止多次聲明同一變量。在同一作用域類重復(fù)申明同樣的變量會(huì)提示錯(cuò)誤机杜。
  • indent:強(qiáng)制使用一致的縮進(jìn)帜讲。
  • spaced-comment:強(qiáng)制在注釋中 // 或 /* 使用一致的空格。// 前面要有空格

先介紹一些常用的椒拗,其它的可以在官方文檔中查看舒帮。
個(gè)人博客

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市陡叠,隨后出現(xiàn)的幾起案子玩郊,更是在濱河造成了極大的恐慌,老刑警劉巖枉阵,帶你破解...
    沈念sama閱讀 218,204評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件译红,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡兴溜,警方通過查閱死者的電腦和手機(jī)侦厚,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,091評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來拙徽,“玉大人刨沦,你說我怎么就攤上這事”炫拢” “怎么了想诅?”我有些...
    開封第一講書人閱讀 164,548評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我来破,道長篮灼,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,657評(píng)論 1 293
  • 正文 為了忘掉前任徘禁,我火速辦了婚禮诅诱,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘送朱。我一直安慰自己娘荡,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,689評(píng)論 6 392
  • 文/花漫 我一把揭開白布驶沼。 她就那樣靜靜地躺著它改,像睡著了一般。 火紅的嫁衣襯著肌膚如雪商乎。 梳的紋絲不亂的頭發(fā)上央拖,一...
    開封第一講書人閱讀 51,554評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音鹉戚,去河邊找鬼鲜戒。 笑死,一個(gè)胖子當(dāng)著我的面吹牛抹凳,可吹牛的內(nèi)容都是我干的遏餐。 我是一名探鬼主播,決...
    沈念sama閱讀 40,302評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼赢底,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼失都!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起幸冻,我...
    開封第一講書人閱讀 39,216評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤粹庞,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后洽损,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體庞溜,經(jīng)...
    沈念sama閱讀 45,661評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,851評(píng)論 3 336
  • 正文 我和宋清朗相戀三年碑定,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了流码。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,977評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡延刘,死狀恐怖漫试,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情碘赖,我是刑警寧澤驾荣,帶...
    沈念sama閱讀 35,697評(píng)論 5 347
  • 正文 年R本政府宣布外构,位于F島的核電站,受9級(jí)特大地震影響秘车,放射性物質(zhì)發(fā)生泄漏典勇。R本人自食惡果不足惜劫哼,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,306評(píng)論 3 330
  • 文/蒙蒙 一叮趴、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧权烧,春花似錦眯亦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,898評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至板祝,卻和暖如春宫静,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背券时。 一陣腳步聲響...
    開封第一講書人閱讀 33,019評(píng)論 1 270
  • 我被黑心中介騙來泰國打工孤里, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人橘洞。 一個(gè)月前我還...
    沈念sama閱讀 48,138評(píng)論 3 370
  • 正文 我出身青樓捌袜,卻偏偏與公主長得像,于是被迫代替她去往敵國和親炸枣。 傳聞我的和親對(duì)象是個(gè)殘疾皇子虏等,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,927評(píng)論 2 355

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

  • 一、JSLint JSHint ESLint 參考前端工具考 - ESLint 篇JS Linter 進(jìn)化史 C ...
    合肥黑閱讀 76,655評(píng)論 0 47
  • EsLint入門學(xué)習(xí)整理 這兩天因?yàn)楣疽笫食Γ蛯?duì)ESLint進(jìn)行了初步的了解霍衫,網(wǎng)上的內(nèi)容基本上都差不多,但是內(nèi)容...
    點(diǎn)柈閱讀 26,024評(píng)論 3 42
  • 命名規(guī)范 注釋 eslint編碼規(guī)范 使用兩個(gè)空格進(jìn)行縮進(jìn)侯养。eslint: indentfunction hell...
    王_凱閱讀 675評(píng)論 0 2
  • ESLint規(guī)范說明1慕淡、工具簡介ESLint是一個(gè)QA工具,用來避免低級(jí)錯(cuò)誤和統(tǒng)一代碼的風(fēng)格沸毁。ESLint被設(shè)計(jì)為...
    小漠窮秋閱讀 2,929評(píng)論 0 0
  • 賴玉超:瞎操心~ 2015年10月18日東莞 五點(diǎn)多峰髓,鬧鐘響了。 我老婆捏了我一下息尺,意思讓我起床把鬧鐘關(guān)了携兵。 她說...
    laiyuchao閱讀 217評(píng)論 0 0