怎么在现代前端工程中用ESLint校验CSS BEM类名?

阿涛吖_9668

阿涛吖_9668

2026-11-07

864人浏览

原创

ESLint本身不校验CSS类名,因其仅将className视为普通字符串而不解析结构;需借助eslint-plugin-css-modules等插件,结合正则与模块化约束,才能实现BEM等规范的静态校验。

怎么在现代前端工程中用eslint校验css bem类名?

为什么 ESLint 本身不校验 CSS 类名

ESLint 是 JavaScript/TypeScript 代码检查器,className 字符串里的类名(如 "user-card__avatar--large")对它来说只是普通字符串,不会被解析为 BEM 结构。你写 className="btn__icon btn--primary" 或 className="Button-icon",ESLint 默认完全无感——除非你告诉它“这段字符串要按 BEM 规则验证”。

必须用 eslint-plugin-css-modules + 自定义规则

在 React/Vue/Svelte 单文件组件中校验 className 是否符合 BEM,核心是两步:

  • 安装插件:npm install --save-dev eslint-plugin-css-modules
  • 在 .eslintrc.cjs 中启用并配置规则,重点是 css-modules/no-invalid-classname 和自定义正则

示例配置片段(适配 user-card.module.scss):

rules: {
  'css-modules/no-invalid-classname': ['error', {
    'allowedPattern': '^user-card(__[a-z][a-zA-Z0-9]*)?(--[a-z][a-zA-Z0-9]*)?$',
    'disallowPartialMatches': true
  }]
}

这个正则强制:只允许以 user-card 开头,后面可跟 __xxx 或 --xxx,且不允许 user-card__title--large 以外的任意组合(比如 user-card__title__icon 会报错)。

React 中 className 拼接是最大漏检点

以下写法会让所有 BEM 校验失效:

精英前端设计-专业版
精英前端设计-专业版

企业级前端设计系统,支持多页面应用、React/Vue组件、品牌一致性与高级动效编排。

下载
  • className={`user-card ${isActive ? 'user-card--active' : ''}`} —— ESLint 只看到字符串模板,无法静态分析分支结果
  • className={styles['user-card__icon']} —— 如果 styles 来自非本模块的 CSS Modules 文件,插件默认不跨文件校验
  • className={clsx('user-card', `user-card__${type}`)} —— 动态拼接部分脱离正则约束

正确做法是:只允许显式字面量、且全部来自当前模块的 styles 对象键名。例如:

import styles from './UserCard.module.scss';
// ✅ 安全:key 必须在 UserCard.module.scss 中声明过
<div classname="{styles['user-card']}"></div>
@@##@@

Vue/Svelte 的

ESLint 默认跳过 内容,但 BEM 类名定义源头就在那里。要让校验闭环,必须:

  • 确保 stylelint-selector-bem-pattern 已配置好 preset、componentName、ignoreSelectors 三项(否则 .btn-primary 这类会漏检)
  • 用 eslint-plugin-vue 或 eslint-plugin-svelte 的 no-unused-vars 类规则,配合 vue/compiler-sfc 解析器,把 中声明的类名提取出来,和 中实际使用的做比对
  • 禁止在 中硬编码类名:
    → 必须用 :class="styles['user-card__title']"(SFC 场景)

    没这层联动, 里写了 .user-card__title,但模板里用了 user-card-title,ESLint 就永远发现不了。

    BEM 校验真正卡住问题的不是正则多严,而是能否把「定义处」「引用处」「拼接处」三端全部纳入同一套规则引擎——漏掉任意一环,就等于给违规开后门。

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

相关文章

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

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

下载

相关标签:

css 前端

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

相关专题

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

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

2023.08.11

2863

5

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

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

2023.10.09

6263

6

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

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

2024.03.19

7170

13

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

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

2024.03.22

6998

10

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

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

2024.05.22

1003

5

css
css

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

2023.06.15

5476

6

css居中
css居中

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

2023.07.27

1177

5

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

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

2023.07.28

2058

6

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

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

2023.08.01

4146

7

热门下载

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

精品课程

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

共14课时 | 1.6万人学习