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
首先查看項目中是否有?.eslintrc.js文件，如果沒有就自己新建一個?.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
? }}
進入項目的根目錄后，在命令行中 安裝如下包
npm install --save-dev babel-eslint eslint eslint-friendly-formatter eslint-loader
eslint-plugin-html eslint-config-standard eslint-plugin-promise? eslint-plugin-standard
eslint-plugin-import eslint-plugin-node eslint-plugin-flow-vars eslint-plugin-react eslint-config-vue eslint-plugin-vue
也可以直接在 package.json 中devDependencies添加如下依賴于包,注意 eslint-plugin-html不要選擇默認版本，一定要選擇3.0.0； 如： "eslint-plugin-html": "^3.0.0"
"babel-eslint": "^7.1.1",
"eslint": "^3.19.0",
"eslint-config-standard": "^10.2.1",
"eslint-friendly-formatter": "^3.0.0",
"eslint-loader": "^1.7.1",
"eslint-plugin-html": "^3.0.0",
"eslint-plugin-import": "^2.7.0",
"eslint-plugin-node": "^5.2.0",
"eslint-plugin-promise": "^3.4.0",
"eslint-plugin-standard": "^3.0.1",
"eslint-plugin-flow-vars": "^0.5.0",
"eslint-plugin-react": "^7.5.1",
"eslint-config-vue": "^2.0.2","eslint-plugin-vue": "^2.1.0",
然后在 webpack.base.conf.js 添加如下代碼：(項目是基于vue-cli中配置的,就直接是腳手架默認生成的即可)
module: {
? ? rules: [
? ? ? {
? ? ? ? test: /\.(js|vue)$/,
? ? ? ? loader: 'eslint-loader',
? ? ? ? enforce: 'pre',
? ? ? ? include: [resolve('src'), resolve('test')],
? ? ? ? options: {
? ? ? ? ? ? formatter: require('eslint-friendly-formatter')
? ? ? ? }
? ? ? },
? ? ? {
? ? ? ? test: /\.vue$/,
? ? ? ? loader: 'vue-loader',
? ? ? ? options: vueLoaderConfig
? ? ? },
? ? ? {
? ? ? ? test: /\.js$/,
? ? ? ? loader: 'babel-loader',
? ? ? ? include: [resolve('src'), resolve('test')]
? ? ? },
? ? ? {
? ? ? ? test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
? ? ? ? loader: 'url-loader',
? ? ? ? query: {
? ? ? ? ? limit: 10000,
? ? ? ? ? name: utils.assetsPath('img/[name].[ext]')
? ? ? ? }
? ? ? },? ? ? {
????????test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
? ? ? ? loader: 'url-loader',
? ? ? ? query: {
? ? ? ? ? limit: 10000,
? ? ? ? ? name: utils.assetsPath('fonts/[name].[ext]')
? ? ? ? }
? ? ? },
? ? ]
? },
最后 npm install 一下，應該就可以了，先把所有的文件關掉，重新打開一下 就可以生效了
常用規則
規則的細節請到ESLint官方網站查看http://eslint.org/docs/rules/
'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 //不允許使用++ --運算符
? }
