eslint配置及rule解釋

前言

ESLint 是一個(gè)ECMAScript/JavaScript 語(yǔ)法規(guī)則和代碼風(fēng)格的檢查工具，它的目標(biāo)是保證代碼的一致性和避免錯(cuò)誤。

借助 ESLint，可將 靜態(tài)代碼分析 和 問(wèn)題代碼協(xié)助修復(fù) 集成到 編碼、提交 和 打包 過(guò)程中，及早發(fā)現(xiàn)并協(xié)助修復(fù)代碼中：

  • 有語(yǔ)法錯(cuò)誤的部分
  • 不符合約定的樣式準(zhǔn)則的部分
  • 不符合約定的最佳實(shí)踐的部分

在項(xiàng)目開(kāi)發(fā)中獲得如下收益：

  • 在執(zhí)行代碼之前發(fā)現(xiàn)并修復(fù)語(yǔ)法錯(cuò)誤，減少調(diào)試耗時(shí)和潛在 bug
  • 保證項(xiàng)目的編碼風(fēng)格統(tǒng)一，提高可維護(hù)性
  • 督促團(tuán)隊(duì)成員在編碼時(shí)遵守約定的最佳實(shí)踐，提高代碼質(zhì)量

配置

配置文件中包含的相對(duì)路徑和 glob 模式都是基于當(dāng)前配置文件的路徑進(jìn)行解析的。

兩種主要的配置方式

  • 配置注釋 - 在目標(biāo)文件中使用注釋語(yǔ)法嵌入配置信息。這種配置只對(duì)當(dāng)前文件有效。
  • 配置文件 - 在 JavaScript、JSON 或 YAML 文件中定義配置信息。對(duì)于這種配置方式，配置信息可以寫在單獨(dú)的 .eslintrc.* 文件中，或者寫在 package.json 文件的 eslintConfig 字段中。這種配置對(duì)配置文件所在目錄及其子目錄樹(shù)中的所有文件有效。

配置文件格式

  • JavaScript - use .eslintrc.js 文件導(dǎo)出一個(gè)包含配置信息的對(duì)象。
  • JSON - 使用 .eslintrc.json 定義配置信息，JSON 文件中支持 JavaScript 注釋。
  • package.json - 在 package.json 文件中增加一個(gè) eslintConfig 字段，在該字段中定義配置信息。
  • .eslintrc

如果有多個(gè)配置 優(yōu)先級(jí)如下：

  1. .eslintrc.js
  2. .eslintrc.json
  3. .eslintrc
  4. package.json

配置參數(shù)

parser

指定 ESLint 使用的語(yǔ)法分析器。ESLint 兼容的語(yǔ)法分析器有：Esprima、Babel-ESLint、@typescript-eslint/parser，ESLint 默認(rèn)使用 Esprima。

parserOptions

指定語(yǔ)法分析器選項(xiàng)，默認(rèn)使用的語(yǔ)法分析器支持如下幾個(gè)選項(xiàng)：ecmaVersion、sourceType、ecmaFeatures。示例：

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

不同的語(yǔ)法分析器可能具有不同的選項(xiàng)。

env

指定執(zhí)行環(huán)境，一個(gè)執(zhí)行環(huán)境會(huì)預(yù)定義一組全局變量。示例：

使用注釋配置

/* eslint-env node, mocha */

使用配置文件

{
  "env": {
    "browser": true,
    "node": true
  }
}

globals

使用未在當(dāng)前文件中定義的全局變量時(shí)，會(huì)命中 no-undef 規(guī)則，通過(guò) globals 配置指定的全局變量無(wú)視 no-undef 規(guī)則。示例：

在配置文件中指定：

{
  "globals": {
    "var1": "writable",
    "var2": "readonly"
  }
}

plugins

插件是第三方定制的規(guī)則集合，plugins 參數(shù)用于指定第三方插件，插件名中的 eslint-plugin- 前綴可以省略。示例：

{
    plugins: [
        'typescript',
        '@typescript-eslint',
        "prettier"
    ]
}

使用插件時(shí)必須安裝其 npm 包。

extends

配置文件可以在已有配置的基礎(chǔ)上進(jìn)行擴(kuò)展，extends 用于指定基礎(chǔ)配置。該參數(shù)的值為以下之一：

  • 一個(gè)指定基礎(chǔ)配置來(lái)源的字符串
  • 一個(gè)指定基礎(chǔ)配置來(lái)源的字符串的數(shù)組：數(shù)組中每個(gè)配置擴(kuò)展它前面的配置

ESLint 支持遞歸擴(kuò)展配置，所以基礎(chǔ)配置中也可包含 extends 參數(shù)。

