自定义 ESLint 规则，让代码持续美丽_语言 & 开发_政采云前端团队

限时领｜《AI 百问百答》专栏课+实体书（包邮）！了解详情 



 写点什么

背景

一段真实的代码发展历史

很久很久以前，有一个需求，然后产出了一段代码，代码优雅而简洁

export const getConfig = (param1, param2) => {  return ...};

复制代码

不久又来了个需求，加个参数扩展，so easy！

export const getConfig = (param1, param2, param3) => {  return ...};

复制代码

经过多次产品需求迭代后，现在的代码

export const getConfig = (param1, param2, param3, param4, param5, param6, param7……) => {  return ...};

复制代码

在产品迭代过程中，上面的 case 一个函数的参数从 2 个发展到了 7 个，优雅的代码逐渐变为不可维护。这是什么问题？这归咎于日益增长的需求，快速响应和代码质量之间的矛盾。

那如何避免呢？

制定代码规范
靠开发同学的自我修养
进行 Code Review
工具提示
发版控制，不允许发版

制定代码规范肯定是需要的，那如何约束代码呢？规范文档宣讲，再凭借开发同学的自我修养？答案是：无法保证。

Code Review ？但难免也有落网之鱼。发版控制？能有效解决但是开发体验不好。

如果我们在开发者写代码的时候就及时给到提示和建议，那开发体验就很棒了，而 ESLint 的自定义规则就可以实现在开发过程中给开发同学友好的提示。

ESLint 原理

ESLint 是一个代码检查工具，通过静态的分析，寻找有问题的模式或者代码。默认使用 Espree 解析器将代码解析为 AST 抽象语法树，然后再对代码进行检查。

看下最简单的一段代码使用 espree 解析器转换成的抽象语法树结构，此处可以使用 astexplorer 快速方便查看解析成 AST 的结构：

代码片段：

var a = 1;

复制代码

转换出的结果：

{  "type": "Program",  "start": 0,  "end": 10,  "range": [    0,    10  ],  "body": [    {      "type": "VariableDeclaration",      "start": 0,      "end": 10,      "range": [        0,        10      ],      "declarations": [        {          "type": "VariableDeclarator",          "start": 4,          "end": 9,          "range": [            4,            9          ],          "id": {            "type": "Identifier",            "start": 4,            "end": 5,            "range": [              4,              5            ],            "name": "a"          },          "init": {            "type": "Literal",            "start": 8,            "end": 9,            "range": [              8,              9            ],            "value": 1,            "raw": "1"          }        }      ],      "kind": "var"    }  ],  "sourceType": "module"}

复制代码

代码转换为 AST 后，可以很方便的对代码的每个节点对代码进行检查。

自定义 ESLint 规则开发

怎么自定义

语法树分析

对目标代码进行语法树解析，可使用 astexplorer

编写规则

下面是一个规则简单的结构（官方 API 文档说明）

module.exports = {  meta: {    docs: {      description: "最多参数允许参数",    },  },  create: function (context) {    return {      FunctionDeclaration: (node) => {        if (node.params.length > 3) {          context.report({            node,            message: "参数最多不能超过3个",          });        }      },    };  },};

复制代码

meta（对象）包含规则的元数据
create ( function ) 返回一个对象，其中包含了 ESLint 在遍历 JavaScript 代码的抽象语法树 AST ( ESTree 定义的 AST ) 时，用来访问节点的方法
context.report ( ) 用来发布警告或错误，并能提供自动修复功能（取决于你所使用的配置）

最简单的示例（只使用 node 和 message 参数）：

context.report({    node,    message: "参数最多不能超过3个",});

复制代码

使用上面的这个规则，结合编辑器就有了对整个 node 节点的提示，如果需要更精确的错误或警告提示，我们可以使用 loc 参数，API 文档说明。

如何使用自定义规则

使用自定义的 ESLint 规则，你需要自定义一个 ESLint 的插件，然后将规则写到自定义的 ESLint 插件中，然后在业务代码中添加 ESLint 配置，引入 ESLint 插件。

ESLint 插件

创建

创建一个 ESLint plugin，并创建一个 ESLint rule。

基于 Yeoman generator (https://yeoman.io/authoring/) ，可以快速创建 ESLint plugin 项目。

npm i -g yonpm i -g generator-eslint// 创建一个pluginyo eslint:plugin// 创建一个规则yo eslint:rule

复制代码

创建好的项目目录结构：

rules 文件夹存放的是各个规则文件
tests 文件夹存放单元测试文件
package.json 是你的 ESLint 插件 npm 包的说明文件，其中的 name 属性就是你的 ESLint 插件的名称，命名规则：带前缀 eslint-plugin-

// 示例代码：// lib/rules/max-params.jsmodule.exports = {  meta: {    docs: {      description: "最多参数",    },  },  create: function (context) {    /**     * 获取函数的参数的开始、结束位置     * @param {node} node AST Node      */    function getFunctionParamsLoc(node) {      const paramsLength = node.params.length;      return {        start: node.params[0].loc.start,        end: node.params[paramsLength - 1].loc.end,      };    }    return {      FunctionDeclaration: (node) => {        if (node.params.length > 3) {          context.report({            loc: getFunctionParamsLoc(node),            node,            message: "参数最多不能超过3个",          });        }      },    };  },};

复制代码

// 补充测试用例// /tests/lib/rules/max-params.jsvar ruleTester = new RuleTester();ruleTester.run("max-params", rule, {  valid: ["function test(d, e, f) {}"],  invalid: [    {        code: "function test(a, b, c, d) {}",        errors: [{            message: "参数最多不能超过3个",        }]    },  ],});

复制代码

ESLint 插件安装

在需要的业务代码中安装你的 ESLint 插件。（eslint-plugin-my-eslist-plugin 是你的 ESLint 插件 npm 包的包名）

npm install eslint-plugin-my-eslist-plugin

复制代码

如果你的 npm 包还未发布，需要进行本地调试：

可使用 npm link 本地调试，npm link 的使用。

配置

添加你的 plugin 包名（eslint-plugin- 前缀可忽略）到 .eslintrc 配置文件的 plugins 字段。

.eslintrc 配置文件示例：

{    "plugins": [        "zoo" // 你的 ESLint plugin 的名字    ]}

复制代码

rules 中再将 plugin 中的规则导入。⚠️ ESlint 更新后，需要重启 vsCode，才能生效。（ vsCode 重启快捷方式：CTRL +SHITF + P，输入 Reload Window ）

此处涉及 ESLint 的规则设置（参考说明）

{    "rules": {        "zoo/rule-name": 2    }}

复制代码

创作场景

自定义 ESLint 规则，让代码持续美丽

背景

ESLint 原理

自定义 ESLint 规则开发

怎么自定义

语法树分析

编写规则

如何使用自定义规则

ESLint 插件

创建

ESLint 插件安装

配置

效果

更多的应用场景

评论

更多内容推荐

推荐阅读

电子书

大厂实战PPT下载