vue-cli3项⽬配置eslint代码规范
最近接⼿了⼀个项⽬,由于之前为了快速开发,没有做代码检查。为了使得代码更加规范以及更易读,所以就要eslint上场了。
安装依赖有两种⽅法:
1. 在cmd中打上把相应的依赖加到devDependencies下,再npm install对应依赖。
2. 在package.json⽂件加上相应依赖:
"eslint-plugin-html": "^6.0.3",
"@vue/cli-plugin-eslint": "^3.3.0",
"@vue/eslint-config-standard": "^4.0.0",
"eslint": "5.0.0",
"eslint-friendly-formatter": "4.0.1",
"eslint-loader": "2.0.0",
"eslint-plugin-import": "^2.20.2",
"eslint-plugin-vue": "4.7.1",
eslint的规则有三个选项:
"off"或者0,不启⽤这个规则
"warn"或者1,出现问题会有警告
"error"或者2,出现问题会报错
在根⽬录创建.eslintrc.js,代码如下:
// 默认情况下,ESLint会在所有⽗级组件中寻配置⽂件,⼀直到根⽬录。ESLint⼀旦发现配置⽂件中有  "root": true,它就会停⽌在⽗级⽬录中寻。  root: true,
parserOptions: {
// 对Babel解析器的包装使其与 ESLint 兼容。
parser: 'babel-eslint',
// 代码是 ECMAScript 模块
sourceType: 'module'
},
env: {
// 预定义的全局变量,这⾥是浏览器环境
browser: true,
node: true,
es6: true,
},
// 扩展风格
extends: ['plugin:vue/recommended', 'eslint:recommended'],
// 规则的细节请到ESLint官⽅⽹站查看/docs/rules/
rules: {
"vue/max-attributes-per-line": [2, {
"singleline": 10,
"multiline": {
"max": 1,
"allowFirstLine": false
}
}],
"vue/name-property-casing": ["error", "PascalCase"],
// 定义对象的set存取器属性时,强制定义get
'accessor-pairs': 2,
'arrow-spacing': [2, {
'before': true,
}],
// 禁⽌或强制在单⾏代码块中使⽤空格
'block-spacing': [2, 'always'],
// 强制使⽤⼀致的缩进第⼆个参数为 "tab" 时,会使⽤tab
'brace-style': [2, '1tbs', {
'allowSingleLine': true
}],
// 双峰驼命名格式
'camelcase': [0, {
'properties': 'always'
}],
//  数组和对象键值对最后⼀个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号    'comma-dangle': [2, 'never'],
// 控制逗号前后的空格
'comma-spacing': [2, {
'before': false,
'after': true
}],
// 控制逗号在⾏尾出现还是在⾏⾸出现 (默认⾏尾)
'comma-style': [2, 'last'],
// 强制在⼦类构造函数中⽤super()调⽤⽗类构造函数,TypeScrip的编译器也会提⽰
'constructor-super': 2,
// 强制所有控制语句使⽤⼀致的括号风格
'curly': [2, 'multi-line'],
// 强制object.key 中 . 的位置,参数:
// property,'.'号应与属性在同⼀⾏
// object, '.' 号应与对象名在同⼀⾏
'dot-location': [2, 'property'],
// ⽂件末尾强制换⾏
'eol-last': 2,
// 使⽤ === 替代 == allow-null允许null和undefined==
"eqeqeq": [2, "allow-null"],
/
/ 强制 generator 函数中 * 号周围使⽤⼀致的空格
'generator-star-spacing': [2, {
'before': true,
'after': true
}],
// 要求回调函数中有容错处理
'handle-callback-err': [2, '^(err|error)$'],
'indent': [2, 2, {
'SwitchCase': 1
}],
// 强制在 JSX 属性中⼀致地使⽤双引号或单引号
'jsx-quotes': [2, 'prefer-single'],
// 强制在对象字⾯量的属性中键和值之间使⽤⼀致的间距
'key-spacing': [2, {
'beforeColon': false,
'afterColon': true
}],
// 强制在关键字前后使⽤⼀致的空格
'keyword-spacing': [2, {
'before': true,
'after': true
}],
/
/ 要求构造函数⾸字母⼤写
'new-cap': [2, {
'newIsCap': true,
'capIsNew': false
}],
// 要求调⽤⽆参构造函数时有圆括号
'new-parens': 2,
// 禁⽌在没有类型检查操作符的情况下与 null 进⾏⽐较
'no-eq-null': 0,
// 禁⽌使⽤ Array 构造函数
'no-array-constructor': 2,
'no-caller': 2,
// 禁⽤ console
'no-console': 0,
// 禁⽌修改类声明的变量
'no-class-assign': 2,
// 禁⽌条件表达式中出现赋值操作符
'no-cond-assign': 2,
// 禁⽌修改 const 声明的变量
'no-const-assign': 2,
// 禁⽌在正则表达式中使⽤控制字符:new RegExp("\x1f")    'no-control-regex': 0,
// 禁⽌删除变量
'no-delete-var': 2,
// 禁⽌ function 定义中出现重名参数
'no-dupe-args': 2,
// 禁⽌类成员中出现重复的名称
'no-dupe-class-members': 2,
// 禁⽌对象字⾯量中出现重复的 key
'no-dupe-keys': 2,
// 禁⽌重复的 case 标签
'no-duplicate-case': 2,
// 禁⽌在正则表达式中使⽤空字符集 (/^abc[]/)
'no-empty-character-class': 2,
/
/ 禁⽌使⽤空解构模式no-empty-pattern
'no-empty-pattern': 2,
// 禁⽤ eval(),由于多处地⽅使⽤,暂不开启
'no-eval': 0,
// 禁⽌对 catch ⼦句的参数重新赋值
'no-ex-assign': 2,
// 禁⽌扩展原⽣类型
'no-extend-native': 2,
// 禁⽌不必要的 .bind() 调⽤
'no-extra-bind': 2,
// 禁⽌不必要的布尔转换
'no-extra-boolean-cast': 2,
// 禁⽌不必要的括号 //(a * b) + c;//报错
'no-extra-parens': [2, 'functions'],
// 禁⽌ case 语句落空
'no-fallthrough': 2,
// 禁⽌数字字⾯量中使⽤前导和末尾⼩数点
'no-floating-decimal': 2,
// 禁⽌对 function 声明重新赋值
'no-func-assign': 2,
// 禁⽌使⽤类似 eval() 的⽅法
'no-implied-eval': 2,
/
/ 禁⽌在嵌套的块中出现 function 或 var 声明
'no-inner-declarations': [2, 'functions'],
// 禁⽌ RegExp 构造函数中⽆效的正则表达式字符串
'no-invalid-regexp': 2,
// 禁⽌在字符串和注释之外不规则的空⽩
'no-irregular-whitespace': 2,
// 禁⽤ __iterator__ 属性
'no-iterator': 2,
// 不允许标签与变量同名
'no-label-var': 2,
// 禁⽤标签语句
'no-labels': [2, {
'allowLoop': false,
'allowSwitch': false
}],
// 禁⽤不必要的嵌套块
'no-lone-blocks': 2,
// 不允许空格和 tab 混合缩进
'no-mixed-spaces-and-tabs': 2,
vscode代码规范// 禁⽌使⽤多个空格
// 禁⽌使⽤多⾏字符串,在 JavaScript 中,可以在新⾏之前使⽤斜线创建多⾏字符串    'no-multi-str': 2,
// 不允许多个空⾏
'no-multiple-empty-lines': [2, {
'max': 1
}],
// 禁⽌对原⽣对象赋值
'no-native-reassign': 2,
// 禁⽌在 in 表达式中出现否定的左操作数
'no-negated-in-lhs': 2,
// 禁⽌使⽤ Object 的构造函数
'no-new-object': 2,
// 禁⽌调⽤ require 时使⽤ new 操作符
'no-new-require': 2,
/
/ 禁⽌ Symbol 的构造函数
'no-new-symbol': 2,
// 禁⽌对 String,Number 和 Boolean 使⽤ new 操作符
'no-new-wrappers': 2,
// 禁⽌把全局对象 (Math 和 JSON) 作为函数调⽤错误:var math = Math();
'no-obj-calls': 2,
// 禁⽤⼋进制字⾯量
'no-octal': 2,
// 禁⽌在字符串中使⽤⼋进制转义序列
'no-octal-escape': 2,
// 禁⽌对 __dirname 和 __filename进⾏字符串连接
'no-path-concat': 2,
// 禁⽤ __proto__ 属性
'no-proto': 2,
// 禁⽌使⽤ var 多次声明同⼀变量
'no-redeclare': 2,
// 禁⽌正则表达式字⾯量中出现多个空格
'no-regex-spaces': 2,
// 禁⽤指定的通过 require 加载的模块
'no-return-assign': [2, 'except-parens'],
// 禁⽌⾃我赋值
'no-self-assign': 2,
/
/ 禁⽌⾃⾝⽐较
'no-self-compare': 2,
// 禁⽤逗号操作符
'no-sequences': 2,
// 禁⽌覆盖受限制的标识符
'no-shadow-restricted-names': 2,
// 禁⽌ function 标识符和括号之间出现空格
'no-spaced-func': 2,
// 禁⽤稀疏数组
'no-sparse-arrays': 2,
// 禁⽌在构造函数中,在调⽤ super() 之前使⽤ this 或 super
'no-this-before-super': 2,
// 禁⽌抛出⾮异常字⾯量
'no-throw-literal': 0,
// 禁⽤⾏尾空格
'no-trailing-spaces': 2,
// 禁⽤未声明的变量,除⾮它们在 /*global */ 注释中被提到
'no-undef': 2,
// 禁⽌将变量初始化为 undefined
'no-undef-init': 2,
// 禁⽌出现令⼈困惑的多⾏表达式
'no-unexpected-multiline': 2,
/
/ 禁⽤⼀成不变的循环条件
'no-unmodified-loop-condition': 2,
// 禁⽌可以在有更简单的可替代的表达式时使⽤三元操作符
'no-unneeded-ternary': [2, {
'defaultAssignment': false
}],
// 禁⽌在return、throw、continue 和 break语句之后出现不可达代码
'no-unsafe-finally': 2,
// 禁⽌出现未使⽤过的变量
'no-unused-vars': [2, {
'vars': 'all',
'args': 'none'
}],
// 禁⽌不必要的 .call() 和 .apply()
'no-useless-call': 2,
// 禁⽌不必要的计算性能键对象的⽂字
'no-useless-computed-key': 2,
'no-useless-constructor': 2,
// 禁⽤不必要的转义字符
'no-useless-escape': 0,
// 禁⽌属性前有空⽩
'no-whitespace-before-property': 2,
/
/ 禁⽤ with 语句
'no-with': 2,
// 强制函数中的变量要么⼀起声明要么分开声明
'one-var': [2, {
'initialized': 'never'
}],
// 强制操作符使⽤⼀致的换⾏符
'operator-linebreak': [2, 'after', {
'overrides': {
'?': 'before',
':': 'before'
}
}],
// 要求或禁⽌块内填充
'padded-blocks': [2, 'never'],
// 强制使⽤⼀致的反勾号、双引号或单引号
'quotes': [2, 'single', {
'avoidEscape': true,
'allowTemplateLiterals': true
}],
// 要求或禁⽌使⽤分号⽽不是 ASI(这个才是控制⾏尾部分号的,)    'semi': [2, 'never'],
// 强制分号之前和之后使⽤⼀致的空格
'semi-spacing': [2, {
'before': false,
'after': true
}],
// 强制在块之前使⽤⼀致的空格
'space-before-blocks': [2, 'always'],
// 强制在 function的左括号之前使⽤⼀致的空格
'space-before-function-paren': [2, 'never'],
// 强制在圆括号内使⽤⼀致的空格
'space-in-parens': [2, 'never'],
// 要求操作符周围有空格
'space-infix-ops': 2,
// 强制在⼀元操作符前后使⽤⼀致的空格
'space-unary-ops': [2, {
'words': true,
'nonwords': false
}],
// 强制在注释中 // 或 /* 使⽤⼀致的空格
'spaced-comment': [2, 'always', {
'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ',']    }],
// 要求或禁⽌模板字符串中的嵌⼊表达式周围空格的使⽤
'template-curly-spacing': [2, 'never'],
/
/ 要求使⽤ isNaN() 检查 NaN
'use-isnan': 2,
// typeof foo === "undefimed" 错误
'valid-typeof': 2,