eslint的安裝與使用

什麼是 ESLint

ESLint（中文站點）是一個開源的 JavaScript 程式碼檢查工具，使用 Node.js 編寫，由 Nicholas C. Zakas 於 2013 年 6 月建立。ESLint 的初衷是為了讓程式設計師可以建立自己的檢測規則，使其可以在編碼的過程中發現問題而不是在執行的過程中。ESLint 的所有規則都被設計成可插入的，為了方便使用，ESLint 內建了一些規則，在這基礎上也可以增加自定義規則。

安裝 ESLint 擴充套件

安裝環境

安裝 ESLint 擴充套件

首先，開啟 VSCode 擴充套件面板並搜尋 ESLint 擴充套件，然後點選安裝

安裝完畢之後點選 重新載入

 以啟用擴充套件，但想要讓擴充套件進行工作，我們還需要先進行 ESLint 的安裝配置。

安裝 ESLint

如果你僅僅想讓 ESLint 成為你專案構建系統的一部分，我們可以在專案根目錄進行本地安裝：

$ npm install eslint --save-dev

如果想使 ESLint 適用於你所有的專案，我們建議使用全域性安裝，使用全域性安裝 ESLint 後，你使用的任何 ESLint 外掛或可分享的配置也都必須在全域性安裝。

這裡我們使用全域性安裝：

$ npm install -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"
    ]
}

其中帶 √ 標記的表示該規則為推薦規則。

設定 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 外掛也必須進行全域性安裝：

$ npm install -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 */

本文摘自 

 關注2017.08.14 23:03* 字數 2174 閱讀 33887評論 3喜歡 74