深刻浅出eslint——关于我学习eslint的心得

时间 2019-11-16

标签深刻 eslint 关于学习心得繁體版

原文原文链接

不少人在引入eslint后，发现项目中出现了不少错误提示，看着让人的强迫症都犯了，因而就放弃了使用。可小编在这却仍是要说在项目中要用到eslint，尤为是在项目一开始构建搭建的时候，就约定好，就不会再出现多人协助代码不统一，开发看着比较恶心，也减小在运行时才知道代码出现问题的状况，保证写出语法正确、风格统一的代码。最后舍弃一部分灵活性换取更高的稳定性和可维护性。

1、关于eslint

ESLint属于一种QA工具，是一个ECMAScript/JavaScript语法规则和代码风格的检查工具，能够用来保证写出语法正确、风格统一的代码。javascript

ESLint旨在彻底可配置，它的目标是提供一个插件化的javascript代码检测工具。这意味着您能够关闭每一个规则，只能使用基本语法验证，或者混合并匹配捆绑的规则和自定义规则，使ESLint完美的适用于您的项目。java

【ESlint 中文官方网站】： eslint.cn/

能够查看官网： eslint.org/

2、为何要用eslint呢？

多人参与的项目中,常常会多人交叉编辑多个文件。这就致使了各个文件中充斥着各类编码风格。最多见的就有:使用空格仍是Tab一次缩进是2个空格仍是4个空格仍是8个空格字符串使用单引号仍是双引号JavaScript一行结尾到底要不要加分号关键字先后要不要加空格等等等等不一样风格混杂在一块儿极大的影响代码的可读性与质量。不一样风格混杂在一块儿极大的影响代码的可读性与质量。所以在多人项目中维护一致的代码风格就很重要了。
JavaScript咱们知道这个语言比较灵活，除了基本的语法错误能在程序一启动的时候被检测到以外，不少隐含的错误都是在运行的时候才忽然地蹦出来。除非你的程序有着100%的测试覆盖率，不然说不定哪天就会由于一个xxx is undefined而致使程序崩溃，而为了不这样的错误可能你只须要在提交代码的时候用工具静态分析一下，仅此而已。 ESLint是一个插件化的javascript代码检测工具，它能够用于检查常见的JavaScript代码错误，也能够进行代码风格检查，这样咱们就能够根据本身的喜爱指定一套ESLint配置，而后应用到所编写的项目上，从而实现辅助编码规范的执行，有效控制项目代码的质量。那么，那如今有这么多的静态代码检测工具，咱们为何要选择Eslint呢？主要缘由是他的灵活性比较高，易于扩展，因此有很是良好的生态，而且主流的编辑器均可以集成Eslint。

3、eslint有如下几个特性？

一、全部东西都是能够插拔的。你能够调用任意的rule api或者formatter api 去打包或者定义rule or formatter。
二、任意的rule 都是独立的
三、没有特定的coding style，你能够本身配置

4、安装

要在 Node.js 上运行 ESLint，您必须安装 npm。若是 npm 未安装，请按照此处的说明进行操做：https://www.npmjs.com/ 一旦安装了 npm，运行如下内容

A、本地安装
```
npm install eslint --save-dev复制代码
```
生成配置文件 ./node_modules/.bin/eslint --init 以后,您能够运行ESLint在任何文件或目录以下: ./node_modules/.bin/eslint index.js index.js是你须要测试的js文件。你使用的任何插件或共享配置（必须安装在本地来与安装在本地的ESLint一块儿工做）。
B、全局安装若是你想让ESLint可用到全部的项目,建议全局安装ESLint。
```
npm install -g eslint 复制代码
```
C、生成配置文件初始化
```
eslint --init
复制代码
```
运行eslint –init后，会在当前目录下生成一个.eslintrc文件，你能够在这个文件中配置一些规则。以后,您能够在任何文件或目录运行ESLint
```
eslint index.js 复制代码
```
PS：eslint --init是用于每个项目设置和配置eslint,并将执行本地安装的ESLint及其插件的目录。若是你喜欢使用全局安装的ESLint，在你配置中使用的任何插件都必须是全局安装的。

5、关于eslint的配置

ESLint的设计是彻底可配置的，这意味着您能够关闭每一个规则并仅经过基本的语法验证来运行，或者将捆绑规则和自定义规则进行混合匹配，以使ESLint完美适合您的项目。

有两种主要的方法来配置ESLint：node

一、配置注释 - 使用JavaScript注释将配置信息直接嵌入到文件中。
react

二、配置文件 - 使用下面任一的文件来为所有的目录和它的子目录指定配置信息。jquery

A、javascript：使用.eslintrc.js文件并导出一个包含配置的对象。
B、YAML：.eslintrc.yaml或者.eslintrc.
C、yml JSON：.eslintrc.json，而且此文件容许使用JS形式的注释
D、废弃的用法：.eslintrc，此文件能够是JSON或者YAML
E、package.json：在package.json文件中建立eslintConfig属性，全部的配置包含在此属性中。

Ps：这些文件的优先级则是按照以上出现的顺序（.eslintrc.js > .eslintrc.yaml > .eslintrc.yml > .eslintrc.json > .eslintrc > package.json）。 webpack

从最高优先级到最低优先级的完整配置层次以下：git

一、内联配置 /*eslint-disable*/ 和 /*eslint-enable*/ /*global*/ /*eslint*/ /*eslint-env*/ es6

