ESlint語法檢測工具

ESLint簡介

ESLint是一款代碼規(guī)格檢查工具摊欠,能夠有效的保證團隊的代碼質(zhì)量,避免低級代碼笛求。

ESlint特點

  • 默認(rèn)規(guī)則包含所有JSHint奏窑、JSLint中存在的所有規(guī)則熬丧,易遷移屉符;
  • 可以設(shè)置警告(1),錯誤(2)锹引,關(guān)閉(0)三種規(guī)格的配置矗钟;
  • 包含代碼風(fēng)格檢測;
  • 支持插件擴展嫌变、自定義規(guī)則吨艇;

sublime中如何安裝ESLint

1.環(huán)境準(zhǔn)備
  • 首先你得有sublime text3編輯器,并且已經(jīng)安裝了package control腾啥;
  • 其次你得有node環(huán)境东涡,如果不知道node環(huán)境如何安裝,請點擊前往 node倘待;
  • 好了疮跑,以上環(huán)境準(zhǔn)備好了就可以按照下面步驟一步步來了。
2.安裝eslint包模塊

可以使用npm或cnpm(淘寶)來全局安裝eslint凸舵。

npm install eslint -g
3.安裝sublimeLinter插件

在sublime中打開package control(快捷鍵ctrl + shift + p)選擇install package 然后在搜索框中搜索sublimeLinter插件祖娘,點擊即可安裝。


Paste_Image.png
4.安裝sublimeLinter-contrib-eslint插件

同樣的在package control中搜索sublimeLinter-contrib-eslint插件來進(jìn)行安裝

Paste_Image.png
5.集成sublimeLinter的配置文件

點擊preferences ==> package settings ==> SublimeLinter ==> Settings-user 打開配置文件啊奄,查詢paths關(guān)鍵字渐苏,找到paths下面的windows字段,修改eslint的全局命令:

"paths": {
            "linux": [],
            "osx": [],
            "windows": [
                "**/nodejs/eslint.cmd"
            ]
        },
6.創(chuàng)建.eslintrc語法規(guī)則文件

