實際生產項目中ESLINT的配置

 

安裝 ESLint 和相關插件

爲了方便配置，咱們選擇使用 airbnb 插件（airbnb號稱最嚴格的規範，且包括ES6+的代碼規範要求，能夠知足咱們大部分的開發需求），安裝它須要先執行下面的命令查看其依賴

npm info "eslint-config-airbnb-base@latest" peerDependencies

執行命令獲得結果 { eslint: '^4.19.1 || ^5.3.0', 'eslint-plugin-import': '^2.14.0' }，咱們能夠看到它依賴 eslint: '^4.19.1 || ^5.3.0' 和 eslint-plugin-import: '^2.14.0' 則在項目目錄下執行命令

npm install --save-dev eslint-config-airbnb-base eslint@5.3.0 eslint-plugin-import@2.14.0

配置 eslintrc.js 文件

.eslintrc.js 是配置文件，經過它咱們能夠控制 Eslint 的執行過程及結果，下面是我在實際項目中用過的eslintrc.js 代碼，可根據項目須要自行配置

  1 // https://eslint.org/docs/user-guide/configuring
  2 
  3 module.exports = {
  4   root: true,
  5   parserOptions: {
  6     parser: 'babel-eslint'
  7   },
  8   env: {
  9     browser: true,
 10     node: true,
 11     es6: true,
 12     mocha: true,
 13     jest: true,
 14     jasmine: true
 15   },
 16   extends: [
 17     'plugin:vue/essential',
 18     'airbnb-base'
 19   ],
 20   // required to lint *.vue files
 21   plugins: [
 22     'vue'
 23   ],
 24   // add your custom rules here
 25   rules: {
 26     'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
 27     "no-alert": 0, //禁止使用alert confirm prompt
 28     "no-array-constructor": 2, //禁止使用數組構造器
 29     "no-bitwise": 0, //禁止使用按位運算符
 30     "no-caller": 1, //禁止使用arguments.caller或arguments.callee
 31     "no-catch-shadow": 2, //禁止catch子句參數與外部做用域變量同名
 32     "no-class-assign": 2, //禁止給類賦值
 33     "no-cond-assign": 2, //禁止在條件表達式中使用賦值語句
 34     "no-console": 2, //禁止使用console2
 35     "no-const-assign": 2, //禁止修改const聲明的變量
 36     "no-constant-condition": 2, //禁止在條件中使用常量表達式 if(true) if(1)
 37     "no-continue": 0, //禁止使用continue
 38     "no-control-regex": 2, //禁止在正則表達式中使用控制字符
 39     "no-debugger": 2, //禁止使用debugger2
 40     "no-delete-var": 2, //不能對var聲明的變量使用delete操做符
 41     "no-div-regex": 1, //不能使用看起來像除法的正則表達式/=foo/
 42     "no-dupe-keys": 2, //在建立對象字面量時不容許鍵重複 {a:1,a:1}
 43     "no-dupe-args": 2, //函數參數不能重複
 44     "no-duplicate-case": 2, //switch中的case標籤不能重複
 45     "no-else-return": 2, //若是if語句裏面有return,後面不能跟else語句
 46     "no-empty": 0, //塊語句中的內容不能爲空
 47     "no-empty-character-class": 2, //正則表達式中的[]內容不能爲空
 48     "no-eq-null": 2, //禁止對null使用==或!=運算符
 49     "no-eval": 1, //禁止使用eval
 50     "no-ex-assign": 2, //禁止給catch語句中的異常參數賦值
 51     "no-extend-native": 2, //禁止擴展native對象
 52     "no-extra-bind": 2, //禁止沒必要要的函數綁定
 53     "no-extra-boolean-cast": 2, //禁止沒必要要的bool轉換
 54     "no-extra-parens": 2, //禁止非必要的括號
 55     "no-extra-semi": 2, //禁止多餘的冒號
 56     "no-fallthrough": 1, //禁止switch穿透
 57     "no-floating-decimal": 2, //禁止省略浮點數中的0 .5 3.
 58     "no-func-assign": 2, //禁止重複的函數聲明
 59     "no-implicit-coercion": 1, //禁止隱式轉換
 60     "no-implied-eval": 2, //禁止使用隱式eval
 61     "no-inline-comments": 0, //禁止行內備註
 62     "no-inner-declarations": [2, "functions"], //禁止在塊語句中使用聲明（變量或函數）
 63     "no-invalid-regexp": 2, //禁止無效的正則表達式
 64     "no-invalid-this": 2, //禁止無效的this，只能用在構造器，類，對象字面量
 65     "no-irregular-whitespace": 2, //不能有不規則的空格
 66     "no-iterator": 2, //禁止使用__iterator__ 屬性
 67     "no-label-var": 2, //label名不能與var聲明的變量名相同
 68     "no-labels": 0, //禁止標籤聲明
 69     "no-lone-blocks": 2, //禁止沒必要要的嵌套塊
 70     "no-lonely-if": 2, //禁止else語句內只有if語句
 71     "no-loop-func": 1, //禁止在循環中使用函數（若是沒有引用外部變量不造成閉包就能夠）
 72     "no-mixed-requires": [0, false], //聲明時不能混用聲明類型
 73     "no-mixed-spaces-and-tabs": [2, false], //禁止混用tab和空格
 74     "linebreak-style": [0, "windows"], //換行風格
 75     "no-multi-spaces": 0, //不能用多餘的空格
 76     "no-multi-str": 2, //字符串不能用\換行
 77     "no-multiple-empty-lines": [1, {
 78       "max": 3
 79     }], //空行最多不能超過2行
 80     "no-native-reassign": 2, //不能重寫native對象
 81     "no-negated-in-lhs": 2, //in 操做符的左邊不能有!
 82     "no-nested-ternary": 0, //禁止使用嵌套的三目運算
 83     "no-new": 1, //禁止在使用new構造一個實例後不賦值
 84     "no-new-func": 1, //禁止使用new Function
 85     "no-new-object": 2, //禁止使用new Object()
 86     "no-new-require": 2, //禁止使用new require
 87     "no-new-wrappers": 2, //禁止使用new建立包裝實例，new String new Boolean new Number
 88     "no-obj-calls": 2, //不能調用內置的全局對象，好比Math() JSON()
 89     "no-octal": 2, //禁止使用八進制數字
 90     "no-octal-escape": 2, //禁止使用八進制轉義序列
 91     "no-param-reassign": 0, //禁止給參數從新賦值
 92     "no-path-concat": 0, //node中不能使用__dirname或__filename作路徑拼接
 93     "no-plusplus": 0, //禁止使用++，--
 94     "no-process-env": 0, //禁止使用process.env
 95     "no-process-exit": 0, //禁止使用process.exit()
 96     "no-proto": 2, //禁止使用__proto__屬性
 97     "no-redeclare": 2, //禁止重複聲明變量
 98     "no-regex-spaces": 2, //禁止在正則表達式字面量中使用多個空格 /foo bar/
 99     "no-restricted-modules": 0, //若是禁用了指定模塊，使用就會報錯
100     "no-return-assign": 1, //return 語句中不能有賦值表達式
101     "no-script-url": 0, //禁止使用javascript:void(0)
102     "no-self-compare": 2, //不能比較自身
103     "no-sequences": 0, //禁止使用逗號運算符
104     "no-shadow": 2, //外部做用域中的變量不能與它所包含的做用域中的變量或參數同名
105     "no-shadow-restricted-names": 2, //嚴格模式中規定的限制標識符不能做爲聲明時的變量名使用
106     "no-spaced-func": 2, //函數調用時 函數名與()之間不能有空格
107     "no-sparse-arrays": 2, //禁止稀疏數組， [1,,2]
108     "no-sync": 0, //nodejs 禁止同步方法
109     "no-ternary": 0, //禁止使用三目運算符
110     "no-trailing-spaces": 1, //一行結束後面不要有空格
111     "no-this-before-super": 0, //在調用super()以前不能使用this或super
112     "no-throw-literal": 2, //禁止拋出字面量錯誤 throw "error";
113     "no-undef": 2, //不能有未定義的變量
114     "no-undef-init": 2, //變量初始化時不能直接給它賦值爲undefined
115     "no-undefined": 0, //不能使用undefined
116     "no-unexpected-multiline": 2, //避免多行表達式
117     "no-underscore-dangle": 1, //標識符不能以_開頭或結尾
118     "no-unneeded-ternary": 2, //禁止沒必要要的嵌套 var isYes = answer === 1 ? true : false;
119     "no-unreachable": 2, //不能有沒法執行的代碼
120     "no-unused-expressions": 2, //禁止無用的表達式
121     "no-unused-vars": [2, {
122       "vars": "all",
123       "args": "after-used"
124     }], //不能有聲明後未被使用的變量或參數
125     "no-use-before-define": 2, //未定義前不能使用
126     "no-useless-call": 2, //禁止沒必要要的call和apply
127     "no-void": 2, //禁用void操做符
128     "no-var": 0, //禁用var，用let和const代替
129     "no-warning-comments": [1, {
130       "terms": ["todo", "fixme", "xxx"],
131       "location": "start"
132     }], //不能有警告備註
133     "no-with": 2, //禁用with
134     "import/no-unresolved": 0, //導入vue組件
135     "import/extensions": 2, //導入js
136     "array-bracket-spacing": [2, "never"], //是否容許非空數組裏面有多餘的空格
137     "arrow-parens": 0, //箭頭函數用小括號括起來
138     "arrow-spacing": 0, //=>的前/後括號
139     "accessor-pairs": 0, //在對象中使用getter/setter
140     "block-scoped-var": 0, //塊語句中使用var
141     "brace-style": [1, "1tbs"], //大括號風格
142     "callback-return": 1, //避免屢次調用回調什麼的
143     "camelcase": 2, //強制駝峯法命名
144     //"comma-dangle": [2, "never"]
145     "comma-dangle": ["error", {
146       "arrays": "never",
147       "objects": "never",
148       "imports": "never",
149       "exports": "never",
150       "functions": "never"
151     }], //對象字面量項尾不能有逗號
152     "comma-spacing": 0, //逗號先後的空格
153     "comma-style": [2, "last"], //逗號風格，換行時在行首仍是行尾
154     "complexity": [0, 11], //循環複雜度
155     "computed-property-spacing": [0, "never"], //是否容許計算後的鍵名什麼的
156     "consistent-return": 0, //return 後面是否容許省略
157     "consistent-this": [2, "that"], //this別名
158     "constructor-super": 0, //非派生類不能調用super，派生類必須調用super
159     "curly": [2, "all"], //必須使用 if(){} 中的{}
160     "default-case": 2, //switch語句最後必須有default
161     "dot-location": 0, //對象訪問符的位置，換行的時候在行首仍是行尾
162     "dot-notation": [0, {
163       "allowKeywords": true
164     }], //避免沒必要要的方括號
165     "eol-last": 0, //文件以單一的換行符結束
166     "eqeqeq": 2, //必須使用全等
167     "func-names": 0, //函數表達式必須有名字
168     "func-style": [0, "declaration"], //函數風格，規定只能使用函數聲明/函數表達式
169     "generator-star-spacing": 0, //生成器函數*的先後空格
170     "guard-for-in": 0, //for in循環要用if語句過濾
171     "handle-callback-err": 0, //nodejs 處理錯誤
172     "id-length": 0, //變量名長度
173     "indent": [2, 2], //縮進風格
174     "init-declarations": 0, //聲明時必須賦初值
175     "key-spacing": [0, {
176       "beforeColon": false,
177       "afterColon": true
178     }], //對象字面量中冒號的先後空格
179     "lines-around-comment": 0, //行前/行後備注
180     "max-depth": [0, 4], //嵌套塊深度
181     "max-len": [0, 80, 4], //字符串最大長度
182     "max-nested-callbacks": [0, 2], //回調嵌套深度
183     "max-params": [0, 3], //函數最多隻能有3個參數
184     "max-statements": [0, 10], //函數內最多有幾個聲明
185     "new-cap": 2, //函數名首行大寫必須使用new方式調用，首行小寫必須用不帶new方式調用
186     "new-parens": 2, //new時必須加小括號
187     "newline-after-var": 2, //變量聲明後是否須要空一行
188     "object-curly-spacing": [0, "never"], //大括號內是否容許沒必要要的空格
189     "object-shorthand": 0, //強制對象字面量縮寫語法
190     "one-var": 1, //連續聲明
191     "operator-assignment": [0, "always"], //賦值運算符 += -=什麼的
192     "operator-linebreak": [2, "after"], //換行時運算符在行尾仍是行首
193     "padded-blocks": 0, //塊語句內行首行尾是否要空行
194     "prefer-const": 0, //首選const
195     "prefer-spread": 0, //首選展開運算
196     "prefer-reflect": 0, //首選Reflect的方法
197     "quotes": [0, "single"], //引號類型 `` "" ''
198     "quote-props": [0, "always"], //對象字面量中的屬性名是否強制雙引號
199     "radix": 2, //parseInt必須指定第二個參數
200     "id-match": 0, //命名檢測
201     "require-yield": 0, //生成器函數必須有yield
202     "semi": [0, "always"], //語句強制分號結尾
203     "semi-spacing": [0, {
204       "before": false,
205       "after": false
206     }], //分號先後空格
207     "sort-vars": 0, //變量聲明時排序
208     "space-after-keywords": [0, "always"], //關鍵字後面是否要空一格
209     "space-before-blocks": [0, "always"], //不以新行開始的塊{前面要不要有空格
210     "space-before-function-paren": [0, "always"], //函數定義時括號前面要不要有空格
211     "space-in-parens": [0, "never"], //小括號裏面要不要有空格
212     "space-infix-ops": 0, //中綴操做符周圍要不要有空格
213     "space-unary-ops": [0, {
214       "words": true,
215       "nonwords": false
216     }], //一元運算符的前/後要不要加空格
217     "spaced-comment": 0, //註釋風格要不要有空格什麼的
218     "strict": 2, //使用嚴格模式
219     "use-isnan": 2, //禁止比較時使用NaN，只能用isNaN()
220     "valid-jsdoc": 0, //jsdoc規則
221     "valid-typeof": 2, //必須使用合法的typeof的值
222     "vars-on-top": 2, //var必須放在做用域頂部
223     "wrap-iife": [2, "inside"], //當即執行函數表達式的小括號風格
224     "wrap-regex": 0, //正則表達式字面量用小括號包起來
225     "yoda": [2, "never"], //禁止尤達條件
226     "prefer-destructuring": ["error", {
227       "VariableDeclarator": {
228         "array": false,
229         "object": false
230       },
231       "AssignmentExpression": {
232         "array": false,
233         "object": false
234       }
235     }, {
236       "enforceForRenamedProperties": false
237     }],
238     "global-require": 0,
239     "import/no-dynamic-require": 0,
240     "class-methods-use-this": 0
241   }
242 }

 

