如何利用 ESLint 结合 AST 解析实现团队特有的代码规范检测

陌墨君_1066

陌墨君_1066

2026-04-16

690人浏览

原创

必须从ast角度理解eslint规则,因为eslint基于解析后的ast(而非字符串匹配)工作,规则需监听特定节点类型(如variabledeclarator),不理解ast易导致漏检、误报或性能问题。

如何利用 eslint 结合 ast 解析实现团队特有的代码规范检测

为什么必须从 AST 角度理解 ESLint 规则

ESLint 不是靠字符串匹配或正则去“猜”代码问题,它真正工作时操作的是 SourceCode 对象——也就是解析后的 AST。这意味着:你写的每条规则,本质是在监听特定 AST 节点类型(如 CallExpression、VariableDeclarator),并在对应节点出现时做逻辑判断。不理解 AST 结构,就容易写出漏检、误报或性能差的规则。

常见错误现象包括:规则只在顶层生效、嵌套函数里失效、箭头函数参数识别失败。这些问题往往不是配置错,而是没意识到 context.getScope() 的作用域层级,或没用 node.parent 向上追溯上下文。

  • 调试 AST 结构最直接的方式是运行 eslint --print-config path/to/file.js 配合在线工具如 AST Explorer 查看目标代码的真实节点形态
  • 所有自定义规则必须在 create(context) 返回的对象中注册监听器,键名必须与 ESTree 规范中的节点类型完全一致(如不能写 CallExpressionNode,只能写 CallExpression)
  • 避免在监听器里做深度递归遍历——ESLint 已经帮你做了整棵树的遍历,重复遍历会显著拖慢检查速度

如何编写一个禁止「非空对象字面量直接赋值给 let 变量」的规则

这个需求很典型:团队约定 let 只用于后续会重新赋值的变量,而初始化即确定的结构应使用 const。但 const 允许对象内容变更,所以重点是识别“初始化即为完整对象字面量”的场景。

关键在于区分两种 AST 模式:ObjectExpression(对象字面量)是否作为 VariableDeclarator 的 init 值,且其父级声明是 let。

  • 不要只检查 node.init.type === "ObjectExpression",还要确认 node.parent.kind === "let"
  • 需排除解构赋值场景(如 let { a } = obj),此时 node.init 是 Identifier,不是 ObjectExpression
  • 要跳过带计算属性或方法的对象(如 { [key]: 1, fn(){} }),它们更可能被后续修改,可放宽限制

示例核心逻辑:

FlagEval
FlagEval

FlagEval是一款AI模型评测工具,(天秤)大模型评测平台,由智源研究院推出。

下载
module.exports = {
  meta: { type: "problem", fixable: "code" },
  create(context) {
    return {
      VariableDeclarator(node) {
        const init = node.init;
        if (
          node.parent.kind === "let" &&
          init?.type === "ObjectExpression" &&
          init.properties.length > 0 &&
          !init.properties.some(p => p.computed || p.method)
        ) {
          context.report({
            node,
            message: "let 声明不应初始化为静态对象字面量,请改用 const",
            fix(fixer) {
              return fixer.replaceText(node.parent, `const${node.parent.source.slice(3)}`);
            }
          });
        }
      }
    };
  }
};

自定义规则上线前必须验证的三件事

规则写完不等于能进生产。很多团队把规则加进 .eslintrc.js 就直接跑 CI,结果要么大面积报错阻塞提交,要么根本不起作用。

  • 用真实项目代码片段测试边界情况:空对象 {}、含注释的对象、带 getter 的对象、TS 接口实现类等
  • 确认 parserOptions.ecmaVersion 和 parser 配置与规则兼容——比如用了 @typescript-eslint/parser,就不能依赖原生 espree 的节点类型命名
  • 在 package.json 的 lint script 中加 --debug 参数,查看该规则是否被加载、是否命中节点、是否有报错堆栈

AST 规则和 Prettier 的协作边界在哪

很多人混淆 ESLint 和 Prettier 的职责。Prettier 只处理格式(缩进、引号、换行),它不碰 AST 语义;ESLint 基于 AST 做语义检查(比如“是否用了 console.log”、“是否变量未使用”)。两者叠加时,最容易出问题的是修复冲突。

例如:你写了条规则自动把 let 改成 const,但 Prettier 又在下一轮把 const 格式化成单行,而你的规则又因格式变化再次触发……循环发生。

  • 所有 ESLint 自动修复(eslint --fix)应在 Prettier 执行前完成;推荐顺序是:eslint --fix → prettier --write
  • 禁用 Prettier 管控的 ESLint 格式类规则(如 indent、quotes),统一交给 Prettier,避免 AST 层和格式层互相干扰
  • 如果规则涉及重写代码结构(如替换整个表达式),务必在 meta.fixable = "code" 中声明,并确保修复后仍能被 Prettier 安全格式化

最常被忽略的一点:AST 规则无法检测运行时行为,比如某个函数调用是否真会修改全局状态。这类问题需要结合单元测试或 TypeScript 类型约束,不能指望 ESLint 单独解决。

相关文章

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

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

下载

相关标签:

代码规范

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

相关专题

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

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

2023.06.20

4586

5

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

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

2023.07.04

1149

3

js四舍五入
js四舍五入

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

2023.07.04

4524

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1816

5

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

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

2023.09.04

3285

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4273

6

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

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

2023.09.20

2780

5

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

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

2023.09.20

888

7

热门下载

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

精品课程

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

共1课时 | 174人学习

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

共37课时 | 71.5万人学习