當(dāng)指定基礎(chǔ)配置時(shí)，rules 參數(shù)指定的規(guī)則可按如下幾種方式進(jìn)行擴(kuò)展：

  • 啟用基礎(chǔ)配置中沒(méi)有規(guī)則
  • 繼承基礎(chǔ)配置中的規(guī)則，改變其錯(cuò)誤級(jí)別，但不改變其附加選項(xiàng)：
    • 基礎(chǔ)配置: "eqeqeq": ["error", "allow-null"]
    • 擴(kuò)展配置: "eqeqeq": "warn"
    • 最終有效配置："eqeqeq": ["warn", "allow-null"]
  • 覆蓋基礎(chǔ)配置中的規(guī)則:
    • 基礎(chǔ)配置："quotes": ["error", "single", "avoid-escape"]
    • 擴(kuò)展配置："quotes": ["error", "single"]
    • 最終有效配置: "quotes": ["error", "single"]

使用 extends 指定的基礎(chǔ)配置來(lái)源可以是：

  • eslint:recommended，啟用 ESLint 內(nèi)置規(guī)則集 的一個(gè)子集。

  • 共享配置包，一類導(dǎo)出 ESLint 配置對(duì)象的 npm 包，比如 eslint-config-standard、eslint-config-airbnb 等。共享配置包需要安裝才能使用，配置時(shí)可省略報(bào)名中的 eslint-config- 前綴。

    示例：

    {
  "extends": ["airbnb"]
  "rules": {
    "no-set-state": "off"
  }
}
復(fù)制代碼

  • 插件導(dǎo)出的命名配置，其配置值由以下幾部分組成：

    • plugin:
    • 插件包名（可省略前綴，例如：react）
    • /
    • 配置名（例如：recommended）

    示例：

    {
  "plugins": [
    "react"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended"
  ],
  "rules": {
    "no-set-state": "off"
  }
}
復(fù)制代碼

  • 配置文件，通過(guò)配置文件的絕對(duì)路徑或相對(duì)路徑指定。

    示例：

    {
  "extends": [
    "./node_modules/coding-standard/eslintDefaults.js",
    "./node_modules/coding-standard/.eslintrc-es6",
    "./node_modules/coding-standard/.eslintrc-jsx",
    "./my-eslint-config.js"
  ],
  "rules": {
    "eqeqeq": "warn"
  }
}
復(fù)制代碼

  • eslint:all，啟動(dòng)所有 ESLint 內(nèi)置規(guī)則，不推薦。

規(guī)則

ESLint 附帶有大量的規(guī)則。你可以使用注釋或配置文件修改你項(xiàng)目中要使用哪些規(guī)則。改變一個(gè)規(guī)則設(shè)置，你必須設(shè)置規(guī)則 ID 等于這些值之一：

  • "off"或0 -關(guān)閉規(guī)則
  • "warn" 或1 - 開(kāi)啟規(guī)則, 使用警告 程序不會(huì)退出
  • "error"或2 - 開(kāi)啟規(guī)則, 使用錯(cuò)誤 程序退出

rule解釋

"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,//禁止給類賦值
"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)造器，類，對(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í)不能混用聲明類型
"no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
"linebreak-style": [0, "windows"],//換行風(fēng)格
"no-multi-spaces": 0,//不能用多余的空格
"no-multi-str": 2,//字符串不能用\換行
"no-multiple-empty-lines": [1, {"max": 3}],//空行最多不能超過(guò)2行
"no-native-reassign": 2,//不能重寫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": 2,//不能有未定義的變量
"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)渥?"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,//非派生類不能調(diào)用super，派生類必須調(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": 0,//必須使用全等
"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, 2],//縮進(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ù)名首行大寫必須使用new方式調(diào)用，首行小寫必須用不帶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ì)象字面量縮寫語(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)類型 `` "" ''
"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,//中綴操作符周圍要不要有空格
"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á)條件
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • ESLint 配置 ESlint 被設(shè)計(jì)為完全可配置的，這意味著你可以關(guān)閉每一個(gè)規(guī)則而只運(yùn)行基本語(yǔ)法驗(yàn)證，或混合和...
    靜默虛空閱讀 41,834評(píng)論 3贊 14
  • 一、JSLint JSHint ESLint 參考前端工具考 - ESLint 篇JS Linter 進(jìn)化史 C ...
    合肥黑閱讀 77,231評(píng)論 0贊 47
  • EsLint入門學(xué)習(xí)整理 這兩天因?yàn)楣疽?，就?duì)ESLint進(jìn)行了初步的了解，網(wǎng)上的內(nèi)容基本上都差不多，但是內(nèi)容...
    點(diǎn)柈閱讀 26,211評(píng)論 3贊 42
  • 什么是 ESLint ESLint（中文站點(diǎn)）是一個(gè)開(kāi)源的 JavaScript 代碼檢查工具，使用 Node.j...
    小肆逸閱讀 1,549評(píng)論 0贊 3
  • 首先須將釣線穿過(guò)導(dǎo)線環(huán)，然后再系緊在線輪上。在纏線的高度應(yīng)低線輪邊緣高度約為1.5-2毫米，不要多纏或少纏，否則將...
    釣俠閱讀 814評(píng)論 0贊 0

友情鏈接更多精彩內(nèi)容