當(dāng)當(dāng)當(dāng)菇夸,終于到了最后一步拉琼富。在自己的項目工程根目錄下面創(chuàng)建.eslintrc語法規(guī)則配置文件。

  • 方法一: 在命令行里輸入eslint --init命令進(jìn)行自主選擇創(chuàng)建文件庄新。命令行會根據(jù)用戶自己選擇的風(fēng)格來創(chuàng)建文件
    Paste_Image.png
  • 方法二: 在命令行里輸入'echo {} > .eslintrc'命令直接創(chuàng)建.eslintrc文件鞠眉。然后在.eslintrc文件中可以直接復(fù)制以下代碼,具體的rule配置可以根據(jù)自己的項目選擇性的修改:
{
  "globals": {
    "$": true,                                //zepto
    "define": true,                           //requirejs
    "require": true                           //requirejs
  },
  "env": {
    "browser": true                           //執(zhí)行環(huán)境 瀏覽器
  },
  "rules": {
    //官方文檔 http://eslint.org/docs/rules/
    //警告
    // "quotes": [0, "single"],                  //建議使用單引號
    // "no-inner-declarations": [0, "both"],     //不建議在{}代碼塊內(nèi)部聲明變量或函數(shù)
    "no-extra-boolean-cast": 1,               //多余的感嘆號轉(zhuǎn)布爾型
    "no-extra-semi": 1,                       //多余的分號
    "no-extra-parens": 1,                     //多余的括號
    "no-empty": 1,                            //空代碼塊
    "no-use-before-define": [1, "nofunc"],    //使用前未定義
    "complexity": [1, 10],                    //圈復(fù)雜度大于10 警告

    //常見錯誤
    "comma-dangle": [2, "never"],             //定義數(shù)組或?qū)ο笞詈蠖嘤嗟亩禾?    "no-debugger": 2,                         //debugger 調(diào)試代碼未刪除
    "no-constant-condition": 2,               //常量作為條件
    "no-dupe-args": 2,                        //參數(shù)重復(fù)
    "no-dupe-keys": 2,                        //對象屬性重復(fù)
    "no-duplicate-case": 2,                   //case重復(fù)
    "no-empty-character-class": 2,            //正則無法匹配任何值
    "no-invalid-regexp": 2,                   //無效的正則
    "no-func-assign": 2,                      //函數(shù)被賦值
    "valid-typeof": 2,                        //無效的類型判斷
    "no-unreachable": 2,                      //不可能執(zhí)行到的代碼
    "no-unexpected-multiline": 2,             //行尾缺少分號可能導(dǎo)致一些意外情況
    "no-sparse-arrays": 2,                    //數(shù)組中多出逗號
    "no-shadow-restricted-names": 2,          //關(guān)鍵詞與命名沖突
    "no-undef": 2,                            //變量未定義
    "no-unused-vars": 2,                      //變量定義后未使用
    "no-cond-assign": 2,                      //條件語句中禁止賦值操作
    "no-native-reassign": 2,                  //禁止覆蓋原生對象

    //代碼風(fēng)格優(yōu)化
    "no-else-return": 1,                      //在else代碼塊中return薯鼠,else是多余的
    "no-multi-spaces": 1,                     //不允許多個空格
    "key-spacing": [1, {"beforeColon": false, "afterColon": true}],//object直接量建議寫法 : 后一個空格前面不留空格
    "block-scoped-var": 2,                    //變量應(yīng)在外部上下文中聲明,不應(yīng)在{}代碼塊中
    "consistent-return": 2,                   //函數(shù)返回值可能是不同類型
    "accessor-pairs": 2,                      //object getter/setter方法需要成對出現(xiàn)
    "dot-location": [2, "property"],          //換行調(diào)用對象方法  點操作符應(yīng)寫在行首
    "no-lone-blocks": 2,                      //多余的{}嵌套
    "no-empty-label": 2,                      //無用的標(biāo)記
    "no-extend-native": 2,                    //禁止擴展原生對象
    "no-floating-decimal": 2,                 //浮點型需要寫全 禁止.1 或 2.寫法
    "no-loop-func": 2,                        //禁止在循環(huán)體中定義函數(shù)
    "no-new-func": 2,                         //禁止new Function(...) 寫法
    "no-self-compare": 2,                     //不允與自己比較作為條件
    "no-sequences": 2,                        //禁止可能導(dǎo)致結(jié)果不明確的逗號操作符
    "no-throw-literal": 2,                    //禁止拋出一個直接量 應(yīng)是Error對象
    "no-return-assign": [2, "always"],        //不允return時有賦值操作
    "no-redeclare": [2, {"builtinGlobals": true}],//不允許重復(fù)聲明
    "no-unused-expressions": [2, {"allowShortCircuit": true, "allowTernary": true}],//不執(zhí)行的表達(dá)式
    "no-useless-call": 2,                     //無意義的函數(shù)call或apply
    "no-useless-concat": 2,                   //無意義的string concat
    "no-void": 2,                             //禁用void
    "no-with": 2,                             //禁用with
    "space-infix-ops": 2,                     //操作符前后空格
    "valid-jsdoc": [2, {"requireParamDescription": true, "requireReturnDescription": true}],//jsdoc
    "no-warning-comments": [2, { "terms": ["todo", "fixme", "any other term"], "location": "anywhere" }],//標(biāo)記未寫注釋
    "curly": 1                                //if械蹋、else出皇、while、for代碼塊用{}包圍
  }
}
7.成功后界面預(yù)覽

根據(jù)語法規(guī)則的配置朝蜘,eslint會自動檢測語法錯誤恶迈,并高亮顯示,是不是很酷呢~


Paste_Image.png

gulp中如何集成ESlint

通過自動化構(gòu)建工具gulpe來集成eslint也是非常方便的谱醇。

1.安裝gulp-eslint包模塊

通過npm 或者 cnpm( 淘寶)來全局安裝gulp-eslint 包模塊.

npm install gulp-eslint -g
2.編寫gulp配置文件

然后在自己的項目的gulp.js配置文件中編寫eslint的任務(wù)即可暇仲。

var eslint = require('gulp-eslint');
gulp.task('eslint-task', function(){
      return gulp.src(['app/**/*.js']) //指定的校驗路徑 
      .pipe(eslint({configFile:"./.eslintrc"})) //使用你的eslint校驗文件 
      .pipe(eslint.format())
 }); 
gulp.task('default', ['eslint-task']);

總結(jié)

