如何通过静态分析(AST)开发自定义的 ESLint 插件强制代码规范

风杰酱_1106

风杰酱_1106

2026-04-11

376人浏览

原创

eslint通过解析器(如espree、@typescript-eslint/parser)将源码转换为estree标准ast,再遍历节点触发对应规则;规则监听特定节点类型(如callexpression),依赖正确配置parseroptions(ecmaversion、sourcetype、jsx等)确保ast结构完整。

如何通过静态分析(ast)开发自定义的 eslint 插件强制代码规范

AST 是怎么被 ESLint 读进去的

ESLint 不是靠正则去“猜”代码结构,而是先把源码喂给解析器(parser),转成标准 AST(ESTree 格式),再逐个节点遍历检查。你写的规则本质就是监听特定 AST 节点类型,比如 CallExpression、JSXElement、VariableDeclarator。

默认用 espree,但项目里有 JSX 或 TypeScript 就得换:@babel/eslint-parser(旧项目)、@typescript-eslint/parser(TS 项目)。不配对 parser 和语法特性,AST 解析直接失败——比如没开 jsx: true 却检查 JSXElement,规则压根不会触发。

  • parserOptions.ecmaVersion 必须 ≥ 你代码实际用的 ES 版本,否则 async/await、可选链等节点根本不会出现在 AST 中
  • parserOptions.sourceType 设为 module 才能正确解析 import/export 节点
  • 用 astexplorer.net 粘贴代码实时看 AST 结构,比盲写高效得多

写一条规则:禁止 console.log 但允许 console.error

核心逻辑就两步:匹配 CallExpression 节点 → 判断 callee.object.name === 'console' && callee.property.name === 'log'。不能只查 node.callee.name === 'console.log',那根本不是合法 AST 属性。

规则文件 lib/rules/no-console-log.js 长这样:

故事AI绘图神器
故事AI绘图神器

一款面向故事和图文视频创作的AI工具,可以根据文本内容生成相关画面并形成连续视觉内容,适合快速制作故事类作品。

下载
module.exports = {
  meta: {
    type: "suggestion",
    docs: { description: "禁止使用 console.log" },
    schema: [] // 无配置项
  },
  create(context) {
    return {
      CallExpression(node) {
        const { callee } = node;
        // 必须是 console.xxx 形式,且 callee 是 MemberExpression
        if (
          callee.type === "MemberExpression" &&
          callee.object.type === "Identifier" &&
          callee.object.name === "console" &&
          callee.property.type === "Identifier" &&
          callee.property.name === "log"
        ) {
          context.report({
            node,
            message: "不允许使用 console.log,请改用 console.error 或其他方式"
          });
        }
      }
    };
  }
};
  • 别漏判 callee.type === "MemberExpression",否则会误伤 foo.console.log()
  • 如果要支持配置白名单(如允许 error、warn),得在 meta.schema 定义,并用 context.options[0]?.allow 读取
  • 测试时用 RuleTester 写 invalid 用例,确保报错位置精准到行号

插件发布前必须验证的三件事

本地跑通不等于别人能用。一个可用的插件至少要过这三关:

  • 入口文件 lib/index.js 必须导出 rules 对象,键名和规则 ID 严格一致(比如 "no-console-log": require("./rules/no-console-log"))
  • package.json 的 name 必须以 eslint-plugin- 开头,否则 extends 或 plugins 字段无法识别
  • 用户项目里引用时,plugins 数组填的是插件名去掉前缀后的部分(如 "wjcao-utils"),但规则 ID 前必须加插件名前缀(如 "wjcao-utils/no-console-log")

为什么你的自定义规则在 IDE 里不报错

最常见原因是 VS Code 的 ESLint 插件没读到你的本地插件路径。它默认只认 node_modules 下已安装的包,不会自动 resolve 未 publish 的本地目录。

  • 开发阶段,在用户项目中用 npm link 或 yarn link 把插件 link 进去
  • 确认用户项目的 .eslintrc.js 里 plugins 和 rules 配置拼写完全正确(大小写、连字符、前缀)
  • VS Code 的 ESLint 输出面板(Output → ESLint)里常有解析失败提示,比如 Failed to load plugin 'xxx': Cannot find module 'eslint-plugin-xxx',这就是路径或 name 没对上

AST 规则本身不难,难的是让整个链路——从解析器、插件加载、规则注册到编辑器反馈——全部对齐。少一个环节,规则就只是个静态文件。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

代码规范

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4966

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1229

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4884

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1876

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3505

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4553

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2980

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

948

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel 团队合作的 15 个技巧
Laravel 团队合作的 15 个技巧

共1课时 | 178人学习

PHP开发编码规范
PHP开发编码规范

共37课时 | 71.7万人学习

手把手带您写PHP框架_设计开发篇
手把手带您写PHP框架_设计开发篇

共18课时 | 4.1万人学习