二、命令行选项： --global --rule --env -c, --config web

三、项目级配置： .eslintrc.*或者将package.json文件放入与linted文件相同的目录中继续搜索.eslintrc，并package.json在祖先目录中的文件（父具备最高的优先级，而后祖父母等），直至并包括根目录或直到一个配置"root": true中找到。正则表达式

在没有从（1）到（3）的任何配置的状况下，回到我的的默认配置~/.eslintrc。

Ps：*文件或文件中的eslintConfig字段的形式package.json，ESLint将自动查找和读取，也能够在命令行上指定配置文件。若是您的主目录中（一般~/）有配置文件，则ESLint 仅在ESLint找不到任何其余配置文件时才使用它。若是在同一个目录中找到.eslintrc和package.json找到一个文件，.eslintrc将会优先考虑，而且package.json不会使用文件。

有几个信息能够配置：

能够被配置的信息主要分为3类：

Environments：你的 javascript 脚步将要运行在什么环境（如：nodejs，browser，commonjs等）中。

环境 - 脚本设计运行的环境。每一个环境都带有一组预约义的全局变量。
全局变量 - 脚本在执行期间访问的其余全局变量。
规则 - 启用哪些规则以及错误级别。

全部这些选项均可以让您精确控制ESLint如何处理您的代码。

指定全局变量能够在配置文件或注释中指定额外的全局变量，false代表变量只读：注释： /* global var1, var2 */ /* global var1:false, var2:false */ JSON： { "globals": { "var1": true, "var2": false } }

6、规则

解析器选项（parserOptions）：

"parserOptions": {
"ecmaVersion": 6, //ES的版本，默认为5
"sourceType": "module", //指定源代码存在的位置，script | module，默认为script。
"ecmaFeatures": { //指定要使用其余那些语言对象
"experimentalObjectRestSpread": true,//启用对对象的扩展
"jsx": true, //启用jsx语法
"globalReturn":true, //容许return在全局使用
"impliedStrict":true //启用严格校验模式
}
}
复制代码

2. 解析器（parser） 默认状况下ESLint使用Espree解析器，这里咱们能够修改它的默认设置。

parser": "babel-eslint", 复制代码

3. 环境配置（env）默认状况下，全部环境变量都为false，且这些环境并不冲突，能够自由选择搭配。环境定义了预约义的全局变量。可用的环境是：

browser - 浏览器全局变量。
node - Node.js全局变量和Node.js范围。
commonjs - CommonJS全局变量和CommonJS范围（使用Browserify / WebPack的浏览器代码）。
shared-node-browser - Node.js和Browser的通用全局。
es6- 启用除模块外的全部ECMAScript 6功能（这会自动将ecmaVersion解析器选项设置为6）。
worker - 网络工做者全局变量。
amd- 根据amd规范定义require()和define()做为全局变量。
mocha - 增长了全部的Mocha测试全局变量。
jasmine - 为版本1.3和2.0添加了全部Jasmine测试全局变量。
jest - 是全局变量。
phantomjs - PhantomJS全局变量。
protractor - 量角器全局变量。
qunit - QUnit全局变量。
jquery - jQuery全局变量。
prototypejs - Prototype.js全局变量。
shelljs - ShellJS全局变量。
meteor - 流星全球变量。
mongo - MongoDB全局变量。
applescript - AppleScript全局变量。
nashorn - Java 8 Nashorn全局变量。
serviceworker - 服务工做者全局变量。
atomtest - Atom测试助手全局变量。
embertest - 灰烬测试帮手全局。
webextensions - 全球网络扩展。
greasemonkey - GreaseMonkey全局变量
复制代码

这些环境并不相互排斥，所以您能够一次定义多个环境。

能够在文件内部，配置文件中或使用--env命令行标志指定环境。

要在JavaScript文件中使用注释指定环境，请使用如下格式：

/* eslint-env node, mocha */复制代码

env: {
node: true,
},复制代码

在一个package.json文件中

{
    "name": "mypackage",
    "version": "0.0.1",
    "eslintConfig": {
        "env": {
            "browser": true,
            "node": true
        }
    }}复制代码

在YAML中：

---
  env:
    browser: true
    node: true
复制代码

4. 插件（plugins）

"plugins": ["standard","promise","react"],复制代码

5. 全局变量（globals） 指定全局变量的值为true|false。true表示变量能够被覆盖，false表示不容许被覆盖。

"globals": {
"document": true,
"navigator": true,
"window": true,
"think": true
},
复制代码

6. 自定义规则（settings）

"settings": {
"sharedData": "Hello"
}
复制代码

7. 禁用持续查找（root）默认状况下，ESLint将在根目录下的全部父文件夹中查找配置文件。该属性的做用是一旦发现了配置文件就中止对父文件夹的查找

"root": true
复制代码

8. 共享配置（extends）

该属性能够是

eslint命令，也能够是继承文件的路径。

eslint:all:表示引入当前版本eslint的全部核心规则。

eslint:recommended:表示引入eslint的核心功能，而且报告一些常见的共同错误。若是值为绝对或相对路径则至关于导入路径对应的规则配置。

"extends": recommended,
复制代码

"extends": "./eslint-config-public.js",
复制代码

9. 在配置文件中能够设置一些规则。

规则的错误等级有三种：

"off" 或者 0：关闭规则。
"warn" 或者 1：打开规则，而且做为一个警告（不影响exit code）。
"error" 或者 2：打开规则，而且做为一个错误（exit code将会是1）。

