在vue项⽬中如何添加eslint
随着vue的越做越好,更多的开发者选择使⽤vue,本篇记录如何在vue项⽬中添加eslint。
⾸先第⼀种就是在vue项⽬创建初始时就选择了创建,随着初始化⼀起代⼊到了项⽬当中,那么要是⼀开始觉得eslint规范⼀直提⽰烦⼈没加⽽开发者多了想规范代码,如何添加呢?
⾸先第⼀步:在vue项⽬根⽬录下创建eslintrc.js,在这个⽂件⾥写⼊团队所希望的eslint规范,⽐如说下⾯的这段
// /docs/user-guide/configuring
//此项是⽤来告诉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
},
// github/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": 1, // 可以有未定义的变量
// 警告
"no-extra-boolean-cast": 1, // 不必要的bool转换
js在字符串中添加字符"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
}
}
ok,那么规范已经写好了,该如何使⽤它呢?其实也很简单可以有两种⽅法
第⼀种:才cmd中打开项⽬,⼀个⼀个插件的⽤npm install去安装
"babel-eslint": "^7.1.1", "eslint": "^3.19.0",
"eslint-friendly-formatter": "^3.0.0",
"eslint-loader": "^1.7.1",
"eslint-plugin-html": "^3.0.0",
"eslint-config-standard": "^10.2.1",
"eslint-plugin-promise": "^3.4.0",
"eslint-plugin-standard": "^3.0.1",
"eslint-plugin-import": "^2.7.0",
"eslint-plugin-node": "^5.2.0",
第⼆种:打开项⽬的package.json⽂件,在⽣产环境下添加上⾯的⼏个插件名称直接复制粘贴进去就可以了,看下图
要注意的是"eslint-plugin-html": "^3.0.0", 这个东西我们要选择3.0.0版本的。
好了,该加的我们都加进去了,那么剩最后⼀步,如何让代码去执⾏这个eslint的规范呢?这个时候我们在项⽬⽂件中到build⽂件夹,在build⽂件夹下⾯到fig.js,在rules中添加规则,在最后加⼊
{
test: /\.(js|vue)$/,
loader: 'eslint-loader',
enforce: 'pre',
include: [resolve('src'), resolve('test')],
options: {
formatter: require('eslint-friendly-formatter')
}
就已经完成了,那么剩下最后⼀步别忘了,重新npm启动项⽬前我们要执⾏⼀次npm install来完成pakeage.json添加的插件安装,好了,到这⼀步就已经完成了。相信执⾏完很多同学的项⽬是打不开的,因为太多代码不符合规范了,那么你也就只能⼀个个去修改啦。
不过在这⾥提供⼀个更⾼效⽅便的⽅法,就是使⽤vscode⾃动校准eslint语法,具体⽅式在上⼀篇⽂章,。
好了,⼤家⼀起开⼼的写bug吧。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论