eslintrc.js最详细的介绍以及分享自用版本
前言：
不管我们愿意不愿意，在项目中，我们是大概率要用到eslint的规范的，这里再分享下我们自己制定eslint的规则规律
目录：
自用版本： .eslintrc.js
参数详细介绍：（较长，是从别的地方找到的资源，有兴趣的小伙伴可以研究）
自用版本： .eslintrc.js
module.exports = {
root: true,
parserOptions: {
parser: 'babel-eslint',
sourceType: 'module'
},
env: {
browser: true,
node: true,
es6: true,
},
// extends: ["plugin:vue/essential"],
extends: ['plugin:vue/recommended', 'eslint:recommended'],
// add your custom rules here
//it is base on https://github.com/vuejs/eslint-config-vue
rules: {
"vue/max-attributes-per-line": [2, {
"singleline": 4,
"multiline": {
"max": 1,
"allowFirstLine": false
}
}], // 多个特性的元素应该分多行撰写，每个特性一行
"vue/html-self-closing": ["error", {
"html": {
"void": "any",
"normal": "any",
"component": "any"
},
"svg": "any",
"math": "any"
}],
"vue/prop-name-casing": ["error", "camelCase"],// prop名大小写：在声明 prop 的时候，其命名应该始终使用 camelCase、
"vue/name-property-casing": ["error", "PascalCase"], // JS/JSX 中的组件名应该始终是 PascalCase 的
"vue/require-prop-types": "error", // props定义尽量详细
"vue/require-v-for-key": "error", // v-for设置键值，与key结合使用
"vue/no-use-v-if-with-v-for": ["error", {
"allowUsingIterationVar": false
}], //不要把 v-if 和 v-for 用在同一个元素上
"vue/singleline-html-element-content-newline": "off",
'vue/no-parsing-error': [2, { "invalid-first-character-of-tag-name": false }],
"vue/multiline-html-element-content-newline": "off",
"vue/html-closing-bracket-newline": [0, {
"singleline": "never",
"multiline": "always"
}],
"vue/no-side-effects-in-computed-properties": 0,
'accessor-pairs': 2, //在对象中使用getter/setter
'arrow-spacing': [2, {
'before': true,
'after': true
}], //=>的前/后括号
'block-spacing': [2, 'always'], //块是否需要空格
// if while function 后面的{必须与if在同一行，java风格。
'brace-style': [2, '1tbs', {
'allowSingleLine': true
}],
//强制驼峰法命名
'camelcase': [0, {
'properties': 'always'
}],
// 数组和对象键值对最后一个逗号， never参数：不能带末尾的逗号, always参数：必须带末尾的逗号，
// always-multiline：多行模式必须带逗号，单行模式不能带逗号
'comma-dangle': [2, 'never'],
// 控制逗号前后的空格
'comma-spacing': [2, {
'before': false,
'after': true
}],
'comma-style': [2, 'last'], // 控制逗号在行尾出现还是在行首出现
// 强制在子类构造函数中用super()调用父类构造函数，TypeScrip的编译器也会提示
'constructor-super': 2,
// 强制object.key 中 . 的位置，参数:
// property，'.'号应与属性在同一行
// object, '.' 号应与对象名在同一行
'dot-location': [2, 'property'],
'eol-last': 2, // 文件末尾强制换行
'eqeqeq': [2, 'allow-null'], // 使用 === 替代 ==
'generator-star-spacing': 0, //生成器函数*的前后空格
'handle-callback-err': 0, //nodejs 处理错误
'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方式调用，首行小写必须用不带new方式调用
'new-cap': [2, {
'newIsCap': true,
'capIsNew': false
}],
'new-parens': 2, //new时必须加小括号
'no-array-constructor': 2, //禁止使用数组构造器
'no-caller': 2, //禁止使用arguments.caller或arguments.callee
'no-console': 0, //禁止使用console
'no-class-assign': 2, //禁止给类赋值
'no-cond-assign': 2, //禁止在条件表达式中使用赋值语句
'no-const-assign': 2, //禁止修改const声明的变量
'no-control-regex': 0, //禁止在正则表达式中使用控制字符
'no-delete-var': 2, //不能对var声明的变量使用delete操作符
'no-dupe-args': 2, //函数参数不能重复
'no-dupe-class-members': 2, //不允许类中出现重复的声明
'no-dupe-keys': 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
'no-duplicate-case': 2, //switch中的case标签不能重复
'no-empty-character-class': 0, //正则表达式中的[]内容不能为空
'no-empty-pattern': 0,
'no-eval': 2, //禁止使用eval
'no-ex-assign': 2, //禁止给catch语句中的异常参数赋值
'no-extend-native': 2, //禁止扩展native对象
'no-extra-bind': 2, //禁止不必要的函数绑定
'no-extra-boolean-cast': 2, //禁止不必要的bool转换
'no-extra-parens': [2, 'functions'], //禁止非必要的括号
'no-fallthrough': 2, //禁止switch穿透
'no-floating-decimal': 2, //禁止省略浮点数中的0 .5 3.
'no-func-assign': 2, //禁止重复的函数声明
'no-implied-eval': 2, //禁止使用隐式eval
'no-inner-declarations': [2, 'functions'], //禁止在块语句中使用声明（变量或函数）
'no-invalid-regexp': 2, //禁止无效的正则表达式
'no-irregular-whitespace': 2, //不能有不规则的空格
'no-iterator': 2, //禁止使用__iterator__ 属性
'no-label-var': 2, //label名不能与var声明的变量名相同
'no-labels': [2, { //禁止标签声明
'allowLoop': false,
'allowSwitch': false
}],
'no-lone-blocks': 2, //禁止不必要的嵌套块
'no-mixed-spaces-and-tabs': 2, //禁止混用tab和空格
'no-multi-spaces': 2, //不能用多余的空格
'no-multi-str': 2, //字符串不能用\换行
'no-multiple-empty-lines': [0, {
'max': 1
}], //空行最多不能超过1行
'no-native-reassign': 2, //不能重写native对象
'no-negated-in-lhs': 2, //in 操作符的左边不能有!
'no-new-object': 2, //禁止使用new Object()
'no-new-require': 2, //禁止使用new require
'no-new-symbol': 2, //禁止使用new symbol
'no-new-wrappers': 2, //禁止使用new创建包装实例，new String new Boolean new Number
'no-obj-calls': 0, //不能调用内置的全局对象，比如Math() JSON()
'no-octal': 2, //禁止使用八进制数字
'no-octal-escape': 2, //禁止使用八进制转义序列
'no-path-concat': 2, //node中不能使用__dirname或__filename做路径拼接
'no-proto': 2, //禁止使用__proto__属性
'no-redeclare': 2, //禁止重复声明变量
'no-regex-spaces': 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
'no-return-assign': [2, 'except-parens'], //return 语句中不能有赋值表达式
'no-self-assign': 2, //自我分配
'no-self-compare': 2, //不能比较自身
'no-sequences': 2, //禁止使用逗号运算符
'no-shadow-restricted-names': 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
'no-spaced-func': 2, //函数调用时 函数名与()之间不能有空格
'no-sparse-arrays': 2, //禁止稀疏数组， [1,,2]
'no-this-before-super': 2, //在调用super()之前不能使用this或super
'no-throw-literal': 2, //禁止抛出字面量错误 throw "error";
'no-trailing-spaces': 0, //一行结束后面不要有空格
'no-undef': 2, //不能有未定义的变量
'no-undef-init': 2, //变量初始化时不能直接给它赋值为undefined
'no-unexpected-multiline': 0, //避免多行表达式
'no-unmodified-loop-condition': 0, //检查引用是否在循环中被修改
'no-unneeded-ternary': 0, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
'no-unreachable': 2, //不能有无法执行的代码
'no-unsafe-finally': 0,
'no-unused-vars': [2, {
'vars': 'all',
'args': 'none'
}], //不能有声明后未被使用的变量或参数
'no-useless-call': 2, //禁止不必要的call和apply
'no-useless-computed-key': 0, //没有必要使用带文字的计算属性
'no-useless-constructor': 2, //可以在不改变类的工作方式的情况下安全地移除的类构造函数
'no-useless-escape': 0,
'no-whitespace-before-property': 0,
'no-with': 2, //禁用with
'one-var': 0, //连续声明
'operator-linebreak': [2, 'after', {
'overrides': {
'?': 'before',
':': 'before'
}
}], //换行时运算符在行尾还是行首
'padded-blocks': 0, //块语句内行首行尾是否要空行
'quotes': [2, 'single', {
'avoidEscape': true,
'allowTemplateLiterals': true
}], //引号类型 `` "" '' 尽可能要求使用单引号 允许字符串使用单引号或双引号 允许字符串使用反引号
'semi': ['error', 'never'], // 强制不使用分号结尾
'semi-spacing': [2, {
'before': false,
'after': true
}], //分号前后空格
'space-before-blocks': [2, 'always'], //不以新行开始的块{前面要不要有空格
'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': 0, //注释风格不要有空格什么的
'template-curly-spacing': [2, 'never'],
'use-isnan': 2, //禁止比较时使用NaN，只能用isNaN()
'valid-typeof': 2, //必须使用合法的typeof的值
'wrap-iife': [2, 'any'], //立即执行函数表达式的小括号风格
'yield-star-spacing': 0,
'yoda': [2, 'never'], //禁止尤达条件
'prefer-const': 0, //首选const
'no-debugger': 0, //禁止使用debugger
'object-curly-spacing': [2, 'always', {
objectsInObjects: false
}], //大括号内是否允许不必要的空格
'array-bracket-spacing': [2, 'never'] //是否允许非空数组里面有多余的空格
}
}参数详细介绍：（较长，是从别的地方找到的资源，有兴趣的小伙伴可以研究）
/**
* 参考文档
* 【eslint英文文档】https://eslint.org/docs/user-guide/configuring
* 【eslint中文文档】http://eslint.cn/docs/rules/
*/
/**
* eslint有三种使用方式
* 【1】js代码中通过注释的方式使用
* 【2】通过webpack的eslintConfig字段设置，eslint会自动搜索项目的package.json文件中的配置
* 【3】通过配置文件的方式使用，配置文件有多种文件方式，如JavaScript、JSON 或者 YAML等
*/
/**
* 文件忽略
* 【】让eslint跳过特定文件的检测
* 【】通过当前工作目录下 「.eslintignore」 文件进行设置
* 其使用的是Glob路径书写方式，与「.gitignore」的使用方法相同
* 【】也可以在 package.json 文件中，通过 eslintIgnore 参数进行设置
*/
/**
* 文件内局部设置
* 【】eslint可以具体文件中设置特定代码的规则，常用于跳过某条语句的检测。
* 【】注销全部规则，在代码前新建一行，添加注销 /* eslint-disable *\/ 。如果没有恢复设置的语句，则下列全部代码都会跳过检测。
* 【】恢复eslint，在代码前新建一行，添加注销 /* eslint-enable *\/
* 【】指定忽略的规则，/* eslint-disable no-alert, no-console *\/
* 【】在特定行禁用，// eslint-disable-line
* 【】在下一行禁用，// eslint-disable-next-line
*/
module.exports = {
/**
* 根目录标识
* http://eslint.cn/docs/user-guide/configuring#using-configuration-files
* http://eslint.cn/docs/user-guide/configuring#configuration-cascading-and-hierarchy
* 【】标识当前配置文件为最底层的文件，无需往更上一级的文件目录中进行搜索
* 【】默认eslint的配置文件搜索方式是，从目标文件夹进行搜索，遍历内部每一个文件夹，找到配置文件并层叠使用。再跳出本项目，往祖先文件夹进行遍历
* 【】注意「~/.eslintrc」的意义，「~」是指linux上的家目录，「~/.eslintrc」是指家目录下的eslint配置文件，用于私人开发者，用于整个电脑全局约束的。这个配置通过本配置项root去设置，设置了root,eslint检测时将不会再往上搜索
* 【】eslint的生效规则是就近使用，越近的配置项优先级越高，覆盖其他配置项。如一个项目中，可以在不同文件夹中都添加配置文件，这些规则将重叠组合生效
*/
root: true, // 标识当前配置文件为eslint的根配置文件，让其停止在父级目录中继续寻找。
/**
* 解析器
* http://eslint.cn/docs/user-guide/configuring#specifying-parser
* 【】ESLint 默认使用Espree作为其解析器
* 【】解析器必须是本地安装的一个 npm 模块。即必须按照在本地的node_module中
* 【】解析器是用于解析js代码的，怎么去理解每一个表达式，有点C++中编译器的概念，会对js进行一些语法分析，语义分析什么的，才能判断语句符不符合规范。而不是通过简单的字符串对比。
* 【】解析器有很多，但兼容eslint的解析器有以下几个
* Espree：默认解析器，一个从Esprima中分离出来的解析器，做了一些优化
* Esprima：js标准解析器
* Babel-ESLint： 一个对Babel解析器的包装，babel本身也是js解析器的一种（不然怎么能转化为兼容性代码呢？首先需要进行js解析，才能转化）。如果我们的代码需要经过babel转化，则对应使用这个解析器
* typescript-eslint-parser(实验) - 一个把 TypeScript 转换为 ESTree 兼容格式的解析器
* 【】但是通常在vue项目中，并不会写在 parser 字段中，而是写在 parserOptions -> parser。具体原因在 parserOptions 一栏中介绍
*/
// parser: 'babel-eslint',
/**
* 解析器配置项
* http://eslint.cn/docs/user-guide/configuring#specifying-parser-options
* 【】这里设置的配置项将会传递到解析器中，被解析器获取到，进行一定的处理。具体被利用到，要看解析器的源码有没有对其进行利用。这里仅仅做了参数定义，做了规定，告诉解析器的开发者可能有这些参数
* 【】配置项目有：
* "sourceType": "module", // 指定JS代码来源的类型，script(script标签引入？) | module（es6的module模块），默认为script。为什么vue的会使用script呢？因为vue是通过babel-loader编译的，而babel编译后的代码就是script方式
* "ecmaVersion": 6, // 支持的ES语法版本，默认为5。注意只是语法，不包括ES的全局变量。全局变量需要在env选项中进行定义
* "ecmaFeatures": { // Features是特征的意思，这里用于指定要使用其他那些语言对象
"experimentalObjectRestSpread": true, //启用对对象的扩展
"jsx": true, //启用jsx语法
"globalReturn":true, //允许return在全局使用
"impliedStrict":true //启用严格校验模式
}
*/
parserOptions: {
/**
* 这里出现 parser 的原因
* 【】首先明确一点，官方说明中，parserOptions的配置参数是不包括 parser 的
* 【】这里的写 parser 是 eslint-plugin-vue 的要求，是 eslint-plugin-vue 的自定义参数
* 【】根据官方文档，eslint-plugin-vue 插件依赖 「vue-eslint-parser」解析器。「vue-eslint-parser」解析器，只解析 .vue 中html部分的内容，不会检测