例子：

一、要使用配置注释配置文件内部的规则，请使用如下格式的注释：

A、 /* eslint eqeqeq: "off", curly: "error" */ 在这个例子中，eqeqeq它被关闭并curly做为错误打开。
B、您也可使用等同于规则严重性的数字：/* eslint eqeqeq: 0, curly: 2 */
C、若是规则具备其余选项，则可使用数组文字语法来指定它们，例如： /* eslint quotes: ["error", "double"], curly: 2 */

二、要在配置文件内部配置规则，请使用该rules键以及错误级别以及要使用的任何选项。

例如：

{
    "rules": {
        "eqeqeq": "off",
        "curly": "error",
        "quotes": ["error", "double"]
    }}复制代码

三、在YAML中：

---
rules:
  eqeqeq: off
  curly: error
  quotes:
    - error
    - double复制代码

要配置在插件中定义的规则，必须在规则ID前加上插件名称和a /。

例如：

{
    "plugins": [
        "plugin1"
    ],
    "rules": {
        "eqeqeq": "off",
        "curly": "error",
        "quotes": ["error", "double"],
        "plugin1/rule1": "error"
    }}
复制代码

在YAML中：

---
plugins:
  - plugin1
rules:
  eqeqeq: 0
  curly: error
  quotes:
    - error
    - "double"
  plugin1/rule1: error复制代码

注意：从插件中指定规则时，请确保省略eslint-plugin-。ESLint在内部仅使用前缀名来查找规则。

四、经过内嵌评论禁用规则

A、要临时禁用文件中的规则警告，请按如下格式使用块注释：要在整个文件中禁用规则警告，请在文件/* eslint-disable */顶部放置块注释： /* eslint-disable */ alert('foo'); /* eslint-enable */
B、要禁用特定行上的全部规则，请使用如下格式之一的行注释： alert('foo'); // eslint-disable-line // eslint-disable-next-linealert('foo');

五、使用配置文件按图解释：

一、"parserOptions"属性配置解析器内容。其中“ecmaVersion”属性配置JS的语法版本。“sourceType”属性配置JS文件加载模式，值为“script”或“module”。“ecmaFeatures”属性配置想要使用的额外语言特性。
二、“env”属性配置了预约义的全局环境。咱们当前开启了“es6”、"node"、"amd"三个环境。
三、"plugins"属性配置须要加载的第三方插件。这里咱们须要先安装对应插件才能使用。四、“globals”属性定义了全局变量集合，包含在这个集合中的属性都会被工具认为是全局变量，no-undef 规则就不会发出警告。
五、"extends"属性配置基础规则，“rules”属性中配置的规则都是基于这个规则之上配置的。
六、"rules"属性配置检查规则。

开启规则和发生错误时报告的等级

规则的错误等级有三种：

0或’off’：关闭规则。
1或’warn’：打开规则，而且做为一个警告（并不会致使检查不经过）。
2或’error’：打开规则，而且做为一个错误 (退出码为1，检查不经过)。

参数说明：

参数1 ：错误等级
参数2 ：处理方式

配置代码注释方式使用 JavaScript 注释把配置信息直接嵌入到一个文件

示例：

忽略 no-undef 检查 /* eslint-disable no-undef */
忽略 no-new 检查 /* eslint-disable no-new */
设置检查 /*eslint eqeqeq: off*/ /*eslint eqeqeq: 0*/

eslint 检查指令

检查且修复 eslint * --fix
检查指定文件 eslint app.js --fix

再次简单说明，下边会附上一些基本的配置规则，及注释。

7、基本使用案例

根据案例来一步一步看是怎么使用eslint的，以下：

在项目根目录生成package.json文件
```
npm init -y复制代码
```
安装eslint（安装方式根据我的项目须要安装，这里使用全局安装）
```
npm install -g eslint复制代码
```

建立index.js文件，里面写一个函数。

function test () {
    var ret = {};
    for (var i in arguments) {
        var m = arguments[i];
        for (var j in m) ret[j] = m[j];
    }
    return ret;
}
console.log(test({a: 123}, {b: 456})); 复制代码

输出

4. 使用eslint检查

eslint index.js复制代码

输出：

执行结果是失败，由于没有找到相应的配置文件，本案例中会用配置文件来讲明：

生成的过程当中，须要选择生成规则、支持环境等内容，下面说明一些小编的生成选项

生成的内容在.eslintrc.js文件中，

module.exports = {"env": {"browser": true},"extends": "eslint:recommended","parserOptions": {"ecmaVersion": 5},"rules": {"indent": ["error","tab"],"linebreak-style": ["error","unix"],"quotes": ["error","double"],"semi": ["error","always"]}};复制代码

这是默认生成的，留下个extends，剩下的能够本身配置文件规则，后边将附上规则说明，

module.exports = {
      "extends": "eslint:recommended"
  };复制代码

如今咱们先使用内置的eslint:recommended配置，它包含了一系列核心规则，能报告一些常见的问题。

在此执行

eslint index.js复制代码

由于eslint规则的禁用no-console规则，会出现如此的错误。

如何不出现这个错误呢？

一、将代码中的console语句删除，
二、在.eslintrc.js规则中关闭此规则，由于在开发测试中，咱们可能须要打印一些东西，测试。

module.exports = {  extends: 'eslint:recommended',  rules: {    'no-console': 'off',  },};复制代码

