使用honey-css-modules快速上手指南
2025-06-19 15:32:15作者:范垣楠Rhoda
什么是honey-css-modules
honey-css-modules是一个为TypeScript项目提供完整CSS Modules支持的解决方案。它通过一系列工具链的配合,为开发者提供类型安全的CSS Modules开发体验,包括:
- 编辑器智能提示支持
- 类型定义生成
- 静态类型检查
- 代码质量检查
环境准备
编辑器插件安装
首先需要为你的代码编辑器安装CSS Modules语言支持插件。不同编辑器的安装方式如下:
- VS Code用户:安装CSS Modules Kit扩展
- Neovim用户:需要安装ts-plugin并进行相应配置
- Zed编辑器:参考相关文档进行配置
- 其他编辑器:目前Emacs和WebStorm暂不支持
编辑器插件会为CSS Modules文件提供语法高亮、自动补全等语言特性支持。
核心工具链配置
代码生成器安装
虽然编辑器插件能提供类型提示,但在命令行执行类型检查时(tsc)这些类型不会生效。为此需要安装代码生成器:
npm install --save-dev @css-modules-kit/codegen
然后在package.json中配置构建脚本:
{
"scripts": {
"gen": "cmk",
"build": "run-s -c gen build:*",
"build:vite": "vite build",
"lint": "run-s -c gen lint:*"
}
}
这样在执行构建或lint前,会先运行cmk命令生成*.module.css.d.ts类型定义文件。
TypeScript配置
需要调整tsconfig.json以确保类型系统正常工作:
-
include配置:确保包含CSS Modules文件
- 推荐:
["src"]或["src/**/*"] - 不推荐:仅包含TypeScript文件如
["src/**/*.ts"]
- 推荐:
-
rootDirs配置:需要包含生成目录
{ "compilerOptions": { "rootDirs": [".", "generated"] } }
完整配置示例:
{
"compilerOptions": {
"target": "ESNext",
"module": "NodeNext",
"strict": true,
"rootDirs": [".", "generated"]
}
}
可选增强功能
代码质量检查
项目提供了两种风格的lint插件,功能相同但适用于不同工具链:
- stylelint插件:适合已使用stylelint的项目
- eslint插件:适合已使用eslint的项目
选择其中一种安装即可为CSS Modules添加静态检查能力。
自定义配置
可以通过tsconfig.json中的cmkOptions字段自定义代码生成行为,例如:
- 生成目录位置
- 文件匹配模式
- 类型定义格式等
最佳实践建议
- 项目结构:建议将CSS Modules文件与组件文件放在同一目录
- 命名规范:使用
.module.css后缀明确标识CSS Modules文件 - 构建流程:确保在类型检查和构建前执行代码生成
- 版本控制:建议将生成的类型定义文件加入.gitignore
通过以上配置,你的TypeScript项目将获得完整的CSS Modules支持,包括开发时的智能提示和构建时的类型安全保证。
登录后查看全文
热门项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
deepin linux kernel
C
23
6
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
238
2.36 K
仓颉编程语言运行时与标准库。
Cangjie
122
95
暂无简介
Dart
539
117
仓颉编译器源码及 cjdb 调试工具。
C++
114
83
React Native鸿蒙化仓库
JavaScript
216
291
Ascend Extension for PyTorch
Python
77
109
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
995
588
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
568
113
LLVM 项目是一个模块化、可复用的编译器及工具链技术的集合。此fork用于添加仓颉编译器的功能,并支持仓颉编译器项目。
C++
32
25