eslint的安裝與使用

什么是 ESLint

ESLint（中文站點(diǎn)）是一個(gè)開(kāi)源的 JavaScript 代碼檢查工具，使用 Node.js 編寫(xiě)，由 Nicholas C. Zakas 于 2013 年 6 月創(chuàng)建。ESLint 的初衷是為了讓程序員可以創(chuàng)建自己的檢測(cè)規(guī)則，使其可以在編碼的過(guò)程中發(fā)現(xiàn)問(wèn)題而不是在執(zhí)行的過(guò)程中。ESLint 的所有規(guī)則都被設(shè)計(jì)成可插入的，為了方便使用，ESLint 內(nèi)置了一些規(guī)則，在這基礎(chǔ)上也可以增加自定義規(guī)則。

安裝 ESLint 擴(kuò)展

安裝環(huán)境

VSCode V1.11.1

Windows 10

安裝 ESLint 擴(kuò)展

首先，打開(kāi) VSCode 擴(kuò)展面板并搜索 ESLint 擴(kuò)展，然后點(diǎn)擊安裝

安裝完畢之后點(diǎn)擊重新加載以激活擴(kuò)展，但想要讓擴(kuò)展進(jìn)行工作，我們還需要先進(jìn)行 ESLint 的安裝配置。

安裝 ESLint

如果你僅僅想讓 ESLint 成為你項(xiàng)目構(gòu)建系統(tǒng)的一部分，我們可以在項(xiàng)目根目錄進(jìn)行本地安裝：

$ npm install eslint --save-dev

如果想使 ESLint 適用于你所有的項(xiàng)目，我們建議使用全局安裝，使用全局安裝 ESLint 后，你使用的任何 ESLint 插件或可分享的配置也都必須在全局安裝。

這里我們使用全局安裝：

$ npminstall-g eslint

安裝完畢后，我們使用eslint --init命令在用戶(hù)目錄中生成一個(gè)配置文件（也可以在任何你喜歡的位置進(jìn)行生成）

我們?cè)诘谝粋€(gè)選項(xiàng)中選擇自定義代碼風(fēng)格，之后根據(jù)需要自行選擇。

設(shè)置完成后我們會(huì)得到一份文件名為.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

配置文件生成之后，我們接著可以進(jìn)行自定義修改，這里我們只粗略講解常用的配置項(xiàng)，完整的可配置項(xiàng)可訪問(wèn)官方文檔

配置環(huán)境

在上文生成的配置文件中可以使用env屬性來(lái)指定要啟用的環(huán)境，將其設(shè)置為true，以保證在進(jìn)行代碼檢測(cè)時(shí)不會(huì)把這些環(huán)境預(yù)定義的全局變量識(shí)別成未定義的變量而報(bào)錯(cuò)：

"env": {
    "browser": true,
    "commonjs": true,
    "es6": true,
    "jquery": true
}

設(shè)置語(yǔ)言選項(xiàng)

默認(rèn)情況下，ESLint 支持 ECMAScript 5 語(yǔ)法，如果你想啟用對(duì) ECMAScript 其它版本和 JSX 等的支持，ESLint 允許你使用parserOptions屬性進(jìn)行指定想要支持的 JavaScript語(yǔ)言選項(xiàng)，不過(guò)你可能需要自行安裝eslint-plugin-react等插件。

"parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module",
    "ecmaFeatures": {
        "jsx": true
    }
}

配置規(guī)則

在上文的配置文件中，"extends": "eslint:recommended"選項(xiàng)表示啟用推薦規(guī)則，在推薦規(guī)則的基礎(chǔ)上我們還可以根據(jù)需要使用rules新增自定義規(guī)則，每個(gè)規(guī)則的第一個(gè)值都是代表該規(guī)則檢測(cè)后顯示的錯(cuò)誤級(jí)別：

"off"或0- 關(guān)閉規(guī)則

"warn"或1- 將規(guī)則視為一個(gè)警告

"error"或2- 將規(guī)則視為一個(gè)錯(cuò)誤