从新执行检查仍是提示no-undef

这是由于JavaScript有不少种运行环境，好比常见的有浏览器和Node.js，另外还有不少软件系统使用JavaScript做为其脚本引擎，好比PostgreSQL就支持使用JavaScript来编写存储引擎，而这些运行环境可能并不存在console这个对象。另外在浏览器环境下会有window对象，而Node.js下没有；在Node.js下会有process对象，而浏览器环境下没有。

因此在配置文件中咱们还须要指定程序的目标环境：

module.exports = {
  extends: 'eslint:recommended',
  env: {
    node: true,
  },
  rules: {
    'no-console': 'off',
  },};复制代码

从新执行检查时，已经没有任何提示输出了，说明index.js已经彻底经过了检查。

例外状况：

定立ESLint规则的初衷是为了不本身犯错，可是咱们也要避免不顾实际状况而将其搞得太过于形式化，本末倒置。

ESLint提供了多种临时禁用规则的方式，好比咱们能够经过一条eslint-disable-next-line备注来使得下一行能够跳过检查：

// eslint-disable-next-linevar a = 123;var b = 456;
复制代码

在上面的示例代码中，var a = 123不会受到检查，而var b = 456则又恢复检查，在上文咱们使用的eslint-config-lei的配置规则下，因为不容许使用var声明变量，则var b这一行会报告一个error。咱们还能够经过成对的eslint-enable和eslint-disable备注来禁用对某一段代码的检查，可是稍不当心少写了一个eslint-disable就可能会致使后面全部文件的检查都被禁用，因此我并不推荐使用。

8、使用共享的配置文件

ESLint支持将共享设置添加到配置文件中。咱们大多时候，我的或者团队有好几个项目，而每一个项目可能使用规则不一样，或者须要配置不一样的规则，若是都写到一个配置或者每次都改配置文件，管理起来会很麻烦。

新建一个文件好比eslint-config-public.js，在文件内容添加一两个规则。

module.exports = {
extends: 'eslint:recommended',
env: {
node: true,
},
rules: {
'no-console': 'off',
'indent': [ 'error', 4 ],
'quotes': [ 'error', 'single' ],
},
};复制代码

而后将原来的.eslintrc.js文件改为这样：

module.exports = {
  extends: './eslint-config-public.js',};
复制代码

这个要测试的是啥呢，就是看看限定缩进是4个空格和使用单引号的字符串等，而后测试下，运行eslint index.js，获得的结果是没有问题的，可是若是在index.js中的var ret = {};前面加个空格啥的，结果就立马不同了。

这时候提示第2行的是缩进应该是4个空格，而文件的第2行却发现了5个空格，说明公共配置文件eslint-config-public.js已经生效了。

9、忽略文件

咱们的整个项目中，有一些文件是不须要eslint进行检查，咱们能够用到忽略文件。

在咱们的工程目录中新建一个文件，命名为“.eslintignore”，Eslint会自动识别这个文件。

这个配置文件里面，每一行都是一个glob模式语句，具体格式以下：

以 # 开头的行被看成注释，不影响忽略模式。
路径是相对于 .eslintignore 的位置或当前工做目录。这也会影响经过 --ignore-pattern传递的路径。
忽略模式同 .gitignore 规范
以 ! 开头的行是否认模式，它将会从新包含一个以前被忽略的模式。

.eslintignore当 ESLint 在目录上运行时，ESLint 支持文件从linting 进程中排除文件。做为单独的 CLI 参数给出的文件将免除排除。该.eslintignore文件是一个纯文本文件，每行包含一个模式。它能够位于任何目标目录的祖先中; 它会影响其包含目录中的文件以及全部子目录。

如下是一个简单的.eslintignore文件示例：

