Vue eslint 程式碼檢查配置

eslint配置方式

註釋配置：使用js註釋來直接嵌入ESLint配置資訊到一個檔案裡

配置檔案：使用一個js檔案，JSON或者YAML檔案來給整個目錄和它的子目錄指定配置資訊。這些配置可以寫在一個檔名為.eslintrc.*的檔案或者在package.json檔案裡的eslintConfig項裡，這兩種方式ESLint都會自動尋找然後讀取，或者你也可以在命令列裡指定一個配置檔案。

 

ESLint的規則有三種級別

"off"或者0，不啟用這個規則

"warn"或者1，出現問題會有警告

"error"或者2，出現問題會報錯

 

關閉ESLint檢測

有時候程式碼裡有些特殊情況需要我們在某一行或者某幾行關閉ESLint檢測，可以使用註釋

下面的程式碼會關閉所有規則 

/* eslint-disable */

alert('foo');

/* eslint-enable */

下面的程式碼會關閉某一行的所有規則

alert('foo'); // eslint-disable-line

// eslint-disable-next-line
alert('foo');

下面的程式碼在某一行關閉指定的規則

alert('foo'); // eslint-disable-line no-alert

// eslint-disable-next-line no-alert
alert('foo');

 

給專案配置eslintrc.js

// https://eslint.org/docs/user-guide/configuring

