以vue项目为例,主要两个文件,1是.eslintrc.js文件(配置),2是.eslintignore(忽略不需要匹配的文件)
.eslintrc.js
1 // ESlint 检查配置
2 module.exports = {
3 root: true,
4 parserOptions: {
5 parser: 'babel-eslint',
6 sourceType: 'module'
7 },
8 env: {
9 browser: true,
10 node: true,
11 es6: true,
12 },
13 extends: ['plugin:vue/recommended', 'eslint:recommended'],
14
15 // add your custom rules here
16 //it is base on https://github.com/vuejs/eslint-config-vue
17 rules: {
18 "vue/max-attributes-per-line": [2, {
19 "singleline": 10,
20 "multiline": {
21 "max": 1,//最大一个
22 "allowFirstLine": false
23 }
24 }],
25 "vue/singleline-html-element-content-newline": "off",
26 "vue/multiline-html-element-content-newline":"off",
27 "vue/name-property-casing": ["error", "PascalCase"],
28 "vue/no-v-html": "off",
29 'accessor-pairs': 2,
30 'arrow-spacing': [2, {//强制箭头函前后都使用空格
31 'before': true,
32 'after': true
33 }],
34 'block-spacing': [2, 'always'],//强制括号中开头或者结尾有空格,要求使用至少一个或多个空格
35 'brace-style': [2, '1tbs', {//强制开括号在同一行
36 'allowSingleLine': true//允许开括号和闭括号在同一行,默认是false
37 }],
38 'camelcase': [0, {
39 'properties': 'always'//强制属性名称为驼峰风格
40 }],
41 // (默认) 禁用拖尾逗号,根据 ECMAScript 5(和 ECMAScript 3!)规范,对象文字中的尾随逗号是有效的。
42 // 但是,IE8(不在 IE8 文档模式下)及以下版本在遇到 JavaScript 中的尾随逗号时会抛出错误。
43 'comma-dangle': [2, 'never'],
44 'comma-spacing': [2, {//强制在逗号前后使用一致的空格
45 'before': false,//前面不要
46 'after': true//后面要
47 }],
48 'comma-style': [2, 'last'],//(默认) 要求逗号放在数组元素、对象属性或变量声明之后,且在同一行
49 'constructor-super': 2,//要求在构造函数中有 super() 的调用
50 'curly': [2, 'multi-line'],//强制所有控制语句使用一致的括号风格,允许在单行中省略大括号
51 'dot-location': [2, 'property'],//强制在点号之前和之后一致的换行
52 'eol-last': 2,//要求或禁止文件末尾存在空行,强制文件末尾不要有换行符
53 'eqeqeq': ["error", "always", {"null": "ignore"}],//要求使用 === 和 !==,不要对null使用此规则
54 'generator-star-spacing': [2, {//强制 generator 函数中 * 号周围使用一致的空格
55 'before': true,
56 'after': true
57 }],
58 'handle-callback-err': [2, '^(err|error)$'],//要求回调函数中有容错处理
59 'indent': [2, 2, {
60 'SwitchCase': 1
61 }],
62 'jsx-quotes': [2, 'prefer-single'],//强制在 JSX 属性中一致地使用双引号或单引号,强制所有不包含单引号的 JSX 属性值使用单引号。
63 'key-spacing': [2, {//强制在对象字面量的属性中键和值之间使用一致的间距
64 'beforeColon': false,
65 'afterColon': true
66 }],
67 'keyword-spacing': [2, {//强制在关键字前后使用一致的空格
68 'before': true,
69 'after': true
70 }],
71 'new-cap': [2, {//要求构造函数首字母大写
72 'newIsCap': true,// (默认) 要求调用 new 操作符时有首字母大小的函数
73 'capIsNew': false//允许调用首字母大写的函数时没有 new 操作符。
74 }],
75 'new-parens': 2,//强制或禁止调用无参构造函数时有圆括号
76 'no-array-constructor': 2,//禁用 Array 构造函数
77 //arguments.caller 和 arguments.callee 的使用使一些代码优化变得不可能。
78 // 在 JavaScript 的新版本中它们已被弃用,同时在 ECMAScript 5 的严格模式下,它们也是被禁用的
79 'no-caller': 2,
80 'no-console': 'off',//禁止调用 console 对象的方法
81 'no-class-assign': 2,//禁止修改类声明的变量
82 'no-cond-assign': 2,//禁止条件表达式中出现赋值操作符
83 'no-const-assign': 2,//禁止修改 const 声明的变量
84 'no-control-regex': 0,//禁止在正则表达式中使用控制字符
85 'no-delete-var': 2,//禁止删除变量
86 'no-dupe-args': 2,//禁止 function 定义中出现重名参数
87 'no-dupe-class-members': 2,//禁止类成员中出现重复的名称
88 'no-dupe-keys': 2,//禁止对象字面量中出现重复的 key
89 'no-duplicate-case': 2,//禁止出现重复的 case 标签
90 'no-empty-character-class': 2,//禁止在正则表达式中使用空字符集
91 'no-empty-pattern': 2,//禁止使用空解构模式
92 // 'no-eval': 2,//禁用 eval()
93 'no-ex-assign': 2,//禁止对 catch 子句的参数重新赋值
94 'no-extend-native': 2,//禁止扩展原生类型
95 'no-extra-bind': 2,//禁止不必要的 .bind() 调用
96 'no-extra-boolean-cast': 2,//禁止不必要的布尔转换
97 'no-extra-parens': [2, 'functions'],//禁止不必要的括号
98 'no-fallthrough': 2,//禁止 case 语句落空
99 'no-floating-decimal': 2,//禁止数字字面量中使用前导和末尾小数点
100 'no-func-assign': 2,//禁止对 function 声明重新赋值
101 // 'no-implied-eval': 2,//禁止使用类似 eval() 的方法
102 'no-inner-declarations': [2, 'functions'],//禁止在嵌套的块中出现变量声明或 function 声明
103 'no-invalid-regexp': 2,//禁止 RegExp 构造函数中存在无效的正则表达式字符串
104 'no-irregular-whitespace': 2,//禁止不规则的空白
105 'no-iterator': 2,//禁用 __iterator__ 属性
106 'no-label-var': 2,//不允许标签与变量同名
107 'no-labels': [2, {//禁用标签语句
108 'allowLoop': false,
109 'allowSwitch': false
110 }],
111 'no-lone-blocks': 2,//禁用不必要的嵌套块
112 'no-mixed-spaces-and-tabs': 2,//禁止空格和 tab 的混合缩进
113 'no-multi-spaces': 2,//禁止使用多个空格
114 'no-multi-str': 2,//禁止使用多行字符串
115 'no-multiple-empty-lines': [2, {//禁止出现多行空行,最大一行
116 'max': 1
117 }],
118 'no-native-reassign': 2,//不允许修改只读全局变量
119 'no-negated-in-lhs': 2,//不允许对表达式中的左操作数求反
120 'no-new-object': 2,//禁用 Object 的构造函数
121 'no-new-require': 2,//禁止调用 require 时使用 new 操作符
122 'no-new-symbol': 2,//禁止 Symbolnew 操作符和 new 一起使用
123 'no-new-wrappers': 2,//禁止对 String,Number 和 Boolean 使用 new 操作符
124 'no-obj-calls': 2,//禁止把全局对象作为函数调用
125 'no-octal': 2,//禁用八进制字面量
126 'no-octal-escape': 2,//禁止在字符串中使用八进制转义序列
127 'no-path-concat': 2,// 禁止对 __dirname 和 __filename 进行字符串连接
128 'no-proto': 2,//禁用 __proto__ 属性
129 'no-redeclare': 2,//禁止多次声明同一变量
130 'no-regex-spaces': 2,//禁止正则表达式字面量中出现多个空格
131 'no-return-assign': [2, 'except-parens'],//禁止在 return 语句中使用赋值语句
132 'no-self-assign': 2,//禁止自我赋值
133 'no-self-compare': 2,//禁止自身比较
134 'no-sequences': 2,//禁用逗号操作符
135 'no-shadow-restricted-names': 2,//禁止将标识符定义为受限的名字
136 'no-spaced-func': 2,//不允许函数标识符及其应用程序之间存在间距
137 'no-sparse-arrays': 2,//禁用稀疏数组
138 'no-this-before-super': 2,//禁止在构造函数中,在调用 super() 之前使用 this 或 super
139 'no-throw-literal': 2,//禁止抛出异常字面量
140 'no-trailing-spaces': 2,//禁用行尾空格
141 'no-undef': 2,//禁用未声明的变量,除非它们在 /*global */ 注释中被提到
142 'no-undef-init': 2,//禁止将变量初始化为 undefined
143 'no-unexpected-multiline': 2,//禁止出现令人困惑的多行表达式
144 'no-unmodified-loop-condition': 2,//禁用一成不变的循环条件
145 'no-unneeded-ternary': [2, {//禁止可以在有更简单的可替代的表达式时使用三元操作符
146 'defaultAssignment': false
147 }],
148 'no-unreachable': 2,//禁止在 return、throw、continue 和 break 语句之后出现不可达代码
149 'no-unsafe-finally': 2,//禁止在 finally 语句块中出现控制流语句
150 'no-unused-vars': [2, {//禁止出现未使用过的变量
151 'vars': 'all',
152 'args': 'none'
153 }],
154 'no-useless-call': 2,// 禁止不必要的 .call() 和 .apply()
155 'no-useless-computed-key': 2,// 禁止在对象中使用不必要的计算属性
156 'no-useless-constructor': 2,//禁用不必要的构造函数
157 'no-useless-escape': 0,//禁用不必要的转义字符
158 'no-whitespace-before-property': 2,//禁止属性前有空白
159 'no-with': 2,//禁用 with 语句
160 'one-var': [2, {//强制函数中的变量要么一起声明要么分开声明
161 'initialized': 'never'//要求每个作用域的初始化的变量有多个变量声明
162 }],
163 'operator-linebreak': [2, 'after', {//强制操作符使用一致的换行符
164 'overrides': {
165 '?': 'before',
166 ':': 'before'
167 }
168 }],
169 'padded-blocks': [2, 'never'],//要求或禁止块内填充
170 'quotes': [2, 'single', {
171 'avoidEscape': true,
172 'allowTemplateLiterals': true
173 }],
174 'semi': [2, 'never'],//要求或禁止使用分号代替 ASI
175 'semi-spacing': [2, {//强制分号之前和之后使用一致的空格
176 'before': false,
177 'after': true
178 }],
179 'space-before-blocks': [2, 'always'],//强制在块之前使用一致的空格
180 'space-before-function-paren': [2, 'never'],//强制在 function的左括号之前使用一致的空格
181 'space-in-parens': [2, 'never'],//强制在圆括号内使用一致的空格
182 'space-infix-ops': 2,// 要求操作符周围有空格
183 'space-unary-ops': [2, {//强制在一元操作符前后使用一致的空格
184 'words': true,
185 'nonwords': false
186 }],
187 'spaced-comment': [2, 'always', {//强制在注释中 // 或 /* 使用一致的空格
188 'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ',']
189 }],
190 'template-curly-spacing': [2, 'never'],//要求或禁止模板字符串中的嵌入表达式周围空格的使用
191 'use-isnan': 2,//要求使用 isNaN() 检查 NaN
192 'valid-typeof': 2,//强制 typeof 表达式与有效的字符串进行比较
193 'wrap-iife': [2, 'any'],//要求 IIFE 使用括号括起来
194 'yield-star-spacing': [2, 'both'],//强制在 yield* 表达式中 * 周围使用空格
195 'yoda': [2, 'never'],//要求或禁止 “Yoda” 条件
196 'prefer-const': 2,//要求使用 const 声明那些声明后不再被修改的变量
197 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
198 'Mixed spaces and tabs no-mixed-spaces-and-tabs': 0,//混合空格和制表符没有混合空格和制表符
199 'object-curly-spacing': [2, 'always', {//强制在花括号中使用一致的空格
200 objectsInObjects: false
201 }],
202 'array-bracket-spacing': [2, 'never']//强制数组方括号中使用一致的空格
203 }
204 }这个是.eslintignore文件
1 # 忽略build目录下类型为js的文件的语法检查
2 build/*.js
3 # 忽略src/assets目录下文件的语法检查
4 src/assets
5 # 忽略src/utils目录下文件的语法检查
6 src/utils
7 # 忽略public目录下文件的语法检查
8 public
9 # 忽略当前目录下为js的文件的语法检查
10 #*.js
11 # 忽略当前目录下为vue的文件的语法检查
12 #*.vue