"rules": {
    "indent": [
        "error",
        4
    ],
    "linebreak-style": [
        "error",
        "windows"
    ],
    "quotes": [
        "error",
        "single"
    ],
    "semi": [
        "error",
        "never"
    ]
}

完整的可配置規(guī)則列表可訪問(wèn)：http://eslint.cn/docs/rules/

其中帶√標(biāo)記的表示該規(guī)則為推薦規(guī)則。

設(shè)置 ESLint 擴(kuò)展

安裝并配置完成 ESLint 后，我們繼續(xù)回到 VSCode 進(jìn)行擴(kuò)展設(shè)置，依次點(diǎn)擊文件 > 首選項(xiàng) > 設(shè)置打開(kāi) VSCode 配置文件

從左側(cè)系統(tǒng)設(shè)置中可以看到，ESLint 擴(kuò)展默認(rèn)已經(jīng)啟用，我們現(xiàn)在只需在右側(cè)用戶(hù)設(shè)置中添加配置來(lái)指定我們創(chuàng)建的.eslintrc.js配置文件路徑即可啟用自定義規(guī)則檢測(cè)，ESLint 會(huì)查找并自動(dòng)讀取它們：

"eslint.options": {
    "configFile": "E:/git/github/styleguide/eslint/.eslintrc.js"
},

至此，我們已經(jīng)可以使用 ESLint 擴(kuò)展來(lái)檢測(cè)我們的 js 文件了。

讓 ESLint 支持 Vue 單文件組件

由于 ESLint 默認(rèn)只支持 js 文件的腳本檢測(cè)，如果我們需要支持類(lèi)html文件（如vue）的內(nèi)聯(lián)腳本檢測(cè)，還需要安裝eslint-plugin-html插件。

因?yàn)槲覀兪褂萌职惭b了 ESLint，所以eslint-plugin-html插件也必須進(jìn)行全局安裝：

$ npminstall-g eslint-plugin-html

安裝完成后，我們?cè)俅未蜷_(kāi)文件 > 首選項(xiàng) > 設(shè)置，在右側(cè)用戶(hù)設(shè)置中修改 ESLint 的相關(guān)配置并保存：

"eslint.options": {
    "configFile": "E:/git/github/styleguide/eslint/.eslintrc.js",
    "plugins": ["html"]
},
"eslint.validate": [
    "javascript",
    "javascriptreact",
    "html",
    "vue"
]

最后，我們打開(kāi)一個(gè)vue文件，可以發(fā)現(xiàn) ESLint 擴(kuò)展已經(jīng)正常工作了

