基于AST分析的前端HTML代码质量检测插件自研

风枫姑娘_2441

风枫姑娘_2441

2026-07-18

632人浏览

原创

eslint和sonarqube无法检测html结构问题,因其分别仅支持js解析和基于正则/简易dom的静态分析,无法理解组件嵌套、属性绑定等语义;必须借助parse5等专用html解析器生成ast,再遍历节点校验如img是否含alt属性。

基于ast分析的前端html代码质量检测插件自研

为什么直接用 ESLint 或 SonarQube 检测不了 HTML 结构问题

因为 ESLint 天然只解析 JavaScript,对 .html 文件默认跳过;SonarQube 的 HTML 插件依赖静态正则或简单 DOM 解析,无法识别组件嵌套逻辑、属性绑定语义、或 JSX/模板语法中的动态结构。真正要检查 v-if 是否被误写成 v-ifs、data-testid 是否缺失、或 img 标签有没有 alt,必须走到 AST 层——不是字符串匹配,而是把 HTML 当成语法树来遍历。

用 @babel/parser 解析 HTML 会失败,该选哪个 parser

@babel/parser 不支持纯 HTML,强行启用 jsx: true 会把 <div class="x"></div> 解成 JSX 节点,丢失原生 HTML 的属性结构(比如把 class 当成 JSX 属性而非 HTML 属性)。正确选择是:parse5(主流、符合 HTML5 规范、输出标准 AST)、htmlparser2(轻量、事件驱动、适合流式处理),或 cheerio(底层用 htmlparser2,API 类 jQuery,但 AST 可访问性弱)。生产环境推荐 parse5,它输出的 document 节点带完整 childNodes 和 attributes,方便写规则时判断父子关系和属性存在性。

如何编写一条“强制 img 必须含 alt”的 AST 规则

核心不是找标签名,而是遍历所有 ElementNode,筛选 tagName === 'img',再检查其 attributes 数组里是否存在 name === 'alt'。注意三点:

  • parse5 的 attributes 是数组,每个元素是 { name: string, value: string | null },不能用 el.attributes.alt 这种对象取值
  • 空字符串 alt="" 是合法的,应允许;但 alt 完全缺失才报错
  • 若项目用 Vue,需额外排除 v-bind:alt 或 :alt 绑定场景,此时应检查是否存在 bindings 字段或属性名是否以 v-bind: 开头

示例片段:

anything-to-html
anything-to-html

将调研报告、方案对比、数据分析、需求梳理、会议纪要、设计说明、代码评审、学习笔记等任务产物输出为可在浏览器直接打开的单文件 HTML,替代 Markdown 作为最终交付物。Markdown 在信息密度、视觉清晰度和可分享性上已跟不上 AI 产物的丰富度,HTML 能同时承载排版、表格、SVG 等。

下载
if (node.tagName === 'img') {
  const hasAlt = node.attributes.some(attr => attr.name === 'alt');
  if (!hasAlt) {
    report(node, 'img must have alt attribute');
  }
}

插件集成到 VS Code 时,AST 分析卡顿怎么办

每次保存都全量 parse 整个 HTML 文件,在大文件(>2000 行)上会明显卡顿。根本原因是 parse5.parse() 是同步阻塞调用。解决方式只有两个:

  • 加缓存:用 Map<string ast></string> 缓存已解析内容,键为文件路径 + 文件修改时间戳(fs.statSync().mtimeMs),避免重复 parse
  • 增量分析:不重跑全树,只对比上次 AST 和当前 AST 的 node.id 或 sourceCode 哈希,仅校验变更节点及其父链(如改了某个 div,只检查它和它的祖先)

别试图用 Web Worker —— VS Code 插件 API 不支持跨线程传递 DOM 节点或 parse5 的 AST 对象,序列化成本反而更高。

AST 规则最难的不是写检测逻辑,而是准确区分“HTML 原生语法”“框架指令语法”“自定义属性语义”,比如 data-* 要不要校验格式、aria- 属性拼写是否合法、slot 在 Vue 和 Web Components 中含义不同——这些边界情况,得靠真实项目样本反复调规则,没法靠文档猜出来。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

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

下载

相关标签:

html 前端 html代码

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2523

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5463

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6490

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6118

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

863

5

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

6255

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3512

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

3170

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

3199

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 224人学习