eslint配置和rule規則解釋

前言

ESLint 是一個ECMAScript/JavaScript 語法規則和代碼風格的檢查工具，它的目標是保證代碼的一致性和避免錯誤。

藉助 ESLint，可將 靜態代碼分析 和 問題代碼協助修復 集成到 編碼、提交 和 打包 過程當中，及早發現並協助修復代碼中：

• 有語法錯誤的部分
• 不符合約定的樣式準則的部分
• 不符合約定的最佳實踐的部分

在項目開發中得到以下收益：

• 在執行代碼以前發現並修復語法錯誤，減小調試耗時和潛在 bug
• 保證項目的編碼風格統一，提升可維護性
• 督促團隊成員在編碼時遵照約定的最佳實踐，提升代碼質量

配置

配置文件中包含的相對路徑和 glob 模式都是基於當前配置文件的路徑進行解析的。

兩種主要的配置方式

• 配置註釋 - 在目標文件中使用註釋語法嵌入配置信息。這種配置只對當前文件有效。
• 配置文件 - 在 JavaScript、JSON 或 YAML 文件中定義配置信息。對於這種配置方式，配置信息能夠寫在單獨的 .eslintrc.* 文件中，或者寫在 package.json 文件的 eslintConfig 字段中。這種配置對配置文件所在目錄及其子目錄樹中的全部文件有效。

配置文件格式

• JavaScript - use .eslintrc.js 文件導出一個包含配置信息的對象。
• JSON - 使用 .eslintrc.json 定義配置信息，JSON 文件中支持 JavaScript 註釋。
• package.json - 在 package.json 文件中增長一個 eslintConfig 字段，在該字段中定義配置信息。
• .eslintrc

若是有多個配置 優先級以下：

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

配置參數

parser

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

parserOptions

指定語法分析器選項，默認使用的語法分析器支持以下幾個選項：ecmaVersion、sourceType、ecmaFeatures。示例：

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

不一樣的語法分析器可能具備不一樣的選項。

env

指定執行環境，一個執行環境會預約義一組全局變量。示例：

使用註釋配置

/* eslint-env node, mocha */

使用配置文件

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

globals

使用未在當前文件中定義的全局變量時，會命中 no-undef 規則，經過 globals 配置指定的全局變量無視 no-undef 規則。示例：

在配置文件中指定：

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

plugins

插件是第三方定製的規則集合，plugins 參數用於指定第三方插件，插件名中的 eslint-plugin- 前綴能夠省略。示例：

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

使用插件時必須安裝其 npm 包。

extends

配置文件能夠在已有配置的基礎上進行擴展，extends 用於指定基礎配置。該參數的值爲如下之一：

• 一個指定基礎配置來源的字符串
• 一個指定基礎配置來源的字符串的數組：數組中每一個配置擴展它前面的配置

ESLint 支持遞歸擴展配置，因此基礎配置中也可包含 extends 參數。

當指定基礎配置時，rules 參數指定的規則可按以下幾種方式進行擴展：

• 啓用基礎配置中沒有規則

• 繼承基礎配置中的規則，改變其錯誤級別，但不改變其附加選項：

  • 基礎配置: "eqeqeq": ["error", "allow-null"]
  • 擴展配置: "eqeqeq": "warn"
  • 最終有效配置："eqeqeq": ["warn", "allow-null"]

• 覆蓋基礎配置中的規則:

  • 基礎配置："quotes": ["error", "single", "avoid-escape"]
  • 擴展配置："quotes": ["error", "single"]
  • 最終有效配置: "quotes": ["error", "single"]

使用 extends 指定的基礎配置來源能夠是：

• eslint:recommended，啓用 ESLint 內置規則集 的一個子集。

• 共享配置包，一類導出 ESLint 配置對象的 npm 包，好比 eslint-config-standard、eslint-config-airbnb 等。共享配置包須要安裝才能使用，配置時可省略報名中的 eslint-config- 前綴。

  示例：

  {
    "extends": ["airbnb"]
    "rules": {
      "no-set-state": "off"
    }
  }
  複製代碼

• 插件導出的命名配置，其配置值由如下幾部分組成：

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

示例：

{
  "plugins": [
    "react"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended"
  ],
  "rules": {
    "no-set-state": "off"
  }
}
複製代碼

• 配置文件，經過配置文件的絕對路徑或相對路徑指定。

  示例：

  {
    "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"
    }
  }
  複製代碼

• eslint:all，啓動全部 ESLint 內置規則，不推薦。

規則

ESLint 附帶有大量的規則。你能夠使用註釋或配置文件修改你項目中要使用哪些規則。改變一個規則設置，你必須設置規則 ID 等於這些值之一：

• "off"或0 -關閉規則
• "warn" 或1 - 開啓規則, 使用警告 程序不會退出
• "error"或2 - 開啓規則, 使用錯誤 程序退出

rule解釋

"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": 0,//不能用多餘的空格
"no-multi-str": 2,//字符串不能用\換行
"no-multiple-empty-lines": [1, {"max": 3}],//空行最多不能超過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": 2,//不能有未定義的變量
"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": 0,//必須使用全等
"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, 2],//縮進風格
"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"]//禁止尤達條件