EsLint入门学习整理

介绍

  ESLint 是一个插件化的 javascript 代码检测工具，它能够用于检查常见的 JavaScript 代码错误，也能够进行代码风格检查，这样咱们就能够根据本身的喜爱指定一套 ESLint 配置，而后应用到所编写的项目上，从而实现辅助编码规范的执行，有效控制项目代码的质量。

安装

ESLint的安装:本地安装、全局安装

一、本地安装

$ npm install eslint --save-dev

生成配置文件

$ ./node_modules/.bin/eslint --init

以后,您能够运行ESLint在任何文件或目录以下:

$ ./node_modules/.bin/eslint index.js

index.js是你须要测试的js文件。你使用的任何插件或共享配置（必须安装在本地来与安装在本地的ESLint一块儿工做）。

二、全局安装

若是你想让ESLint可用到全部的项目,建议全局安装ESLint。

$ npm install -g eslint

生成配置文件

$ eslint --init

以后,您能够在任何文件或目录运行ESLint

$ eslint index.js

PS：eslint --init是用于每个项目设置和配置eslint,并将执行本地安装的ESLint及其插件的目录。若是你喜欢使用全局安装的ESLint，在你配置中使用的任何插件都必须是全局安装的。

使用

一、在项目根目录生成package.json文件（配置ESLint的项目中必须有 package.json 文件，若是没有的话可使用 npm init -y来生成）

$ npm init -y

二、安装eslint（安装方式根据我的项目须要安装，这里使用全局安装）

$ npm install -g eslint

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

function merge () {
    var ret = {};
    for (var i in arguments) {
        var m = arguments[i];
        for (var j in m) ret[j] = m[j];
    }
    return ret;
}

console.log(merge({a: 123}, {b: 456}));

执行node index.js，输出结果为{ a: 123, b: 456 }

$ node index.js
{ a: 123, b: 456 }

使用eslint检查

$ eslint index.js

Oops! Something went wrong! :(

ESLint: 4.19.1.
ESLint couldn't find a configuration file. To set up a configuration file for this project, please run:

    eslint --init

ESLint looked for configuration files in E:\website\demo5\js and its ancestors. If it found none, it then looked in your home directory.

If you think you already have a configuration file or if you need more help, please stop by the ESLint chat room: https://gitter.im/eslint/eslint

执行结果是失败，由于没有找到相应的配置文件，我的认为这个eslint最重要的就是配置问题。

新建配置文件

$ eslint --init

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

? How would you like to configure ESLint? Answer questions about your style
? Are you using ECMAScript 6 features? Yes
? Are you using ES6 modules? Yes
? Where will your code run? Browser
? Do you use CommonJS? Yes
? Do you use JSX? No
? What style of indentation do you use? Tabs
? What quotes do you use for strings? Single
? What line endings do you use? Windows
? Do you require semicolons? No
? What format do you want your config file to be in? JavaScript

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

module.exports = {
    "env": {
        "browser": true,
        "commonjs": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "parserOptions": {
        "sourceType": "module"
    },
    "rules": {
        "indent": [
            "error",
            "tab"
        ],
        "linebreak-style": [
            "error",
            "windows"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "never"
        ]
    }
};

  不过这个生成的额文件里面已经有一些配置了，把里面的内容大部分删除。留下个extends，剩下的本身填就能够了

module.exports = {
      "extends": "eslint:recommended"
  };

eslint:recommended配置，它包含了一系列核心规则，能报告一些常见的问题。

从新执行eslint index.js，输出以下

10:1  error  Unexpected console statement  no-console
  10:1  error  'console' is not defined      no-undef

✖ 2 problems (2 errors, 0 warnings)

Unexpected console statement no-console --- 不能使用console
'console' is not defined no-undef --- console变量未定义，不能使用未定义的变量
一条一条解决，不能使用console的提示，那咱们就禁用no-console就行了，在配置文件中添加rules

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

  配置规则写在rules对象里面，key表示规则名称，value表示规则的配置。
  而后就是解决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已经彻底经过了检查。

配置

配置方式有两种：文件配置方式、代码注释配置方式（建议使用文件配置的形式，比较独立，便于维护）。
使用文件配置的方式：在项目的根目录下，新建一个名为 .eslintrc 的文件，在此文件中添加一些检查规则。

文件配置方式

env：你的脚本将要运行在什么环境中
Environment能够预设好的其余环境的全局变量，如brower、node环境变量、es6环境变量、mocha环境变量等

'env': {
    'browser': true,
    'commonjs': true,
    'es6': true
},

globals：额外的全局变量

globals: {
    vue: true,
    wx: true
},

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*/

配置和规则的内容有很多，有兴趣的同窗能够参考这里：rules

使用共享的配置文件

  咱们使用配置js文件是以extends: 'eslint:recommended'为基础配置，可是大多数时候咱们须要制定不少规则，在一个文件中写入会变得很臃肿，管理起来会很麻烦。

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

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

而后原来的.eslintrc.js文件内容稍微变化下，删掉全部的配置，留下一个extends。

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

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

2:1  error  Expected indentation of 4 spaces but found 5  indent

✖ 1 problem (1 error, 0 warnings)
  1 error, 0 warnings potentially fixable with the `--fix` option.

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

  除了这些基本的配置之外，在npm上有不少已经发布的ESLint配置，也能够经过安装使用。配置名字通常都是eslint-config-为前缀，通常咱们用的eslint是全局安装的，那用的eslint-config-模块也必须是全局安装，否则无法载入。

在执行eslint检查的时候，咱们会常常看到提示“--flx”选项，在执行eslint检查的时候添加该选项会自动修复部分报错部分（注意这里只是部分，并非所有）

好比咱们在规则中添加一条no-extra-semi: 禁止没必要要的分号。

'no-extra-semi':'error'

而后，咱们在index.js最后多添加一个分号

function merge () {
    var ret = {};
    for (var i in arguments) {
        var m = arguments[i];
        for (var j in m) ret[j] = m[j];
    }
    return ret;;
}

console.log(merge({a: 123}, {b: 456}));

执行eslint index.js，获得结果以下：

7:16  error  Unnecessary semicolon  no-extra-semi
  7:16  error  Unreachable code       no-unreachable

✖ 2 problems (2 errors, 0 warnings)
  1 error, 0 warnings potentially fixable with the `--fix` option.

而后咱们在执行eslint index.js --fix就会自动修复，index.js那个多余的分号也就被修复消失不见了。

总结

以上是我在学习eslint整理的一些资料，不算太全面，对于像我这样的新手入门足够了