eslint简介

本文主要记录作者对eslint理解的关键点，建议在阅读本文之前，先阅读eslint官网用户手册文档

eslint是一个代码检查工具。

配置

添加eslint后，进行代码检验并没有效果，还需要进行配置。

在项目下创建.eslintrc.js配置文件（更多配置方式请阅读官网），用于指导eslint的行为。

规则

规则可以理解为对某种编码场景的检查纬度，如命名，缩进等。官方提供了非常多的规则，但默认是不开启状态，需要通过配置文件开启。

如开启一个规则，规定项目中字符串的字面量都是用双引号：

module.exports = {
  rules: {
    quotes: ["error", "double"]
  },
};

更多的规则请见官方规则列表。

如果觉得配置规则太过于繁琐，或者不知道如何配置时，可以使用一些别人已经配置好的规则配置。这种规则配置一般称为风格，主要有：

eslint-config-standard: js标准风格，特别宽松，推荐使用高级用法，比较灵活，适合精英小团队；
eslint:recommended: eslint官方推荐，较严格，使用最广的风格；
eslint-config-airbnb: 爱彼迎团队推出来的代码风格，比较严苛，团队入门新手较多时推荐；

更多风格，可以在github ,npm中使用关键字eslint-config进行搜索，选择适合自己或者团队的。

对于别人配置好的规则配置，只需要在配置文件中，使用extends即可以继承，如：

module.exports = {
  extends: ['eslint-config-airbnb'],
};

此时可以不需要额外去配置其配置项和规则，即可使用。如果这种社区的风格存在不适合团队或者个人的地方，可以在当前配置中配置其他内容项进行调整，如规则，自己配置的内容具有最高优先级。

可以继承多个风格，多个风格中对于同个规则的配置，都是后面的覆盖前面的，其他配置的优先级也是一样。

有一个比较特殊的风格就是eslint-config-prettier，该风格中只对一些可以通过prettier进行代码自动格式化操作的场景对应的规则给关闭，利用prettier去保证代码符合规范。所以当你的团队启用prettier的时候，需要保证eslint-config-prettier放在最后。

也可以把自己搭配出来的规则配置抽取公共的库，建议命名规范为eslint-config-xxxx，在多个项目中使用。如果不想抽取为配置库，抽取为一个配置文件随意放在哪里也是可以的。

规则共享配置

setting配置多个规则的共同配置配置（如果有）,这在一些eslint插件（下文会说）中用的比较多，如eslint-plugin-import；

解析器和解析器选项

可以在配置文件中通过parser配置对js进行语法信息的解析器。如果使用一些特殊的es6语法，可能使用eslint自带的语法解析器无法支持到这些特性，可以配置为@babel/eslint-parser，利用babel插件机制，支持更广的语法。另外如果要支持typescipt语法，建议配置为@typescript-eslint/parser。

通过parserOptions配置项可以配置对应解析器的解析器选项，具体配置，参照对应解析器的文档，都有推荐配置，或者根据实际需求场景配置。

其他配置

建议阅读官方。

插件

当官方的规则不能覆盖全部实际场景时，eslint支持插件体系对其规则进行扩充。

这里推荐一些社区插件:

@typescript-eslint/eslint-plugin： typescipt语法规范
eslint-plugin-import：导入模块规范
eslint-plugin-jsx-a11y: 推动无障碍支持规范
eslint-plugin-react: react编写规范
eslint-plugin-react-hooks: react hooks编写规范
eslint-plugin-promise：promise使用规范
eslint-plugin-lodash：lodash使用规范

更多的可以使用关键字eslint-plugin在github和npm中搜索，选择适合自己或者团队的插件。

每个插件都会扩展一些规则，但需要注意，当规则启用较多时，检验时间就会增加。

每个插件基本的都有对插件内的规则的推荐配置，使用其推荐配置，可以快速使用。

另外可以参考官网的文档自定义插件，自定义规则，根据个人需求和团队需求，实现更加贴合的检验规则。

使用

在项目中集成eslint后，有多种使用方式。

vscode

vscode中添加插件eslint，即可生效。可以在编码时及时反馈，养成良好编码习惯。

命令行

eslint提供elsint指令，可以配置在package.json中的scripts中，也可以直接npx执行，相关命令行参数参照官网对应文章：eslint命令行。

webpack插件

参考eslint-webpack-plugin即可。

node Api

eslint提供node api模式，方便二次封装和集成在其他工具里面。如对其校验结果自定义格式化，该需求命令行指定format也可以，但更加建议使用api的模式。

git hooks

利用husky + lint-staged，对每次提交的每个文件进行检验，如果没通过，禁止提交。

提供一个参考的配置(配置在package.json的方式，其他方式参考相关技术，按需调整)：

{
  "husky": {
    "hooks": {
      "pre-commit": "npx lint-staged"
    }
  },
  "lint-staged": {
    "src/**/*.{js,jsx,tsx,ts}": [
      "eslint --quiet",
      "git add"
    ]
  }
}