什么是 ESLint
ESLint（中文站點）是一個開源的 JavaScript 代碼檢查工具，使用 Node.js 編寫，由 Nicholas C. Zakas 于 2013 年 6 月創建。ESLint 的初衷是為了讓程序員可以創建自己的檢測規則，使其可以在編碼的過程中發現問題而不是在執行的過程中。ESLint 的所有規則都被設計成可插入的，為了方便使用，ESLint 內置了一些規則，在這基礎上也可以增加自定義規則。
安裝 ESLint 擴展
安裝環境
Windows 10
安裝 ESLint 擴展
首先，打開 VSCode 擴展面板并搜索 ESLint 擴展，然后點擊安裝
安裝完畢之后點擊重新加載以激活擴展，但想要讓擴展進行工作，我們還需要先進行 ESLint 的安裝配置。
安裝 ESLint
如果你僅僅想讓 ESLint 成為你項目構建系統的一部分，我們可以在項目根目錄進行本地安裝：
$ npm install eslint --save-dev
如果想使 ESLint 適用于你所有的項目，我們建議使用全局安裝，使用全局安裝 ESLint 后，你使用的任何 ESLint 插件或可分享的配置也都必須在全局安裝。
這里我們使用全局安裝：
$ npminstall?-g eslint
安裝完畢后，我們使用eslint --init命令在用戶目錄中生成一個配置文件（也可以在任何你喜歡的位置進行生成）
我們在第一個選項中選擇自定義代碼風格，之后根據需要自行選擇。
設置完成后我們會得到一份文件名為.eslintrc.js的配置文件：
module.exports = {"env": {"browser":true,"commonjs":true,"es6":true? ? },"extends":"eslint:recommended","parserOptions": {"sourceType":"module"? ? },"rules": {"indent": ["error",4? ? ? ? ],"linebreak-style": ["error","windows"? ? ? ? ],"quotes": ["error","single"? ? ? ? ],"semi": ["error","never"
? ? ? ? ]
? ? }
};
配置 ESLint
配置文件生成之后，我們接著可以進行自定義修改，這里我們只粗略講解常用的配置項，完整的可配置項可訪問官方文檔
配置環境
在上文生成的配置文件中可以使用env屬性來指定要啟用的環境，將其設置為true，以保證在進行代碼檢測時不會把這些環境預定義的全局變量識別成未定義的變量而報錯：
"env": {"browser":true,"commonjs":true,"es6":true,"jquery":true
}
設置語言選項
默認情況下，ESLint 支持 ECMAScript 5 語法，如果你想啟用對 ECMAScript 其它版本和 JSX 等的支持，ESLint 允許你使用parserOptions屬性進行指定想要支持的 JavaScript語言選項，不過你可能需要自行安裝eslint-plugin-react等插件。
"parserOptions": {"ecmaVersion":6,"sourceType":"module","ecmaFeatures": {"jsx":true
? ? }
}
配置規則
在上文的配置文件中，"extends": "eslint:recommended"選項表示啟用推薦規則，在推薦規則的基礎上我們還可以根據需要使用rules新增自定義規則，每個規則的第一個值都是代表該規則檢測后顯示的錯誤級別：
"off"或0- 關閉規則
"warn"或1- 將規則視為一個警告
"error"或2- 將規則視為一個錯誤
"rules": {"indent": ["error",4? ? ],"linebreak-style": ["error","windows"? ? ],"quotes": ["error","single"? ? ],"semi": ["error","never"
? ? ]
}
完整的可配置規則列表可訪問：http://eslint.cn/docs/rules/
其中帶√標記的表示該規則為推薦規則。
設置 ESLint 擴展
安裝并配置完成 ESLint 后，我們繼續回到 VSCode 進行擴展設置，依次點擊文件 > 首選項 > 設置打開 VSCode 配置文件
從左側系統設置中可以看到，ESLint 擴展默認已經啟用，我們現在只需在右側用戶設置中添加配置來指定我們創建的.eslintrc.js配置文件路徑即可啟用自定義規則檢測，ESLint 會查找并自動讀取它們：
"eslint.options": {"configFile":"E:/git/github/styleguide/eslint/.eslintrc.js"
},
至此，我們已經可以使用 ESLint 擴展來檢測我們的 js 文件了。
讓 ESLint 支持 Vue 單文件組件
由于 ESLint 默認只支持 js 文件的腳本檢測，如果我們需要支持類html文件（如vue）的內聯腳本檢測，還需要安裝eslint-plugin-html插件。
因為我們使用全局安裝了 ESLint，所以eslint-plugin-html插件也必須進行全局安裝：
$ npminstall?-g eslint-plugin-html
安裝完成后，我們再次打開文件 > 首選項 > 設置，在右側用戶設置中修改 ESLint 的相關配置并保存：
"eslint.options": {"configFile":"E:/git/github/styleguide/eslint/.eslintrc.js","plugins": ["html"]},"eslint.validate": ["javascript","javascriptreact","html","vue"
]
最后，我們打開一個vue文件，可以發現 ESLint 擴展已經正常工作了
"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"]//禁止尤達條件
支持react，要加上
// "off" or 0 - turn the rule off
// "warn" or 1 - turn the rule on as a warning (doesn’t affect exit code)
// "error" or 2 - turn the rule on as an error (exit code is 1 when triggered)
module.exports = {
"env": {
"browser": true,
"commonjs": true,
"es6": true,
"node": true,
"jest": true,
"jquery": true
},
"parser": "Espree",
"globals": {
"__dirname": "__dirname"
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": 6,
"ecmaFeatures": {
"experimentalObjectRestSpread": true,
"jsx": true,
"globalReturn": true //allow return statements in the global scope
},
"sourceType": "module"
},
"plugins": [
"react"
],
"rules": {
"react/jsx-uses-react": "error",
"react/jsx-uses-vars": ["error"],
"indent": [
2, 4
],
"linebreak-style": [
"error",
"windows"
],
"quotes": [
"error",
"single"
],
"semi": "error",
"eqeqeq": "error", // require the use of === and !==
"no-alert": "error", //require the use of === and !==
"no-multi-spaces": "error", //disallow multiple spaces
"no-redeclare": "error", //disallow variable redeclaration
}
};
擴展：1：
如果有個全局變量，eslint報錯可以用/* global var1, var2 */來消除
或者在eslint中定義global
"globals":{
"__dirname": "__dirname"
},
或者
/* eslint-disable */
let a = 12;
/* eslint-enable */
作者：飛翔的烏龜和牛牛，博客：www.cnblogs.com/