module.exports = {

  //此項是用來告訴eslint找當前配置檔案不能往父級查詢
  root: true,

  //此項是用來指定eslint解析器的，解析器必須符合規則，babel-eslint解析器是對babel解析器的包裝使其與ESLint解析
  parser: 'babel-eslint',

  //此項是用來指定javaScript語言型別和風格，sourceType用來指定js匯入的方式，預設是script，此處設定為module，指某塊匯入方式
  parserOptions: {
    // 設定 script(預設) 或 module，如果程式碼是在ECMASCRIPT中的模組
    sourceType: 'module',
    "ecmaVersion": 6,
    "ecmaFeatures": {
      "jsx": true
    }
  },

  // 此項指定環境的全域性變數，下面的配置指定為瀏覽器環境
  env: {
    "browser": true,
    "node": true,
    "commonjs": true,
    "es6": true,
    "amd": true
  },
  // https://github.com/standard/standard/blob/master/docs/RULES-en.md
  // 此項是用來配置標準的js風格，就是說寫程式碼的時候要規範的寫，如果你使用vs-code我覺得應該可以避免出錯
  extends: 'vue',
  // 此項是用來提供外掛的，外掛名稱省略了eslint-plugin-，下面這個配置是用來規範html的
  plugins: [
    'html',
    "flow-vars", 
    "react"
  ],
  /* 
   下面這些rules是用來設定從外掛來的規範程式碼的規則，使用必須去掉字首eslint-plugin-
    主要有如下的設定規則，可以設定字串也可以設定數字，兩者效果一致
    "off" -> 0 關閉規則
    "warn" -> 1 開啟警告規則
    "error" -> 2 開啟錯誤規則
  */
  rules: {
    // 不需要
    "space-before-function-paren": 0,  // 函式定義時括號前面要不要有空格
    "eol-last": 0,  // 檔案以單一的換行符結束
    "no-extra-semi": 0, // 可以多餘的冒號
    "semi": 0,  // 語句可以不需要分號結尾
    "eqeqeq": 0, // 必須使用全等
    "one-var": 0, // 連續宣告
    "no-undef": 0, // 可以 有未定義的變數

    // 警告
    "no-extra-boolean-cast": 1, // 不必要的bool轉換
    "no-extra-parens": 1, // 非必要的括號
    "no-empty": 1, // 塊語句中的內容不能為空
    "no-use-before-define": [1, "nofunc"], // 未定義前不能使用
    "complexity": [1, 10], // 迴圈複雜度
    "no-unused-vars": 1, // 不能有宣告後未被使用的變數或引數
    // vue
    "flow-vars/define-flow-type": 1,
    "flow-vars/use-flow-type": 1,

    // react
    "react/jsx-uses-react": 2,
    "react/jsx-uses-vars": 2,

    // 錯誤
    "comma-dangle": [2, "never"], // 物件字面量項尾不能有逗號
    "no-debugger": 2, // 禁止使用debugger
    "no-constant-condition": 2, // 禁止在條件中使用常量表示式 if(true) if(1)
    "no-dupe-args": 2, // 函式引數不能重複
    "no-dupe-keys": 2, // 在建立物件字面量時不允許鍵重複 {a:1,a:1}
    "no-duplicate-case": 2, // switch中的case標籤不能重複
    "no-empty-character-class": 2, // 正規表示式中的[]內容不能為空
    "no-invalid-regexp": 2, // 禁止無效的正規表示式
    "no-func-assign": 2, // 禁止重複的函式宣告
    "valid-typeof": 2,  // 必須使用合法的typeof的值
    "no-unreachable": 2, // 不能有無法執行的程式碼
    "no-unexpected-multiline": 2, // 避免多行表示式
    "no-sparse-arrays": 2, // 禁止稀疏陣列， [1,,2]
    "no-shadow-restricted-names": 2, // 嚴格模式中規定的限制識別符號不能作為宣告時的變數名使用
    "no-cond-assign": 2, // 禁止在條件表示式中使用賦值語句
    "no-native-reassign": 2, // 不能重寫native物件

    // 程式碼風格
    "no-else-return": 1, // 如果if語句裡面有return,後面不能跟else語句
    "no-multi-spaces": 1, // 不能用多餘的空格
    "key-spacing": [1, {  // 物件字面量中冒號的前後空格
      "beforeColon": false,
      "afterColon": true
    }],
    "block-scoped-var": 2, // 塊語句中使用var
    "consistent-return": 2, // return 後面是否允許省略
    "accessor-pairs": 2, // 在物件中使用getter/setter
    "dot-location": [2, "property"], // 物件訪問符的位置，換行的時候在行首還是行尾
    "no-lone-blocks": 2, // 禁止不必要的巢狀塊
    "no-labels": 2, // 禁止標籤宣告
    "no-extend-native": 2, // 禁止擴充套件native物件
    "no-floating-decimal": 2, // 禁止省略浮點數中的0 .5 3.
    "no-loop-func": 2, // 禁止在迴圈中使用函式（如果沒有引用外部變數不形成閉包就可以）
    "no-new-func": 2,  // 禁止使用new Function
    "no-self-compare": 2, // 不能比較自身
    "no-sequences": 2, // 禁止使用逗號運算子
    "no-throw-literal": 2, // 禁止丟擲字面量錯誤 throw "error";
    "no-return-assign": [2, "always"], // return 語句中不能有賦值表示式
    "no-redeclare": [2, {   // 禁止重複宣告變數
      "builtinGlobals": true
    }],
    "no-unused-expressions": [2, {  // 禁止無用的表示式
      "allowShortCircuit": true,
      "allowTernary": true
    }],
    "no-useless-call": 2, // 禁止不必要的call和apply
    "no-useless-concat": 2,
    "no-void": 2, // 禁用void操作符
    "no-with": 2, // 禁用with
    "space-infix-ops": 2, // 中綴操作符周圍要不要有空格
    "valid-jsdoc": [2, { // jsdoc規則
      "requireParamDescription": true,
      "requireReturnDescription": true
    }],
    "no-warning-comments": [2, {  // 不能有警告備註
      "terms": ["todo", "fixme", "any other term"],
      "location": "anywhere"
    }],
    "curly": 1, // 必須使用 if(){} 中的{}

    // common js
    "no-duplicate-imports": 1
  }
}

 

常用規則