node_modules/*

**/vendor/*.js

Ps：除了.eslintignore文件中的任何模式以外，ESLint始终忽略/node_modules/*和中的文件/bower_components/*

一、您能够经过提供不一样文件的路径来覆盖此行为。--ignore-path

eslint --ignore-path tmp/.eslintignore file.js
eslint --ignore-path .gitignore file.js复制代码

二、--no-ignore 禁用从文件的排除.eslintignore，--ignore-path和--ignore-pattern

eslint --no-ignore file.js复制代码

好比，你已经在忽略文件.eslintignore中忽略了某文件，可是你用在命令行中执行了 eslint 该文件，则为警告提示，您可使用--no-ignore忽略使用忽略规则。

三、在package.json中使用eslintIgnore

若是.eslintignore未找到文件而且未指定备用文件，ESLint将在package.json中查找eslintIgnore密钥以检查要忽略的文件。

{
  "name": "mypackage",
  "version": "0.0.1",
  "eslintConfig": {
      "env": {
          "browser": true,
          "node": true
      }
  },
  "eslintIgnore": ["hello.js", "world.js"]}
复制代码

10、Webpack环境中使用ESLint

一、在webpack配置中使用eslint加载器了。

loaders: [
{
test: /\.jsx?$/,
exclude: /node_modules/,
loader: 'react-hot!babel'
},
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'eslint-loader'
}
]
} 复制代码

二、也能够建立文件.eslintrc 并引入 webpack.config.js
```
eslint:{ 
configFile: './.eslintrc' 
},复制代码
```

三、使用webpack的preLoaders

module:{ 
preLoaders:[ 
{ 
test: /\.js$/, 
exclude: /node_modules/, 
loader: 'eslint-loader' 
}, 
], 
loaders:[ 
{ 
test: /\.jsx?$/, 
exclude: /node_modules/, 
loader: 'react-hot!babel' 
} 
] 
}, 复制代码

Ps：webpack3 的配置

module: {
rules: [
{
test: /\.(js|jsx)$/,
exclude: /node_modules/,
enforce: 'pre',
loader: 'eslint-loader'
}
]
} 复制代码

11、编辑器上使用

咱们用编辑器上安装eslint集成，能够在编写代码时，就会出现错误或者警告提示，不用每次执行eslint 来知道是否有问题。

一、visual code 在扩展中直接安装eslint就可使用了，加载就能够。
二、WebStorm上的使用

Preferences -> Languages & Frameworks -> JavaScript -> Code Quality Tools -> Eslint -> Enable (勾选) -> Apply -> OK

12、规则表解释

{
// 环境定义了预约义的全局变量。
"env": {
//环境定义了预约义的全局变量。更多在官网查看
"browser": true,
"node": true,
"commonjs": true,
"amd": true,
"es6": true,
"mocha": true
},
// JavaScript 语言选项
"parserOptions": {
// ECMAScript 版本
"ecmaVersion": 6,
"sourceType": "module", //设置为 "script" (默认) 或 "module"（若是你的代码是 ECMAScript 模块)。
//想使用的额外的语言特性:
"ecmaFeatures": {
// 容许在全局做用域下使用 return 语句
"globalReturn": true,
// impliedStric
"impliedStrict": true,
// 启用 JSX
"jsx": true,
"modules": true
}
},
//-----让eslint支持 JSX start
"plugins": [
"react"
],
"extends": [
"eslint:recommended",
"plugin:react/recommended"
],
//-----让eslint支持 JSX end

/**
* "off" 或 0 - 关闭规则
* "warn" 或 1 - 开启规则，使用警告级别的错误：warn (不会致使程序退出),
* "error" 或 2 - 开启规则，使用错误级别的错误：error (当被触发的时候，程序会退出)
*/
"rules": {

////////////////
// 可能的错误 //
////////////////

// 禁止条件表达式中出现赋值操做符
"no-cond-assign": 2,
// 禁用 console
"no-console": 0,
// 禁止在条件中使用常量表达式
// if (false) {
// doSomethingUnfinished();
// } //cuowu
"no-constant-condition": 2,
// 禁止在正则表达式中使用控制字符 ：new RegExp("\x1f")
"no-control-regex": 2,
// 数组和对象键值对最后一个逗号， never参数：不能带末尾的逗号, always参数：必须带末尾的逗号，
// always-multiline：多行模式必须带逗号，单行模式不能带逗号
"comma-dangle": [1, "never"],
// 禁用 debugger
"no-debugger": 2,
// 禁止 function 定义中出现重名参数
"no-dupe-args": 2,
// 禁止对象字面量中出现重复的 key
"no-dupe-keys": 2,
// 禁止重复的 case 标签
"no-duplicate-case": 2,
// 禁止空语句块
"no-empty": 2,
// 禁止在正则表达式中使用空字符集 (/^abc[]/)
"no-empty-character-class": 2,
// 禁止对 catch 子句的参数从新赋值
"no-ex-assign": 2,
// 禁止没必要要的布尔转换
"no-extra-boolean-cast": 2,
// 禁止没必要要的括号 //(a * b) + c;//报错
"no-extra-parens": 0,
// 禁止没必要要的分号
"no-extra-semi": 2,
// 禁止对 function 声明从新赋值
"no-func-assign": 2,
// 禁止在嵌套的块中出现 function 或 var 声明
"no-inner-declarations": [2, "functions"],
// 禁止 RegExp 构造函数中无效的正则表达式字符串
"no-invalid-regexp": 2,
// 禁止在字符串和注释以外不规则的空白
"no-irregular-whitespace": 2,
// 禁止在 in 表达式中出现否认的左操做数
"no-negated-in-lhs": 2,
// 禁止把全局对象 (Math 和 JSON) 做为函数调用 错误：var math = Math();
"no-obj-calls": 2,
// 禁止直接使用 Object.prototypes 的内置属性
"no-prototype-builtins": 0,
// 禁止正则表达式字面量中出现多个空格
"no-regex-spaces": 2,
// 禁用稀疏数组
"no-sparse-arrays": 2,
// 禁止出现使人困惑的多行表达式
"no-unexpected-multiline": 2,
// 禁止在return、throw、continue 和 break语句以后出现不可达代码
"no-unreachable": 2,
// 要求使用 isNaN() 检查 NaN
"use-isnan": 2,
// 强制使用有效的 JSDoc 注释
"valid-jsdoc": 1,
// 强制 typeof 表达式与有效的字符串进行比较
// typeof foo === "undefimed" 错误
"valid-typeof": 2,

//////////////
// 最佳实践 //
//////////////

// 定义对象的set存取器属性时，强制定义get
"accessor-pairs": 2,
// 强制数组方法的回调函数中有 return 语句
"array-callback-return": 0,
// 强制把变量的使用限制在其定义的做用域范围内
"block-scoped-var": 0,
// 限制圈复杂度，也就是相似if else能连续接多少个
"complexity": [2, 9],
// 要求 return 语句要么老是指定返回的值，要么不指定
"consistent-return": 0,
// 强制全部控制语句使用一致的括号风格
"curly": [2, "all"],
// switch 语句强制 default 分支，也可添加 // no default 注释取消这次警告
"default-case": 2,
// 强制object.key 中 . 的位置，参数:
// property，'.'号应与属性在同一行
// object, '.' 号应与对象名在同一行
"dot-location": [2, "property"],
// 强制使用.号取属性
// 参数： allowKeywords：true 使用保留字作属性名时，只能使用.方式取属性
// false 使用保留字作属性名时, 只能使用[]方式取属性 e.g [2, {"allowKeywords": false}]
// allowPattern: 当属性名匹配提供的正则表达式时，容许使用[]方式取值,不然只能用.号取值 e.g [2, {"allowPattern": "^[a-z]+(_[a-z]+)+$"}]
"dot-notation": [2, {
"allowKeywords": false
}],
// 使用 === 替代 == allow-null容许null和undefined==
"eqeqeq": [2, "allow-null"],
// 要求 for-in 循环中有一个 if 语句
"guard-for-in": 2,
// 禁用 alert、confirm 和 prompt
"no-alert": 0,
// 禁用 arguments.caller 或 arguments.callee
"no-caller": 2,
// 不容许在 case 子句中使用词法声明
"no-case-declarations": 2,
// 禁止除法操做符显式的出如今正则表达式开始的位置
"no-div-regex": 2,
// 禁止 if 语句中有 return 以后有 else
"no-else-return": 0,
// 禁止出现空函数.若是一个函数包含了一条注释，它将不会被认为有问题。
"no-empty-function": 2,
// 禁止使用空解构模式no-empty-pattern
"no-empty-pattern": 2,
// 禁止在没有类型检查操做符的状况下与 null 进行比较
"no-eq-null": 1,
// 禁用 eval()
"no-eval": 2,
// 禁止扩展原生类型
"no-extend-native": 2,
// 禁止没必要要的 .bind() 调用
"no-extra-bind": 2,
// 禁用没必要要的标签
"no-extra-label:": 0,
// 禁止 case 语句落空
"no-fallthrough": 2,
// 禁止数字字面量中使用前导和末尾小数点
"no-floating-decimal": 2,
// 禁止使用短符号进行类型转换(!!fOO)
"no-implicit-coercion": 0,
// 禁止在全局范围内使用 var 和命名的 function 声明
"no-implicit-globals": 1,
// 禁止使用相似 eval() 的方法
"no-implied-eval": 2,
// 禁止 this 关键字出如今类和类对象以外
"no-invalid-this": 0,
// 禁用 __iterator__ 属性
"no-iterator": 2,
// 禁用标签语句
"no-labels": 2,
// 禁用没必要要的嵌套块
"no-lone-blocks": 2,
// 禁止在循环中出现 function 声明和表达式
"no-loop-func": 1,
// 禁用魔术数字(3.14什么的用常量代替)
"no-magic-numbers": [1, {
"ignore": [0, -1, 1]
}],
// 禁止使用多个空格
"no-multi-spaces": 2,
// 禁止使用多行字符串，在 JavaScript 中，能够在新行以前使用斜线建立多行字符串
"no-multi-str": 2,
// 禁止对原生对象赋值
"no-native-reassign": 2,
// 禁止在非赋值或条件语句中使用 new 操做符
"no-new": 2,
// 禁止对 Function 对象使用 new 操做符
"no-new-func": 0,
// 禁止对 String，Number 和 Boolean 使用 new 操做符
"no-new-wrappers": 2,
// 禁用八进制字面量
"no-octal": 2,
// 禁止在字符串中使用八进制转义序列
"no-octal-escape": 2,
// 不容许对 function 的参数进行从新赋值
"no-param-reassign": 0,
// 禁用 __proto__ 属性
"no-proto": 2,
// 禁止使用 var 屡次声明同一变量
"no-redeclare": 2,
// 禁用指定的经过 require 加载的模块
"no-return-assign": 0,
// 禁止使用 javascript: url
"no-script-url": 0,
// 禁止自我赋值
"no-self-assign": 2,
// 禁止自身比较
"no-self-compare": 2,
// 禁用逗号操做符
"no-sequences": 2,
// 禁止抛出非异常字面量
"no-throw-literal": 2,
// 禁用一成不变的循环条件
"no-unmodified-loop-condition": 2,
// 禁止出现未使用过的表达式
"no-unused-expressions": 0,
// 禁用未使用过的标签
"no-unused-labels": 2,
// 禁止没必要要的 .call() 和 .apply()
"no-useless-call": 2,
// 禁止没必要要的字符串字面量或模板字面量的链接
"no-useless-concat": 2,
// 禁用没必要要的转义字符
"no-useless-escape": 0,
// 禁用 void 操做符
"no-void": 0,
// 禁止在注释中使用特定的警告术语
"no-warning-comments": 0,
// 禁用 with 语句
"no-with": 2,
// 强制在parseInt()使用基数参数
"radix": 2,
// 要求全部的 var 声明出如今它们所在的做用域顶部
"vars-on-top": 0,
// 要求 IIFE 使用括号括起来
"wrap-iife": [2, "any"],
// 要求或禁止 “Yoda” 条件
"yoda": [2, "never"],
// 要求或禁止使用严格模式指令
"strict": 0,

//////////////
// 变量声明 //
//////////////

// 要求或禁止 var 声明中的初始化(初值)
"init-declarations": 0,
// 不容许 catch 子句的参数与外层做用域中的变量同名
"no-catch-shadow": 0,
// 禁止删除变量
"no-delete-var": 2,
// 不容许标签与变量同名
"no-label-var": 2,
// 禁用特定的全局变量
"no-restricted-globals": 0,
// 禁止 var 声明 与外层做用域的变量同名
"no-shadow": 0,
// 禁止覆盖受限制的标识符
"no-shadow-restricted-names": 2,
// 禁用未声明的变量，除非它们在 /*global */ 注释中被提到
"no-undef": 2,
// 禁止将变量初始化为 undefined
"no-undef-init": 2,
// 禁止将 undefined 做为标识符
"no-undefined": 0,
// 禁止出现未使用过的变量
"no-unused-vars": [2, {
"vars": "all",
"args": "none"
}],
// 不容许在变量定义以前使用它们
"no-use-before-define": 0,

//////////////////////////
// Node.js and CommonJS //
//////////////////////////

// require return statements after callbacks
"callback-return": 0,
// 要求 require() 出如今顶层模块做用域中
"global-require": 1,
// 要求回调函数中有容错处理
"handle-callback-err": [2, "^(err|error)$"],
// 禁止混合常规 var 声明和 require 调用
"no-mixed-requires": 0,
// 禁止调用 require 时使用 new 操做符
"no-new-require": 2,
// 禁止对 __dirname 和 __filename进行字符串链接
"no-path-concat": 0,
// 禁用 process.env
"no-process-env": 0,
// 禁用 process.exit()
"no-process-exit": 0,
// 禁用同步方法
"no-sync": 0,

//////////////
// 风格指南 //
//////////////

// 指定数组的元素之间要以空格隔开(, 后面)， never参数：[ 以前和 ] 以后不能带空格，always参数：[ 以前和 ] 以后必须带空格
"array-bracket-spacing": [2, "never"],
// 禁止或强制在单行代码块中使用空格(禁用)
"block-spacing": [1, "never"],
//强制使用一致的缩进 第二个参数为 "tab" 时，会使用tab，
// if while function 后面的{必须与if在同一行，java风格。
"brace-style": [2, "1tbs", {
"allowSingleLine": true
}],
// 双峰驼命名格式
"camelcase": 2,
// 控制逗号先后的空格
"comma-spacing": [2, {
"before": false,
"after": true
}],
// 控制逗号在行尾出现仍是在行首出现 (默认行尾)
// http://eslint.org/docs/rules/comma-style
"comma-style": [2, "last"],
//"SwitchCase" (默认：0) 强制 switch 语句中的 case 子句的缩进水平
// 以方括号取对象属性时，[ 后面和 ] 前面是否须要空格, 可选参数 never, always
"computed-property-spacing": [2, "never"],
// 用于指统一在回调函数中指向this的变量名，箭头函数中的this已经能够指向外层调用者，应该没卵用了
// e.g [0,"that"] 指定只能 var that = this. that不能指向其余任何值，this也不能赋值给that之外的其余值
"consistent-this": [1, "that"],
// 强制使用命名的 function 表达式
"func-names": 0,
// 文件末尾强制换行
"eol-last": 2,
"indent": [2, 4, {
"SwitchCase": 1
}],
// 强制在对象字面量的属性中键和值之间使用一致的间距
"key-spacing": [2, {
"beforeColon": false,
"afterColon": true
}],
// 强制使用一致的换行风格
"linebreak-style": [1, "unix"],
// 要求在注释周围有空行 ( 要求在块级注释以前有一空行)
"lines-around-comment": [1, {
"beforeBlockComment": true
}],
// 强制一致地使用函数声明或函数表达式，方法定义风格，参数：
// declaration: 强制使用方法声明的方式，function f(){} e.g [2, "declaration"]
// expression：强制使用方法表达式的方式，var f = function() {} e.g [2, "expression"]
// allowArrowFunctions: declaration风格中容许箭头函数。 e.g [2, "declaration", { "allowArrowFunctions": true }]
"func-style": 0,
// 强制回调函数最大嵌套深度 5层
"max-nested-callbacks": [1, 5],
// 禁止使用指定的标识符
"id-blacklist": 0,
// 强制标识符的最新和最大长度
"id-length": 0,
// 要求标识符匹配一个指定的正则表达式
"id-match": 0,
// 强制在 JSX 属性中一致地使用双引号或单引号
"jsx-quotes": 0,
// 强制在关键字先后使用一致的空格 (先后腰须要)
"keyword-spacing": 2,
// 强制一行的最大长度
"max-len": [1, 200],
// 强制最大行数
"max-lines": 0,
// 强制 function 定义中最多容许的参数数量
"max-params": [1, 7],
// 强制 function 块最多容许的的语句数量
"max-statements": [1, 200],
// 强制每一行中所容许的最大语句数量
"max-statements-per-line": 0,
// 要求构造函数首字母大写 （要求调用 new 操做符时有首字母大小的函数，容许调用首字母大写的函数时没有 new 操做符。）
"new-cap": [2, {
"newIsCap": true,
"capIsNew": false
}],
// 要求调用无参构造函数时有圆括号
"new-parens": 2,
// 要求或禁止 var 声明语句后有一行空行
"newline-after-var": 0,
// 禁止使用 Array 构造函数
"no-array-constructor": 2,
// 禁用按位运算符
"no-bitwise": 0,
// 要求 return 语句以前有一空行
"newline-before-return": 0,
// 要求方法链中每一个调用都有一个换行符
"newline-per-chained-call": 1,
// 禁用 continue 语句
"no-continue": 0,
// 禁止在代码行后使用内联注释
"no-inline-comments": 0,
// 禁止 if 做为惟一的语句出如今 else 语句中
"no-lonely-if": 0,
// 禁止混合使用不一样的操做符
"no-mixed-operators": 0,
// 不容许空格和 tab 混合缩进
"no-mixed-spaces-and-tabs": 2,
// 不容许多个空行
"no-multiple-empty-lines": [2, {
"max": 2
}],
// 不容许否认的表达式
"no-negated-condition": 0,
// 不容许使用嵌套的三元表达式
"no-nested-ternary": 0,
// 禁止使用 Object 的构造函数
"no-new-object": 2,
// 禁止使用一元操做符 ++ 和 --
"no-plusplus": 0,
// 禁止使用特定的语法
"no-restricted-syntax": 0,
// 禁止 function 标识符和括号之间出现空格
"no-spaced-func": 2,
// 不容许使用三元操做符
"no-ternary": 0,
// 禁用行尾空格
"no-trailing-spaces": 2,
// 禁止标识符中有悬空下划线_bar
"no-underscore-dangle": 0,
// 禁止能够在有更简单的可替代的表达式时使用三元操做符
"no-unneeded-ternary": 2,
// 禁止属性前有空白
"no-whitespace-before-property": 0,
// 强制花括号内换行符的一致性
"object-curly-newline": 0,
// 强制在花括号中使用一致的空格
"object-curly-spacing": 0,
// 强制将对象的属性放在不一样的行上
"object-property-newline": 0,
// 强制函数中的变量要么一块儿声明要么分开声明
"one-var": [2, {
"initialized": "never"
}],
// 要求或禁止在 var 声明周围换行
"one-var-declaration-per-line": 0,
// 要求或禁止在可能的状况下要求使用简化的赋值操做符
"operator-assignment": 0,
// 强制操做符使用一致的换行符
"operator-linebreak": [2, "after", {
"overrides": {
"?": "before",
":": "before"
}
}],
// 要求或禁止块内填充
"padded-blocks": 0,
// 要求对象字面量属性名称用引号括起来
"quote-props": 0,
// 强制使用一致的反勾号、双引号或单引号
"quotes": [2, "double", "avoid-escape"],
// 要求使用 JSDoc 注释
"require-jsdoc": 1,
// 要求或禁止使用分号而不是 ASI（这个才是控制行尾部分号的，）
"semi": [2, "always"],
// 强制分号以前和以后使用一致的空格
"semi-spacing": 0,
// 要求同一个声明块中的变量按顺序排列
"sort-vars": 0,
// 强制在块以前使用一致的空格
"space-before-blocks": [2, "always"],
// 强制在 function的左括号以前使用一致的空格
"space-before-function-paren": [0, "always"],
// 强制在圆括号内使用一致的空格
"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", "!"]
}],
// 要求或禁止 Unicode BOM
"unicode-bom": 0,
// 要求正则表达式被括号括起来
"wrap-regex": 0,