使用eslint能夠很大程度上避免程序員編碼過程中出現(xiàn)的低級錯誤,提高自己的代碼水平副渴。一個項目中奈附,代碼的質(zhì)量,健壯性尤為重要煮剧。eslint能夠讓前端工程工程化更進(jìn)一步斥滤。

后記

感謝支持。若不足之處勉盅,歡迎大家指出佑颇,共勉。

如果覺得不錯草娜,記得 點贊挑胸,謝謝大家 ??

歡迎關(guān)注 我的:【Blog】【Github】【掘金】【簡書】

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市宰闰,隨后出現(xiàn)的幾起案子茬贵,更是在濱河造成了極大的恐慌,老刑警劉巖移袍,帶你破解...
    沈念sama閱讀 211,123評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件解藻,死亡現(xiàn)場離奇詭異,居然都是意外死亡葡盗,警方通過查閱死者的電腦和手機螟左,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2 384
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來戳粒,“玉大人路狮,你說我怎么就攤上這事∥翟迹” “怎么了?”我有些...
    開封第一講書人閱讀 156,723評論 0 345
  • 文/不壞的土叔 我叫張陵涂籽,是天一觀的道長苹祟。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么树枫? 我笑而不...
    開封第一講書人閱讀 56,357評論 1 283
  • 正文 為了忘掉前任直焙,我火速辦了婚禮,結(jié)果婚禮上砂轻,老公的妹妹穿的比我還像新娘奔誓。我一直安慰自己,他們只是感情好搔涝,可當(dāng)我...
    茶點故事閱讀 65,412評論 5 384
  • 文/花漫 我一把揭開白布厨喂。 她就那樣靜靜地躺著,像睡著了一般庄呈。 火紅的嫁衣襯著肌膚如雪蜕煌。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,760評論 1 289
  • 那天诬留,我揣著相機與錄音斜纪,去河邊找鬼。 笑死文兑,一個胖子當(dāng)著我的面吹牛盒刚,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播绿贞,決...
    沈念sama閱讀 38,904評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼因块,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了樟蠕?” 一聲冷哼從身側(cè)響起贮聂,我...
    開封第一講書人閱讀 37,672評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎寨辩,沒想到半個月后吓懈,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,118評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡靡狞,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2 325
  • 正文 我和宋清朗相戀三年耻警,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片甸怕。...
    茶點故事閱讀 38,599評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡甘穿,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出梢杭,到底是詐尸還是另有隱情温兼,我是刑警寧澤,帶...
    沈念sama閱讀 34,264評論 4 328
  • 正文 年R本政府宣布武契,位于F島的核電站募判,受9級特大地震影響荡含,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜届垫,卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3 312
  • 文/蒙蒙 一释液、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧装处,春花似錦误债、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至判族,卻和暖如春躺盛,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背形帮。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1 264
  • 我被黑心中介騙來泰國打工槽惫, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人辩撑。 一個月前我還...
    沈念sama閱讀 46,286評論 2 360
  • 正文 我出身青樓界斜,卻偏偏與公主長得像,于是被迫代替她去往敵國和親合冀。 傳聞我的和親對象是個殘疾皇子各薇,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,465評論 2 348

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

  • ESLint 配置 ESlint 被設(shè)計為完全可配置的,這意味著你可以關(guān)閉每一個規(guī)則而只運行基本語法驗證君躺,或混合和...
    靜默虛空閱讀 41,249評論 3 14
  • 前言 本文默認(rèn)你已經(jīng)安裝好node環(huán)境峭判,并且熟悉node命令,和window cd命令棕叫。 gulp簡介 基于nod...
    9I閱讀 1,976評論 4 50
  • EsLint入門學(xué)習(xí)整理 這兩天因為公司要求林螃,就對ESLint進(jìn)行了初步的了解,網(wǎng)上的內(nèi)容基本上都差不多俺泣,但是內(nèi)容...
    點柈閱讀 26,009評論 3 42
  • ESLint最初是由Nicholas C. Zakas 于2013年6月創(chuàng)建的開源項目疗认。它的目標(biāo)是提供一個插件化的...
    gavinDu閱讀 1,788評論 1 1
  • 前提:如果沒有安裝package control,可以參考sublime插件推薦以下按照順序安裝: 安裝Subli...
    real勾玉閱讀 1,660評論 1 2