怎样编写自定义Stylelint插件检测项目废弃CSS变量

阿萱酱_4445

阿萱酱_4445

2026-10-26

328人浏览

原创

Stylelint 默认不检测废弃 CSS 变量,因其仅校验语法与格式,无法构建变量声明-引用的 AST 关系;CSS 变量(--foo)属运行时作用域,需借助 PostCSS AST 手动提取声明与使用并比对,或通过插件(如 stylelint-plugin-no-unused-css-vars)定制扩展,且 SCSS/JSX 中定义的变量须前置处理才能纳入分析。

怎样编写自定义stylelint插件检测项目废弃css变量

为什么直接用 stylelint-config-standard 无法检测废弃 CSS 变量

Stylelint 默认只校验语法、格式和基础规则(比如 declaration-block-no-duplicate-properties),它不跟踪变量定义与引用关系。CSS 变量(--foo)是运行时作用域机制,没有 AST 级别的“声明-使用”双向索引,所以原生规则无法判断某个 --old-theme-color 是否在任何地方被 var(--old-theme-color) 引用过。

必须自己构建变量引用图:先收集所有 :root 或 @property 中的 --* 声明,再遍历所有 var(--*) 调用,最后取差集。

如何用 PostCSS AST 提取并比对 CSS 变量声明与使用

Stylelint 插件本质是 PostCSS 插件,所有逻辑基于 postcss 的 Root、Rule、Declaration、CustomProperty 等节点。关键不是写 CSS 解析器,而是复用 PostCSS 已解析好的结构。

CSS婚礼策划服务机构宣传网站模板
CSS婚礼策划服务机构宣传网站模板

CSS婚礼策划服务机构宣传网站模板是一款适合提供婚礼策划和婚庆服务机构宣传网站模板下载。提示:本模板调用到谷歌字体库,可能会出现页面打开比较缓慢。

下载
  • 声明提取:遍历所有 Declaration 节点,匹配 prop 以 -- 开头,且父节点是 :root 或包含 @custom-media 等上下文(注意:不能只看 :root,有些项目用 .theme-light 类做变量作用域)
  • 使用提取:遍历所有 Declaration 和 AtRule 的 params、value 字符串,用正则 /var\(--[\w-]+\)/g 提取,再用 postcss-values-parser 更可靠地解析函数参数(避免误伤注释或字符串字面量)
  • 作用域处理:若项目用 @layer 或嵌套类控制变量可见性,需记录每个变量的声明节点位置,并检查调用节点是否在同层或子层作用域内

stylelint-plugin-no-unused-css-vars 的核心实现要点

已有插件如 stylelint-plugin-no-unused-css-vars 并非开箱即用——它默认只扫描 :root,不支持 SCSS 变量注入、CSS-in-JS 字符串拼接、或通过 setProperty() 动态设置的变量。实际项目中必须定制。

  • 禁用默认声明收集,改用 root.walkDecls(decl => { if (decl.prop.startsWith('--')) { ... } }) 并手动过滤掉 /* stylelint-disable */ 注释块内的声明
  • 对 value 字段做多轮解析:先用 postcss-values-parser 解析,失败则 fallback 到正则;对 calc(var(--a) + 1px) 这类嵌套,要递归进 functionNode 子节点
  • 输出报告时,用 result.warn() 而非 result.report(),否则会阻断后续规则执行;错误信息里必须带 node.source?.start 行号,不然 VS Code 插件无法跳转

如何让插件识别 SCSS/JSX 中定义的 CSS 变量

Stylelint 只处理 CSS 文件。如果变量在 variables.scss 里定义($primary: #007bff),或在 JSX 中通过 style={{ '--bg': 'red' }} 设置,这些根本不会进入 PostCSS AST。必须前置处理。

  • SCSS 场景:用 stylelint-scss 扩展插件,在 scss-at-rule-arg 钩子中捕获 @define-mixin 或 $ 变量赋值,转换为虚拟 CSS 声明节点注入 AST
  • JSX 场景:启用 stylelint-processor-styled-components 或自定义 processor,解析 styled.div 模板字面量,在 css`` 块中提取 --* 字符串,生成模拟 Declaration 节点
  • 动态 JS 设置:这类无法静态分析,只能约定规范(如禁止在 useEffect 中调用 el.style.setProperty('--x', ...)),靠 ESLint 规则 no-restricted-syntax 拦截

真正难的不是写插件,是厘清项目里 CSS 变量到底从哪来、到哪去。没理清数据流就写检测逻辑,90% 的“废弃变量”其实是漏掉了某处动态注入路径。

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

相关文章

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

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

下载

相关标签:

css css变量

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

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

5036

6

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

1097

5

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.28

1958

6

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

2023.08.01

3866

7

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

2023.08.10

7945

11

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

2023.08.10

6731

7

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

2023.08.21

2237

9

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

2023.08.22

3231

5

css禁止点击事件
css禁止点击事件

实现css禁止点击事件的方法有使用CSS的pointer-events属性和使用JavaScript禁用点击事件。本专题为大家提供点击事件相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2833

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 6.1万人学习

CSS教程
CSS教程

共754课时 | 98.7万人学习