文章轉發自：https://blog.csdn.net/heyw886/article/details/82621612
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/