IDE 配置

開發的時候使用 vscode 做爲 IDE，因此只要安裝 ESLint 插件便可

發現並無任何ESlint提示，檢查一下是否把ESLint設置成開啓狀態：

（1）下面是ESLint開啓的設置：

build文件夾下webpack.base.conf.js

const createLintingRule = () => ({
    test: /\.(js|vue)$/,
    loader: 'eslint-loader',
    enforce: 'pre',
    include: [resolve('src'), resolve('test')],
    options: {
        formatter: require('eslint-friendly-formatter'),
        emitWarning: !config.dev.showEslintErrorsInOverlay
    }
})

config文件夾下index.js

 useEslint: true,
 showEslintErrorsInOverlay: false

 開啓後仍然沒有任何報錯，原來是沒有全局安裝ESLint的緣由：

（2）下面是全局安裝ESLint:

npm install eslint -g

 完成以後重啓項目，發現vsCode中已經有了報錯提示：

可是IDE中錯誤格式代碼上沒有紅色波浪線的提示，查找緣由後發現是vsCode沒有更新的緣故，更新vsCode報錯，

緣由是我把vsCode安裝在F盤了，而安裝更新時軟件會到C:\Program Files\Microsoft VS Code這個默認的目錄下去安裝，因此會失敗。只要把F盤下的Code.exe複製一份

到C:\Program Files\Microsoft VS Code裏，就能夠成功更新了（缺點是更新貌似安裝到C盤路徑下了），更新後IDE中代碼裏就有紅波浪線錯誤提示了：

 發現代碼中有喝多波浪線錯誤提示，由於設置了"eslint.autoFixOnSave": true,因此保存的時候ESLint會自動修改爲設置的樣式，單純的格式報錯保存後就沒有波浪線報錯了。