"no-alert": 0,//禁止使用alert confirm prompt
"no-array-constructor": 2,//禁止使用數(shù)組構(gòu)造器
"no-bitwise": 0,//禁止使用按位運(yùn)算符
"no-caller": 1,//禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2,//禁止catch子句參數(shù)與外部作用域變量同名
"no-class-assign": 2,//禁止給類(lèi)賦值
"no-cond-assign": 2,//禁止在條件表達(dá)式中使用賦值語(yǔ)句
"no-console": 2,//禁止使用console
"no-const-assign": 2,//禁止修改const聲明的變量
"no-constant-condition": 2,//禁止在條件中使用常量表達(dá)式 if(true) if(1)
"no-continue": 0,//禁止使用continue
"no-control-regex": 2,//禁止在正則表達(dá)式中使用控制字符
"no-debugger": 2,//禁止使用debugger
"no-delete-var": 2,//不能對(duì)var聲明的變量使用delete操作符
"no-div-regex": 1,//不能使用看起來(lái)像除法的正則表達(dá)式/=foo/
"no-dupe-keys": 2,//在創(chuàng)建對(duì)象字面量時(shí)不允許鍵重復(fù) {a:1,a:1}
"no-dupe-args": 2,//函數(shù)參數(shù)不能重復(fù)
"no-duplicate-case": 2,//switch中的case標(biāo)簽不能重復(fù)
"no-else-return": 2,//如果if語(yǔ)句里面有return,后面不能跟else語(yǔ)句
"no-empty": 2,//塊語(yǔ)句中的內(nèi)容不能為空
"no-empty-character-class": 2,//正則表達(dá)式中的[]內(nèi)容不能為空
"no-empty-label": 2,//禁止使用空l(shuí)abel
"no-eq-null": 2,//禁止對(duì)null使用==或!=運(yùn)算符
"no-eval": 1,//禁止使用eval
"no-ex-assign": 2,//禁止給catch語(yǔ)句中的異常參數(shù)賦值
"no-extend-native": 2,//禁止擴(kuò)展native對(duì)象
"no-extra-bind": 2,//禁止不必要的函數(shù)綁定
"no-extra-boolean-cast": 2,//禁止不必要的bool轉(zhuǎn)換
"no-extra-parens": 2,//禁止非必要的括號(hào)
"no-extra-semi": 2,//禁止多余的冒號(hào)
"no-fallthrough": 1,//禁止switch穿透
"no-floating-decimal": 2,//禁止省略浮點(diǎn)數(shù)中的0 .5 3.
"no-func-assign": 2,//禁止重復(fù)的函數(shù)聲明
"no-implicit-coercion": 1,//禁止隱式轉(zhuǎn)換
"no-implied-eval": 2,//禁止使用隱式eval
"no-inline-comments": 0,//禁止行內(nèi)備注
"no-inner-declarations": [2, "functions"],//禁止在塊語(yǔ)句中使用聲明（變量或函數(shù)）
"no-invalid-regexp": 2,//禁止無(wú)效的正則表達(dá)式
"no-invalid-this": 2,//禁止無(wú)效的this，只能用在構(gòu)造器，類(lèi)，對(duì)象字面量
"no-irregular-whitespace": 2,//不能有不規(guī)則的空格
"no-iterator": 2,//禁止使用__iterator__ 屬性
"no-label-var": 2,//label名不能與var聲明的變量名相同
"no-labels": 2,//禁止標(biāo)簽聲明
"no-lone-blocks": 2,//禁止不必要的嵌套塊
"no-lonely-if": 2,//禁止else語(yǔ)句內(nèi)只有if語(yǔ)句
"no-loop-func": 1,//禁止在循環(huán)中使用函數(shù)（如果沒(méi)有引用外部變量不形成閉包就可以）
"no-mixed-requires": [0, false],//聲明時(shí)不能混用聲明類(lèi)型
"no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
"linebreak-style": [0, "windows"],//換行風(fēng)格
"no-multi-spaces": 1,//不能用多余的空格
"no-multi-str": 2,//字符串不能用換行
"no-multiple-empty-lines": [1, {"max": 2}],//空行最多不能超過(guò)2行
"no-native-reassign": 2,//不能重寫(xiě)native對(duì)象
"no-negated-in-lhs": 2,//in 操作符的左邊不能有!
"no-nested-ternary": 0,//禁止使用嵌套的三目運(yùn)算
"no-new": 1,//禁止在使用new構(gòu)造一個(gè)實(shí)例后不賦值
"no-new-func": 1,//禁止使用new Function
"no-new-object": 2,//禁止使用new Object()
"no-new-require": 2,//禁止使用new require
"no-new-wrappers": 2,//禁止使用new創(chuàng)建包裝實(shí)例，new String new Boolean new Number
"no-obj-calls": 2,//不能調(diào)用內(nèi)置的全局對(duì)象，比如Math() JSON()
"no-octal": 2,//禁止使用八進(jìn)制數(shù)字
"no-octal-escape": 2,//禁止使用八進(jìn)制轉(zhuǎn)義序列
"no-param-reassign": 2,//禁止給參數(shù)重新賦值
"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,//禁止重復(fù)聲明變量
"no-regex-spaces": 2,//禁止在正則表達(dá)式字面量中使用多個(gè)空格 /foo bar/
"no-restricted-modules": 0,//如果禁用了指定模塊，使用就會(huì)報(bào)錯(cuò)
"no-return-assign": 1,//return 語(yǔ)句中不能有賦值表達(dá)式
"no-script-url": 0,//禁止使用javascript:void(0)
"no-self-compare": 2,//不能比較自身
"no-sequences": 0,//禁止使用逗號(hào)運(yùn)算符
"no-shadow": 2,//外部作用域中的變量不能與它所包含的作用域中的變量或參數(shù)同名
"no-shadow-restricted-names": 2,//嚴(yán)格模式中規(guī)定的限制標(biāo)識(shí)符不能作為聲明時(shí)的變量名使用
"no-spaced-func": 2,//函數(shù)調(diào)用時(shí) 函數(shù)名與()之間不能有空格
"no-sparse-arrays": 2,//禁止稀疏數(shù)組， [1,,2]
"no-sync": 0,//nodejs 禁止同步方法
"no-ternary": 0,//禁止使用三目運(yùn)算符
"no-trailing-spaces": 1,//一行結(jié)束后面不要有空格
"no-this-before-super": 0,//在調(diào)用super()之前不能使用this或super
"no-throw-literal": 2,//禁止拋出字面量錯(cuò)誤 throw "error";
"no-undef": 1,//不能有未定義的變量
"no-undef-init": 2,//變量初始化時(shí)不能直接給它賦值為undefined
"no-undefined": 2,//不能使用undefined
"no-unexpected-multiline": 2,//避免多行表達(dá)式
"no-underscore-dangle": 1,//標(biāo)識(shí)符不能以_開(kāi)頭或結(jié)尾
"no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable": 2,//不能有無(wú)法執(zhí)行的代碼
"no-unused-expressions": 2,//禁止無(wú)用的表達(dá)式
"no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有聲明后未被使用的變量或參數(shù)
"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" }],//不能有警告?zhèn)渥?br />"no-with": 2,//禁用with