'rules': {
      "comma-dangle": ["error", "never"], //是否允許物件中出現結尾逗號
      "no-cond-assign": 2, //條件語句的條件中不允許出現賦值運算子
      "no-console": 2, //不允許出現console語句
      "no-constant-condition": 2, //條件語句的條件中不允許出現恆定不變的量
      "no-control-regex": 2, //正規表示式中不允許出現控制字元
      "no-debugger": 2, //不允許出現debugger語句
      "no-dupe-args": 2, //函式定義的時候不允許出現重複的引數
      "no-dupe-keys": 2, //物件中不允許出現重複的鍵
      "no-duplicate-case": 2, //switch語句中不允許出現重複的case標籤
      "no-empty": 2, //不允許出現空的程式碼塊
      "no-empty-character-class": 2, //正規表示式中不允許出現空的字元組
      "no-ex-assign": 2, //在try catch語句中不允許重新分配異常變數
      "no-extra-boolean-cast": 2, //不允許出現不必要的布林值轉換
      "no-extra-parens": 0, //不允許出現不必要的圓括號
      "no-extra-semi": 2, //不允許出現不必要的分號
      "no-func-assign": 2, //不允許重新分配函式宣告
      "no-inner-declarations": ["error", "functions"], //不允許在巢狀程式碼塊裡宣告函式
      "no-invalid-regexp": 2, //不允許在RegExp建構函式裡出現無效的正規表示式
      "no-irregular-whitespace": 2, //不允許出現不規則的空格
      "no-negated-in-lhs": 2, //不允許在in表示式語句中對最左邊的運算數使用取反操作
      "no-obj-calls": 2, //不允許把全域性物件屬性當做函式來呼叫
      "no-regex-spaces": 2, //正規表示式中不允許出現多個連續空格
      "quote-props": 2, //物件中的屬性名是否需要用引號引起來
      "no-sparse-arrays": 2, //陣列中不允許出現空位置
      "no-unreachable": 2, //在return，throw，continue，break語句後不允許出現不可能到達的語句
      "use-isnan": 2, //要求檢查NaN的時候使用isNaN()
      "valid-jsdoc": ["error", {
          "requireReturn": false,
          "requireParamDescription": false,
          "requireReturnDescription": true
      }], //強制JSDoc註釋
      "valid-typeof": ["error", {
          "requireStringLiterals": true
      }], //在使用typeof表示式比較的時候強制使用有效的字串
      "block-scoped-var": 2, //將變數宣告放在合適的程式碼塊裡
      "complexity": 0, //限制條件語句的複雜度
      "consistent-return": 2, //無論有沒有返回值都強制要求return語句返回一個值
      "curly": ["error", "all"], //強制使用花括號的風格
      "default-case": 0, //在switch語句中需要有default語句
      "dot-notation": ["error", {"allowKeywords": false, "allowPattern": ""}], //獲取物件屬性的時候使用點號
      "eqeqeq": ["error", "smart"], //比較的時候使用嚴格等於
      "no-alert": 1, //不允許使用alert，confirm，prompt語句
      "no-caller": 2, //不允許使用arguments.callee和arguments.caller屬性
      "guard-for-in": 0, //監視for in迴圈，防止出現不可預料的情況
      "no-div-regex": 2, //不能使用看起來像除法的正規表示式
      "no-else-return": 0, //如果if語句有return，else裡的return不用放在else裡
      "no-labels": ["error", {
          "allowLoop": false,
          "allowSwitch": false
      }], //不允許標籤語句
      "no-eq-null": 2, //不允許對null用==或者!=
      "no-eval": 2, //不允許使用eval()
      "no-extend-native": 2, //不允許擴充套件原生物件
      "no-extra-bind": 2, //不允許不必要的函式繫結
      "no-fallthrough": 2, //不允許switch按順序全部執行所有case
      "no-floating-decimal": 2, //不允許浮點數缺失數字
      "no-implied-eval": 2, //不允許使用隱式eval()
      "no-iterator": 2, //不允許使用__iterator__屬性
      "no-lone-blocks": 2, //不允許不必要的巢狀程式碼塊
      "no-loop-func": 2, //不允許在迴圈語句中進行函式宣告
      "no-multi-spaces": 2, //不允許出現多餘的空格
      "no-multi-str": 2, //不允許用\來讓字串換行
      "no-global-assign": 2, //不允許重新分配原生物件
      "no-new": 2, //不允許new一個例項後不賦值或者不比較
      "no-new-func": 2, //不允許使用new Function
      "no-new-wrappers": 2, //不允許使用new String，Number和Boolean物件
      "no-octal": 2, //不允許使用八進位制字面值
      "no-octal-escape": 2, //不允許使用八進位制轉義序列
      "no-param-reassign": 0, //不允許重新分配函式引數"no-proto": 2, //不允許使用__proto__屬性
      "no-redeclare": 2, //不允許變數重複宣告
      "no-return-assign": 2, //不允許在return語句中使用分配語句
      "no-script-url": 2, //不允許使用javascript:void(0)
      "no-self-compare": 2, //不允許自己和自己比較
      "no-sequences": 2, //不允許使用逗號表示式
      "no-throw-literal": 2, //不允許丟擲字面量錯誤 throw "error"
      "no-unused-expressions": 2, //不允許無用的表示式
      "no-void": 2, //不允許void操作符
      "no-warning-comments": [1, {"terms": ["todo", "fixme", "any other term"]}], //不允許警告備註
      "no-with": 2, //不允許使用with語句
      "radix": 1, //使用parseInt時強制使用基數來指定是十進位制還是其他進位制
      "vars-on-top": 0, //var必須放在作用域頂部
      "wrap-iife": [2, "any"], //立即執行表示式的括號風格
      "yoda": [2, "never", {"exceptRange": true}], //不允許在if條件中使用yoda條件
      "strict": [2, "function"], //使用嚴格模式
      "no-catch-shadow": 2, //不允許try catch語句接受的err變數與外部變數重名"no-delete-var": 2, //不允許使用delete操作符
      "no-label-var": 2, //不允許標籤和變數同名
      "no-shadow": 2, //外部作用域中的變數不能與它所包含的作用域中的變數或引數同名
      "no-shadow-restricted-names": 2, //js關鍵字和保留字不能作為函式名或者變數名
      "no-undef": 2, //不允許未宣告的變數
      "no-undef-init": 2, //不允許初始化變數時給變數賦值undefined
      "no-undefined": 2, //不允許把undefined當做識別符號使用
      "no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不允許有宣告後未使用的變數或者引數
      "no-use-before-define": [2, "nofunc"], //不允許在未定義之前就使用變數"indent": 2, //強制一致的縮排風格
      "brace-style": [2, "1tbs", { "allowSingleLine": false}], //大括號風格
      "camelcase": [2, {"properties": "never"}], //強制駝峰命名規則
      "comma-style": [2, "last"], //逗號風格
      "consistent-this": [0, "self"], //當獲取當前環境的this是用一樣的風格
      "eol-last": 2, //檔案以換行符結束
      "func-names": 0, //函式表示式必須有名字
      "func-style": 0, //函式風格，規定只能使用函式宣告或者函式表示式
      "key-spacing": [2, {"beforeColon": false, "afterColon": true}], //物件字面量中冒號的前後空格
      "max-nested-callbacks": 0, //回撥巢狀深度
      "new-cap": [2, {"newIsCap": true, "capIsNew": false}], //建構函式名字首字母要大寫
      "new-parens": 2, //new時建構函式必須有小括號
      "newline-after-var": 0, //變數宣告後必須空一行
      "no-array-constructor": 2, //不允許使用陣列構造器
      "no-inline-comments": 0, //不允許行內註釋
      "no-lonely-if": 0, //不允許else語句內只有if語句
      "no-mixed-spaces-and-tabs": [2, "smart-tabs"], //不允許混用tab和空格
      "no-multiple-empty-lines": [2, {"max": 2}], //空行最多不能超過兩行
      "no-nested-ternary": 2, //不允許使用巢狀的三目運算子
      "no-new-object": 2, //禁止使用new Object()
      "fun-call-spacing": 2, //函式呼叫時，函式名與()之間不能有空格
      "no-ternary": 0, //不允許使用三目運算子
      "no-trailing-spaces": 2, //一行最後不允許有空格
      "no-underscore-dangle": 2, //不允許識別符號以下劃線開頭
      "no-extra-parens": 0, //不允許出現多餘的括號
      "one-var": 0, //強制變數宣告放在一起
      "operator-assignment": 0, //賦值運算子的風格
      "padded-blocks": [2, "never"], //塊內行首行尾是否空行
      "quote-props": 0, //物件字面量中屬性名加引號
      "quotes": [1, "single", "avoid-escape"], //引號風格
      "semi": [2, "always"], //強制語句分號結尾
      "semi-spacing": [2, {"before": false, "after": true}], //分後前後空格
      "sort-vars": 0, //變數宣告時排序
      "space-before-blocks": [2, "always"], //塊前的空格
      "space-before-function-paren": [2, {"anonymous": "always", "named": "never"}], //函式定義時括號前的空格
      "space-infix-ops": [2, {"int32Hint": true}], //操作符周圍的空格
      "keyword-spacing": 2, //關鍵字前後的空格
      "space-unary-ops": [2, { "words": true, "nonwords": false}], //一元運算子前後不要加空格
      "wrap-regex": 2, //正規表示式字面量用括號括起來
      "no-var": 0, //使用let和const代替var
      "generator-star-spacing": [2, "both"], //生成器函式前後空格
      "max-depth": 0, //巢狀塊深度
      "max-len": 0, //一行最大長度，單位為字元
      "max-params": 0, //函式最多能有多少個引數
      "max-statements": 0, //函式內最多有幾個宣告
      "no-bitwise": 0, //不允許使用位運算子
      "no-plusplus": 0 //不允許使用++ --運算子
  }