首页
/ Stylelint 处理 SCSS 文件中双斜杠注释的注意事项

Stylelint 处理 SCSS 文件中双斜杠注释的注意事项

2025-05-21 02:45:44作者:宣聪麟

问题现象

在 SCSS 文件中使用双斜杠(//)注释时,如果注释内容中包含 CSS 声明(如 color: var(...)),Stylelint 可能会报出 "Unknown word" 错误。这种问题常见于以下情况:

.radio-button {
  span {
    font-size: 15px;
    
    // 注释中包含CSS声明: color: var(--custom-color)
  }
}

问题原因

这个问题的根本原因是 Stylelint 默认使用标准的 CSS 解析器,而 SCSS 特有的语法(如双斜杠注释)需要专门的 SCSS 解析器来处理。

当注释中包含类似 CSS 声明的文本时,默认解析器会尝试将其解析为有效的 CSS,从而导致语法错误。

解决方案

要正确解析 SCSS 文件,需要在 Stylelint 配置中指定 postcss-scss 作为自定义语法解析器:

{
  "customSyntax": "postcss-scss",
  "plugins": ["stylelint-scss"],
  "rules": {}
}

最佳实践

  1. 统一注释风格:在 SCSS 项目中,建议统一使用 /* */ 注释而非 // 注释,除非确实需要行注释

  2. 配置继承:可以使用 stylelint-config-recommended-scss 预设配置,它已经包含了正确的 SCSS 解析设置

  3. 注释内容规范:避免在注释中直接写入完整的 CSS 声明,可以用自然语言描述

  4. 构建工具集成:在 Webpack 等构建工具中,确保相关的 Stylelint 插件也配置了正确的 SCSS 解析器

扩展知识

SCSS 的双斜杠注释在编译后会从生成的 CSS 中移除,而 /* */ 注释则会根据压缩设置决定是否保留。这也是为什么标准 CSS 解析器可能无法正确处理 SCSS 注释的原因之一。

对于大型项目,建议建立统一的样式规范,包括注释书写规范,以避免这类解析问题和提高代码可维护性。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8