1.安裝
全局安裝
npm install eslint -g
局部安裝
npm install eslint --save
2.初始化一個配置文件
eslint --init
執行后根據項目需要回答幾個問題，最后會在根目錄生成一個.eslintrc.js文件：
module.exports = { "env": { "browser": true, "es6": true }, "extends": "eslint:recommended", "globals": { "Atomics": "readonly", "SharedArrayBuffer": "readonly" }, "parserOptions": { "ecmaVersion": 2018 }, "rules": { } };
"extends": "eslint:recommended"是官方的規則，比較嚴格，不需要這么嚴格的可以把這句注釋掉添加自己的規則：
module.exports = { "env": { "browser": true, "es6": true }, // "extends": "eslint:recommended", "globals": { "Atomics": "readonly", "SharedArrayBuffer": "readonly" }, "parserOptions": { "ecmaVersion": 2018 }, "rules": { "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"]//禁止尤達條件 } };
3.使用 eslint 命令檢查代碼
-
檢查某個文件
eslint ./xxx.js -
檢查某個目錄
eslint ./src
4.最后，可以吧package.json中的script進行修改
"scripts": { "test": "eslint ./*.js" },
這樣以后直接npm run test也可以進行檢查了
5.步驟2中rules規則的錯誤等級有三種：
0或’off’：關閉規則。
1或’warn’：打開規則，並且作為一個警告（並不會導致檢查不通過）。
2或’error’：打開規則，並且作為一個錯誤 (退出碼為1，檢查不通過)。
參數說明：
參數1 ： 錯誤等級
參數2 ： 處理方式
詳情見官網：Rules
6.將某些文件不進行eslint檢查
打開eslint的忽略文件.eslintignore
不想校驗什么文件，就寫進去。
假如不想校驗所有的js文件，寫上*.js就可以了。
7.使用共享的配置文件
如果每一個項目都要這樣寫到.eslintrc.js文件上，管理起來會比較麻煩。我們可以將定義好規則的.eslintrc.js文件存儲到一個公共的位置，比如public-eslintrc.js：
module.exports = { extends: 'eslint:recommended', env: { node: true, }, rules: { 'no-console': 'off', 'indent': [ 'error', 2 ], 'quotes': [ 'error', 'single' ], }, };
然后將原來的.eslintrc.js文件改成這樣：
module.exports = { extends: './public-eslintrc.js', };
還可以使用已經發布到 NPM 上的 ESLint 配置，這些配置的模塊名一般以eslint-config-為前綴，比如我在學習 ESLint 時自己編寫的一個配置名為eslint-config-lei。要使用這個配置，先執行以下命令安裝它：
npm install -g eslint-config-lei
然后將.eslintrc.js文件改成這樣：
module.exports = { extends: 'lei', };
8.代碼格式化
在ESLint 規則列表頁面，我們發現有些規則的旁邊會帶有一個橙色扳手圖標，表示在執行eslint命令時指定--fix參數可以自動修復該問題。執行檢查時添加--fix參數：
eslint ./*.js --fix
9.發布自己的配置
原理就是在載入模塊時輸出原來.eslintrc.js的數據。比如我們可以創建一個模塊eslint-config-my用於測試。
新建文件eslint-config-my/index.js：
module.exports = { extends: 'eslint:recommended', env: { node: true, es6: true, }, rules: { 'no-console': 'off', 'indent': [ 'error', 2 ], 'quotes': [ 'error', 'single' ], }, };
再新建文件eslint-config-my/package.json：
{ "name": "eslint-config-my", "version": "0.0.1", "main": "index.js" }
為了能讓eslint正確載入這個模塊，我們需要執行npm link將這個模塊鏈接到本地全局位置：
npm link eslint-config-my
然后將文件.eslintrc.js改成這樣：
module.exports = { extends: 'my', };
說明：在extends中，eslint-config-my可簡寫為my。
如果我們使用npm publish將其發布到 NPM 上，那么其他人通過npm install eslint-config-my即可使用我們共享的這個配置。Shareable Configs - 可共享的配置