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');

本身經常使用配置：

module.exports = {
  root: true,
  env: {
    /**
     * 規則適用
     */
    browser: true,
    node: true,
    commonjs: true,
    es6: true,
    amd: true
  },
  'extends': [
    'plugin:vue/essential',
    '@vue/standard'
  ],
  rules: {
    /**
     * 運行環境
     */
    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
    /**
     * 不須要
     */
    'indent': 0,
    'quotes': 0, // 不區分單雙引號
    'key-spacing': 0, // 冒號前不用放空格
    'semi': 0,
    'eqeqeq': 0, // 必須使用全等
    'arrow-parens': 0, // 箭頭函數有參數時不用加圓括號
    'space-before-function-paren': 0, // 函數前面不須要空格
    'one-var': 0, //容許var實現多個變量
    /**
     * 警告
     */
    '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 // 不能有聲明後未被使用的變量或參數
  },
  parserOptions: {
    parser: 'babel-eslint',
    ecmaFeatures: {
      'jsx': true
    }
  }
}

 

 

 

給項目配置eslintrc.js

在vue-cli@3.0腳手架下會自動建立eslintrc.js文件，按照如下配置：

按 Ctrl+C 複製代碼
// 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
  }
}
按 Ctrl+C 複製代碼