//////////////
// ES6.相关 //
//////////////

// 要求箭头函数体使用大括号
"arrow-body-style": 2,
// 要求箭头函数的参数使用圆括号
"arrow-parens": 2,
"arrow-spacing": [2, {
"before": true,
"after": true
}],
// 强制在子类构造函数中用super()调用父类构造函数，TypeScrip的编译器也会提示
"constructor-super": 0,
// 强制 generator 函数中 * 号周围使用一致的空格
"generator-star-spacing": [2, {
"before": true,
"after": true
}],
// 禁止修改类声明的变量
"no-class-assign": 2,
// 不容许箭头功能，在那里他们能够混淆的比较
"no-confusing-arrow": 0,
// 禁止修改 const 声明的变量
"no-const-assign": 2,
// 禁止类成员中出现重复的名称
"no-dupe-class-members": 2,
// 不容许复制模块的进口
"no-duplicate-imports": 0,
// 禁止 Symbol 的构造函数
"no-new-symbol": 2,
// 容许指定模块加载时的进口
"no-restricted-imports": 0,
// 禁止在构造函数中，在调用 super() 以前使用 this 或 super
"no-this-before-super": 2,
// 禁止没必要要的计算性能键对象的文字
"no-useless-computed-key": 0,
// 要求使用 let 或 const 而不是 var
"no-var": 0,
// 要求或禁止对象字面量中方法和属性使用简写语法
"object-shorthand": 0,
// 要求使用箭头函数做为回调
"prefer-arrow-callback": 0,
// 要求使用 const 声明那些声明后再也不被修改的变量
"prefer-const": 0,
// 要求在合适的地方使用 Reflect 方法
"prefer-reflect": 0,
// 要求使用扩展运算符而非 .apply()
"prefer-spread": 0,
// 要求使用模板字面量而非字符串链接
"prefer-template": 0,
// Suggest using the rest parameters instead of arguments
"prefer-rest-params": 0,
// 要求generator 函数内有 yield
"require-yield": 0,
// enforce spacing between rest and spread operators and their expressions
"rest-spread-spacing": 0,
// 强制模块内的 import 排序
"sort-imports": 0,
// 要求或禁止模板字符串中的嵌入表达式周围空格的使用
"template-curly-spacing": 1,
// 强制在 yield* 表达式中 * 周围使用空格
"yield-star-spacing": 2
}
}复制代码