簡介
ESLint是一個用來識別 ECMAScript 並且按照規則給出報告的代碼檢測工具，使用它可以避免低級錯誤和統一代碼的風格。如果每次在代碼提交之前都進行一次eslint代碼檢查，就不會因為某個字段未定義為undefined或null這樣的錯誤而導致服務崩潰，可以有效的控制項目代碼的質量。
在許多方面，它和 JSLint、JSHint 相似，除了少數的例外：
- ESLint 使用 Espree 解析 JavaScript。
- ESLint 使用 AST 去分析代碼中的模式。
- ESLint 是完全插件化的。每一個規則都是一個插件並且你可以在運行時添加更多的規則。
此外，也可以應用於nodejs中進行語法掃描，常用功能
- 檢查語法錯誤
- 檢查語法風格
- 修正語法
安裝
ESLint 支持多種安裝方式，可以通過 npm 來安裝，也可以在 webpack(eslint-loader) 和 Gulp.js(gulp-eslint) 中使用。
全局安裝
npm i -g eslint
局部安裝（推薦）
npm i -D eslint
初始化
安裝完畢后，接下來新建一個配置文件.eslintrc.js，或者使用如下的命令行來自動生成，命令如下：
eslint --init
運行 eslint --init 之后，.eslintrc 文件會在你的文件夾中自動創建，執行掃描：
eslint -c .eslintrc.json -f html -o Check.html .
ESlint支持的可配置信息主要分為3類：
- Environments：Javascript 腳步將要運行在什么環境中（如：nodejs，browser，commonjs等）,ESlint支持的所有環境都可以在官網查到。
- Globals：執行代碼時腳步需要訪問的額外全局變量。
- Rules：開啟某些規則，也可以設置規則的等級。
檢測規則
接下來，可以在配置文件中設置一些規則。ESLint規則的三種級別：
- "off" 或者 0：關閉規則。
- "warn" 或者 1：打開規則，並且作為一個警告（不影響exit code）。
- "error" 或者 2：打開規則，並且作為一個錯誤（exit code將會是1）。
規則說明
"no-alert" : 0, //禁止使用alert confirm prompt
"no-array-constructor" : 2, //禁止使用數組構造器
"no-bitwise" : 0, //禁止使用按位運算符
"no-caller" : 1, //禁止使用arguments.caller或arguments.callee
"no-catch-shadow" : 2, //禁止catch子句參數與外部作用域變量同名
"no-class-assign" : 2, //禁止給類賦值
"no-cond-assign" : 2, //禁止在條件表達式中使用賦值語句
"no-console" : 2, //禁止使用console
"no-const-assign" : 2, //禁止修改const聲明的變量
"no-constant-condition" : 2, //禁止在條件中使用常量表達式 if(true) if(1)
"no-continue" : 0, //禁止使用continue
"no-control-regex" : 2, //禁止在正則表達式中使用控制字符
"no-debugger" : 2, //禁止使用debugger
"no-delete-var" : 2, //不能對var聲明的變量使用delete操作符
"no-div-regex" : 1, //不能使用看起來像除法的正則表達式/=foo/
"no-dupe-keys" : 2, //在創建對象字面量時不允許鍵重復 {a:1,a:1}
"no-dupe-args" : 2, //函數參數不能重復
"no-duplicate-case" : 2, //switch中的case標簽不能重復
"no-else-return" : 2, //如果if語句里面有return,后面不能跟else語句
"no-empty" : 2, //塊語句中的內容不能為空
"no-empty-character-class": 2, //正則表達式中的[]內容不能為空
"no-empty-label" : 2, //禁止使用空label
"no-eq-null" : 2, //禁止對null使用==或!=運算符
"no-eval" : 1, //禁止使用eval
"no-ex-assign" : 2, //禁止給catch語句中的異常參數賦值
"no-extend-native" : 2, //禁止擴展native對象
"no-extra-bind" : 2, //禁止不必要的函數綁定
"no-extra-boolean-cast" : 2, //禁止不必要的bool轉換
"no-extra-parens" : 2, //禁止非必要的括號
"no-extra-semi" : 2, //禁止多余的冒號
"no-fallthrough" : 1, //禁止switch穿透
"no-floating-decimal" : 2, //禁止省略浮點數中的0 .5 3.
"no-func-assign" : 2, //禁止重復的函數聲明
"no-implicit-coercion" : 1, //禁止隱式轉換
"no-implied-eval" : 2, //禁止使用隱式eval
"no-inline-comments" : 0, //禁止行內備注
"no-inner-declarations" : [
2,
"functions"
], //禁止在塊語句中使用聲明（變量或函數）
"no-invalid-regexp" : 2, //禁止無效的正則表達式
"no-invalid-this" : 2, //禁止無效的this，只能用在構造器，類，對象字面量
"no-irregular-whitespace": 2, //不能有不規則的空格
"no-iterator" : 2, //禁止使用__iterator__ 屬性
"no-label-var" : 2, //label名不能與var聲明的變量名相同
"no-labels" : 2, //禁止標簽聲明
"no-lone-blocks" : 2, //禁止不必要的嵌套塊
"no-lonely-if" : 2, //禁止else語句內只有if語句
"no-loop-func" : 1, //禁止在循環中使用函數（如果沒有引用外部變量不形成閉包就可以）
"no-mixed-requires" : [
0,
false
], //聲明時不能混用聲明類型
"no-mixed-spaces-and-tabs": [
2,
false
], //禁止混用tab和空格
"linebreak-style": [
0,
"windows"
], //換行風格
"no-multi-spaces" : 1, //不能用多余的空格
"no-multi-str" : 2, //字符串不能用\換行
"no-multiple-empty-lines": [
1,
{
"max": 2
}
], //空行最多不能超過2行
"no-native-reassign" : 2, //不能重寫native對象
"no-negated-in-lhs" : 2, //in 操作符的左邊不能有!
"no-nested-ternary" : 0, //禁止使用嵌套的三目運算
"no-new" : 1, //禁止在使用new構造一個實例后不賦值
"no-new-func" : 1, //禁止使用new Function
"no-new-object" : 2, //禁止使用new Object()
"no-new-require" : 2, //禁止使用new require
"no-new-wrappers" : 2, //禁止使用new創建包裝實例，new String new Boolean new Number
"no-obj-calls" : 2, //不能調用內置的全局對象，比如Math() JSON()
"no-octal" : 2, //禁止使用八進制數字
"no-octal-escape" : 2, //禁止使用八進制轉義序列
"no-param-reassign" : 2, //禁止給參數重新賦值
"no-path-concat" : 0, //node中不能使用__dirname或__filename做路徑拼接
"no-plusplus" : 0, //禁止使用++，--
"no-process-env" : 0, //禁止使用process.env
"no-process-exit" : 0, //禁止使用process.exit()
"no-proto" : 2, //禁止使用__proto__屬性
"no-redeclare" : 2, //禁止重復聲明變量
"no-regex-spaces" : 2, //禁止在正則表達式字面量中使用多個空格 /foo bar/
"no-restricted-modules" : 0, //如果禁用了指定模塊，使用就會報錯
"no-return-assign" : 1, //return 語句中不能有賦值表達式
"no-script-url" : 0, //禁止使用javascript:void(0)
"no-self-compare" : 2, //不能比較自身
"no-sequences" : 0, //禁止使用逗號運算符
"no-shadow" : 2, //外部作用域中的變量不能與它所包含的作用域中的變量或參數同名
"no-shadow-restricted-names": 2, //嚴格模式中規定的限制標識符不能作為聲明時的變量名使用
"no-spaced-func" : 2, //函數調用時 函數名與()之間不能有空格
"no-sparse-arrays" : 2, //禁止稀疏數組， [1,,2]
"no-sync" : 0, //nodejs 禁止同步方法
"no-ternary" : 0, //禁止使用三目運算符
"no-trailing-spaces" : 1, //一行結束后面不要有空格
"no-this-before-super" : 0, //在調用super()之前不能使用this或super
"no-throw-literal" : 2, //禁止拋出字面量錯誤 throw "error";
"no-undef" : 1, //不能有未定義的變量
"no-undef-init" : 2, //變量初始化時不能直接給它賦值為undefined
"no-undefined" : 2, //不能使用undefined
"no-unexpected-multiline" : 2, //避免多行表達式
"no-underscore-dangle" : 1, //標識符不能以_開頭或結尾
"no-unneeded-ternary" : 2, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable" : 2, //不能有無法執行的代碼
"no-unused-expressions" : 2, //禁止無用的表達式
"no-unused-vars" : [
2,
{
"vars": "all",
"args": "after-used"
}
], //不能有聲明后未被使用的變量或參數
"no-use-before-define": 2, //未定義前不能使用
"no-useless-call" : 2, //禁止不必要的call和apply
"no-void" : 2, //禁用void操作符
"no-var" : 0, //禁用var，用let和const代替
"no-warning-comments" : [
1,
{
"terms": [
"todo",
"fixme",
"xxx"
],
"location": "start"
}
], //不能有警告備注
"no-with" : 2, //禁用with
"array-bracket-spacing": [
2,
"never"
], //是否允許非空數組里面有多余的空格
"arrow-parens" : 0, //箭頭函數用小括號括起來
"arrow-spacing" : 0, //=>的前/后括號
"accessor-pairs" : 0, //在對象中使用getter/setter
"block-scoped-var": 0, //塊語句中使用var
"brace-style" : [
1,
"1tbs"
], //大括號風格
"callback-return": 1, //避免多次調用回調什么的
"camelcase" : 2, //強制駝峰法命名
"comma-dangle" : [
2,
"never"
], //對象字面量項尾不能有逗號
"comma-spacing": 0, //逗號前后的空格
"comma-style" : [
2,
"last"
], //逗號風格，換行時在行首還是行尾
"complexity": [
0,
11
], //循環復雜度
"computed-property-spacing": [
0,
"never"
], //是否允許計算后的鍵名什么的
"consistent-return": 0, //return 后面是否允許省略
"consistent-this" : [
2,
"that"
], //this別名
"constructor-super": 0, //非派生類不能調用super，派生類必須調用super
"curly" : [
2,
"all"
], //必須使用 if(){} 中的{}
"default-case": 2, //switch語句最后必須有default
"dot-location": 0, //對象訪問符的位置，換行的時候在行首還是行尾
"dot-notation": [
0,
{
"allowKeywords": true
}
], //避免不必要的方括號
"eol-last" : 0, //文件以單一的換行符結束
"eqeqeq" : 2, //必須使用全等
"func-names": 0, //函數表達式必須有名字
"func-style": [
0,
"declaration"
], //函數風格，規定只能使用函數聲明/函數表達式
"generator-star-spacing": 0, //生成器函數*的前后空格
"guard-for-in" : 0, //for in循環要用if語句過濾
"handle-callback-err" : 0, //nodejs 處理錯誤
"id-length" : 0, //變量名長度
"indent" : [
2,
4
], //縮進風格
"init-declarations": 0, //聲明時必須賦初值
"key-spacing" : [
0,
{
"beforeColon": false,
"afterColon" : true
}
], //對象字面量中冒號的前后空格
"lines-around-comment": 0, //行前/行后備注
"max-depth" : [
0,
4
], //嵌套塊深度
"max-len": [
0,
80,
4
], //字符串最大長度
"max-nested-callbacks": [
0,
2
], //回調嵌套深度
"max-params": [
0,
3
], //函數最多只能有3個參數
"max-statements": [
0,
10
], //函數內最多有幾個聲明
"new-cap" : 2, //函數名首行大寫必須使用new方式調用，首行小寫必須用不帶new方式調用
"new-parens" : 2, //new時必須加小括號
"newline-after-var" : 2, //變量聲明后是否需要空一行
"object-curly-spacing": [
0,
"never"
], //大括號內是否允許不必要的空格
"object-shorthand" : 0, //強制對象字面量縮寫語法
"one-var" : 1, //連續聲明
"operator-assignment": [
0,
"always"
], //賦值運算符 += -=什么的
"operator-linebreak": [
2,
"after"
], //換行時運算符在行尾還是行首
"padded-blocks" : 0, //塊語句內行首行尾是否要空行
"prefer-const" : 0, //首選const
"prefer-spread" : 0, //首選展開運算
"prefer-reflect": 0, //首選Reflect的方法
"quotes" : [
1,
"single"
], //引號類型 `` "" ''
"quote-props": [
2,
"always"
], //對象字面量中的屬性名是否強制雙引號
"radix" : 2, //parseInt必須指定第二個參數
"id-match" : 0, //命名檢測
"require-yield": 0, //生成器函數必須有yield
"semi" : [
2,
"always"
], //語句強制分號結尾
"semi-spacing": [
0,
{
"before": false,
"after" : true
}
], //分號前后空格
"sort-vars" : 0, //變量聲明時排序
"space-after-keywords": [
0,
"always"
], //關鍵字后面是否要空一格
"space-before-blocks": [
0,
"always"
], //不以新行開始的塊{前面要不要有空格
"space-before-function-paren": [
0,
"always"
], //函數定義時括號前面要不要有空格
"space-in-parens": [
0,
"never"
], //小括號里面要不要有空格
"space-infix-ops" : 0, //中綴操作符周圍要不要有空格
"space-return-throw-case": 2, //return throw case后面要不要加空格
"space-unary-ops" : [
0,
{
"words" : true,
"nonwords": false
}
], //一元運算符的前/后要不要加空格
"spaced-comment": 0, //注釋風格要不要有空格什么的
"strict" : 2, //使用嚴格模式
"use-isnan" : 2, //禁止比較時使用NaN，只能用isNaN()
"valid-jsdoc" : 0, //jsdoc規則
"valid-typeof" : 2, //必須使用合法的typeof的值
"vars-on-top" : 2, //var必須放在作用域頂部
"wrap-iife" : [
2,
"inside"
], //立即執行函數表達式的小括號風格
"wrap-regex": 0, //正則表達式字面量用小括號包起來
"yoda" : [
2,
"never"
] //禁止尤達條件
范例
這是一個例子，可以直接使用，具體規格可以自己指定
{
"globals": {
"$": true //zepto
},
"env": {
"browser": true,
"node" : true
},
"rules": {
//警告
// "quotes": [1, "single"], //建議使用單引號
// "no-inner-declarations": [1, "both"], //不建議在{}代碼塊內部聲明變量或函數
"no-extra-boolean-cast": 1, //多余的感嘆號轉布爾型
"no-extra-semi" : 1, //多余的分號
"no-extra-parens" : 1, //多余的括號
"no-empty" : 1, //空代碼塊
"no-use-before-define" : [
1,
"nofunc"
], //使用前未定義
"complexity": [
1,
10
], //圈復雜度大於10 警告
//常見錯誤
"comma-dangle": [
2,
"never"
], //定義數組或對象最后多余的逗號
"no-debugger" : 2, //debugger 調試代碼未刪除
"no-constant-condition" : 2, //常量作為條件
"no-dupe-args" : 2, //參數重復
"no-dupe-keys" : 2, //對象屬性重復
"no-duplicate-case" : 2, //case重復
"no-empty-character-class" : 2, //正則無法匹配任何值
"no-invalid-regexp" : 2, //無效的正則
"no-func-assign" : 2, //函數被賦值
"valid-typeof" : 2, //無效的類型判斷
"no-unreachable" : 2, //不可能執行到的代碼
"no-unexpected-multiline" : 2, //行尾缺少分號可能導致一些意外情況
"no-sparse-arrays" : 2, //數組中多出逗號
"no-shadow-restricted-names": 2, //關鍵詞與命名沖突
"no-undef" : 2, //變量未定義
"no-unused-vars" : 2, //變量定義后未使用
"no-cond-assign" : 2, //條件語句中禁止賦值操作
"no-native-reassign" : 2, //禁止覆蓋原生對象
//代碼風格優化
"no-else-return" : 1, //在else代碼塊中return，else是多余的
"no-multi-spaces": 1, //不允許多個空格
"key-spacing" : [
1,
{
"beforeColon": false,
"afterColon" : true
}
], //object直接量建議寫法 : 后一個空格簽名不留空格
"block-scoped-var" : 2, //變量定義后未使用
"consistent-return": 2, //函數返回值可能是不同類型
"accessor-pairs" : 2, //object getter/setter方法需要成對出現
"dot-location" : [
2,
"property"
], //換行調用對象方法 點操作符應寫在行首
"no-lone-blocks" : 2, //多余的{}嵌套
"no-empty-label" : 2, //無用的標記
"no-extend-native" : 2, //禁止擴展原生對象
"no-floating-decimal": 2, //浮點型需要寫全 禁止.1 或 2.寫法
"no-loop-func" : 2, //禁止在循環體中定義函數
"no-new-func" : 2, //禁止new Function(...) 寫法
"no-self-compare" : 2, //不允與自己比較作為條件
"no-sequences" : 2, //禁止可能導致結果不明確的逗號操作符
"no-throw-literal" : 2, //禁止拋出一個直接量 應是Error對象
"no-return-assign" : [
2,
"always"
], //不允return時有賦值操作
"no-redeclare": [
2,
{
"builtinGlobals": true
}
], //不允許重復聲明
"no-unused-expressions": [
2,
{
"allowShortCircuit": true,
"allowTernary" : true
}
], //未使用的表達式
"no-useless-call" : 2, //無意義的函數call或apply
"no-useless-concat" : 2, //無意義的string concat
"no-void" : 2, //禁用void
"no-with" : 2, //禁用with
"no-warning-comments": [
2,
{
"terms": [
"todo",
"fixme",
"any other term"
],
"location": "anywhere"
}
], //標記未寫注釋
"curly": 2 //if、else、while、for代碼塊用{}包圍
}
}
參考文章
[1] Eslint靜態代碼檢查
[2] ESLint簡介