"array-bracket-spacing": [2, "never"],//是否允許非空數(shù)組里面有多余的空格
"arrow-parens": 0,//箭頭函數(shù)用小括號(hào)括起來(lái)
"arrow-spacing": 0,//=>的前/后括號(hào)
"accessor-pairs": 0,//在對(duì)象中使用getter/setter
"block-scoped-var": 0,//塊語(yǔ)句中使用var
"brace-style": [1, "1tbs"],//大括號(hào)風(fēng)格
"callback-return": 1,//避免多次調(diào)用回調(diào)什么的
"camelcase": 2,//強(qiáng)制駝峰法命名
"comma-dangle": [2, "never"],//對(duì)象字面量項(xiàng)尾不能有逗號(hào)
"comma-spacing": 0,//逗號(hào)前后的空格
"comma-style": [2, "last"],//逗號(hào)風(fēng)格，換行時(shí)在行首還是行尾
"complexity": [0, 11],//循環(huán)復(fù)雜度
"computed-property-spacing": [0, "never"],//是否允許計(jì)算后的鍵名什么的
"consistent-return": 0,//return 后面是否允許省略
"consistent-this": [2, "that"],//this別名
"constructor-super": 0,//非派生類(lèi)不能調(diào)用super，派生類(lèi)必須調(diào)用super
"curly": [2, "all"],//必須使用 if(){} 中的{}
"default-case": 2,//switch語(yǔ)句最后必須有default
"dot-location": 0,//對(duì)象訪問(wèn)符的位置，換行的時(shí)候在行首還是行尾
"dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括號(hào)
"eol-last": 0,//文件以單一的換行符結(jié)束
"eqeqeq": 2,//必須使用全等
"func-names": 0,//函數(shù)表達(dá)式必須有名字
"func-style": [0, "declaration"],//函數(shù)風(fēng)格，規(guī)定只能使用函數(shù)聲明/函數(shù)表達(dá)式
"generator-star-spacing": 0,//生成器函數(shù)*的前后空格
"guard-for-in": 0,//for in循環(huán)要用if語(yǔ)句過(guò)濾
"handle-callback-err": 0,//nodejs 處理錯(cuò)誤
"id-length": 0,//變量名長(zhǎng)度
"indent": [2, 4],//縮進(jìn)風(fēng)格
"init-declarations": 0,//聲明時(shí)必須賦初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }],//對(duì)象字面量中冒號(hào)的前后空格
"lines-around-comment": 0,//行前/行后備注
"max-depth": [0, 4],//嵌套塊深度
"max-len": [0, 80, 4],//字符串最大長(zhǎng)度
"max-nested-callbacks": [0, 2],//回調(diào)嵌套深度
"max-params": [0, 3],//函數(shù)最多只能有3個(gè)參數(shù)
"max-statements": [0, 10],//函數(shù)內(nèi)最多有幾個(gè)聲明
"new-cap": 2,//函數(shù)名首行大寫(xiě)必須使用new方式調(diào)用，首行小寫(xiě)必須用不帶new方式調(diào)用
"new-parens": 2,//new時(shí)必須加小括號(hào)
"newline-after-var": 2,//變量聲明后是否需要空一行
"object-curly-spacing": [0, "never"],//大括號(hào)內(nèi)是否允許不必要的空格
"object-shorthand": 0,//強(qiáng)制對(duì)象字面量縮寫(xiě)語(yǔ)法
"one-var": 1,//連續(xù)聲明
"operator-assignment": [0, "always"],//賦值運(yùn)算符 += -=什么的
"operator-linebreak": [2, "after"],//換行時(shí)運(yùn)算符在行尾還是行首
"padded-blocks": 0,//塊語(yǔ)句內(nèi)行首行尾是否要空行
"prefer-const": 0,//首選const
"prefer-spread": 0,//首選展開(kāi)運(yùn)算
"prefer-reflect": 0,//首選Reflect的方法
"quotes": [1, "single"],//引號(hào)類(lèi)型 `` "" ''
"quote-props":[2, "always"],//對(duì)象字面量中的屬性名是否強(qiáng)制雙引號(hào)
"radix": 2,//parseInt必須指定第二個(gè)參數(shù)
"id-match": 0,//命名檢測(cè)
"require-yield": 0,//生成器函數(shù)必須有yield
"semi": [2, "always"],//語(yǔ)句強(qiáng)制分號(hào)結(jié)尾
"semi-spacing": [0, {"before": false, "after": true}],//分號(hào)前后空格
"sort-vars": 0,//變量聲明時(shí)排序
"space-after-keywords": [0, "always"],//關(guān)鍵字后面是否要空一格
"space-before-blocks": [0, "always"],//不以新行開(kāi)始的塊{前面要不要有空格
"space-before-function-paren": [0, "always"],//函數(shù)定義時(shí)括號(hào)前面要不要有空格
"space-in-parens": [0, "never"],//小括號(hào)里面要不要有空格
"space-infix-ops": 0,//中綴操作符周?chē)灰锌崭?br />"space-return-throw-case": 2,//return throw case后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }],//一元運(yùn)算符的前/后要不要加空格
"spaced-comment": 0,//注釋風(fēng)格要不要有空格什么的
"strict": 2,//使用嚴(yán)格模式
"use-isnan": 2,//禁止比較時(shí)使用NaN，只能用isNaN()
"valid-jsdoc": 0,//jsdoc規(guī)則
"valid-typeof": 2,//必須使用合法的typeof的值
"vars-on-top": 2,//var必須放在作用域頂部
"wrap-iife": [2, "inside"],//立即執(zhí)行函數(shù)表達(dá)式的小括號(hào)風(fēng)格
"wrap-regex": 0,//正則表達(dá)式字面量用小括號(hào)包起來(lái)
"yoda": [2, "never"]//禁止尤達(dá)條件

支持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


}
};

擴(kuò)展：1：
　　　　　　如果有個(gè)全局變量，eslint報(bào)錯(cuò)可以用/* global var1, var2 */來(lái)消除
　　　　　　或者在eslint中定義global

　　　　　　"globals":{
　　　　　　　　"__dirname": "__dirname"
　　　　　　},
　　　　　　或者　　　　

　　　　　　/* eslint-disable */

　　　　　　let a = 12;

　　　　　　/* eslint-enable */

總結(jié)

以上是生活随笔為你收集整理的eslint的安装与使用的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。