文章目录
文章参考
- https://cli.vuejs.org/zh/config/#全局配置
- https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint
- 在VUE应用中配置ESLint(代码检查)
如何关闭eslint
- 在工程根目录下创建
vue.config.js
文件 - 添加如下内容
module.exports = {
outputDir: 'dist', //build输出目录
assetsDir: 'assets', //静态资源目录(js, css, img)
lintOnSave: false, //是否开启eslint
}
lintOnSave: false
表示关闭eslint
如何向已经创建好的工程添加esLint
vue add eslint
ESLint的规则有三种级别
- "off"或者0,不启用这个规则
- "warn"或者1,出现问题会有警告
- "error"或者2,出现问题会报错
在package.json 文件eslintConfig节点配置eslint规则
{
...
"eslintConfig": {
//此项是用来告诉eslint找当前配置文件不能往父级查找
"root": true,
// 此项指定环境的全局变量,下面的配置指定为浏览器环境
"env": {
"jquery": true,
"node": true
},
// 此项是用来配置标准的js风格,就是说写代码的时候要规范的写,如果你使用vs-code我觉得应该可以避免出错
"extends": [
"plugin:vue/essential",
"@vue/standard"
],
"rules": { // eslint 规则配置
"semi": [0, "always"] // 不检测分号; 的情况
// 不需要
"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
},
//此项是用来指定javaScript语言类型和风格,sourceType用来指定js导入的方式,默认是script,
"parserOptions": {
//此项是用来指定eslint解析器的,解析器必须符合规则,babel-eslint解析器是对babel解析器的包装使其与ESLint解析
"parser": "babel-eslint"
}
},
...
}
个性化配置
代码后面不允许使用分号
- “always” (默认值)在语句结尾处需要分号
- “never” 不允许分号作为语句的末尾(不包括那些为了消除歧义以 [,(,/,+,或 - 开头的语句)
// 'semi': ['error', 'always'], // 必须在语句后面加分号
'semi': ['error', 'never'], // 必须在语句后面不加分号
字符串使用单引号或双引号
// "quotes": ["error", "double"],// 字符串使用双引号
"quotes": ["error", "single"],// 字符串使用单引号
最佳实战
如果在公司做项目的过程中,一般不会把eslint-loader配置在webpack中,一旦使用它,就会不可避免的拖慢我们的打包速度,所以,在真实项目中,不会去使用eslint-loader。
一般我们在团队合作开发的过程中,都会使用Git版本管理仓库。Git里有个钩子,在git提交代码时,对代码进行一个eslint的检测,如果代码不符合规范,则不允许代码提交到git仓库。