实际生产项目中ESLINT的配置

Posted 2022-02-20 yina-526

安装 ESLint 和相关插件

为了方便配置，我们选择使用 airbnb 插件（airbnb号称最严格的规范，且包括ES6+的代码规范要求，可以满足我们大部分的开发需求），安装它需要先执行下面的命令查看其依赖

npm info "[email protected]" 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 [email protected] [email protected]

配置 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 插件即可