讲师中心 微信公众号
AI工具推荐 视频效率加速

怎样为CSS Modules自动生成精确的d.ts类型声明文件

落强同学_2727

落强同学_2727

发布时间:2026-10-23 12:32:29

|

207人浏览过

|

来源于php中文网

原创

css-module-types可为每个.module.css生成精确.d.ts文件,导出带引号的类名如export const 'btn-primary': string,实现IDE跳转、提示及拼写报错,需确保路径匹配且tsconfig.include覆盖。

怎样为css modules自动生成精确的d.ts类型声明文件

用 css-module-types 生成精确的 .d.ts 文件

手动写 declare module '*.module.css' 只能给 styles 加上 { [key: string]: string },IDE 不知道 styles.button 是否真实存在。要让类名可跳转、可提示、拼错就报错,必须把 CSS 文件里实际定义的类名“翻译”成类型声明——css-module-types 就是干这个的。

它不依赖插件或运行时,纯静态分析,生成的 .d.ts 和源文件一一对应,TypeScript 直接读取,零配置生效。

  • 运行 npx css-module-types src/**/*.module.css,会为每个匹配文件生成同名 .d.ts(如 Button.module.css → Button.module.css.d.ts)
  • 生成文件必须和原 CSS 文件在**同一目录**,否则 TS 找不到;tsconfig.json 的 include 也要覆盖该路径(例如 "include": ["src/**/*", "types/**/*"])
  • 支持 .module.scss、.module.less 等,但需确保文件名含 .module.,且正则能匹配到(默认已支持)
  • 首次生成后建议加 --watch: npx css-module-types src/**/*.module.css --watch,CSS 类名增删会自动更新类型文件

typescript-plugin-css-modules 动态补全 vs 静态 .d.ts 的区别

这个插件不是生成文件,而是让 TypeScript 语言服务在内存中“实时推导”类名,对 .tsx 文件生效,但不产出物理 .d.ts。它快、轻量,但有硬性前提:

  • VSCode 必须使用工作区的 TypeScript("typescript.tsdk": "node_modules/typescript/lib"),否则插件加载失败
  • 只对 .ts/.tsx 生效,.js 文件里 import styles from './x.module.css' 依然无提示
  • 如果项目用了 Vite,vite-plugin-dts 默认不打包这些动态类型,导出库时会丢类型
  • CI 构建或非 VSCode 编辑器(如 Vim + tsserver)无法享受补全,而静态 .d.ts 文件天然跨环境

为什么 typed-css-modules(tcm)现在不太推荐

tcm 曾经是主流方案,但它在 2025 年后逐渐暴露问题:

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

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

下载

立即学习“前端免费学习笔记(深入)”;

  • 不支持嵌套选择器提取(比如 .container .item 不会生成 item 类型)
  • 对 @value、composes、:global 等 CSS Modules 特性解析不稳定
  • 输出格式固定为 export const xxx: string,无法处理带连字符的类名(如 btn-primary)——除非手动加引号,但 tcm 不生成
  • css-module-types 输出的是 export const 'btn-primary': string,TS 支持,IDE 也认,更贴近真实 CSS 类名语义

生成的 .d.ts 文件要怎么写才不出错

别手写,但得知道生成结果长什么样,否则调试时容易误判。正确示例(来自 Button.module.css.d.ts):

export const 'primary': string;
export const 'disabled': string;
export const 'btn-large': string;

关键点:

  • 类名含连字符、数字开头等非法标识符,必须用单引号包裹,不能写成 export const primary
  • 不要加 declare module 或 export default ——这是模块声明文件(css-modules.d.ts)的事,这里是具体实现文件的类型映射
  • 不要手动修改生成的 .d.ts,它会被覆盖;如有特殊需求(如重命名类名),应在 CSS 源文件里改,再重新生成
  • 如果发现某个类名没出现在 .d.ts 中,先检查它是否被 :global 包裹,或是否在媒体查询/嵌套规则里——css-module-types 默认只提取顶层类名
真正麻烦的不是生成,而是让生成结果被 TypeScript 正确识别:路径对不上、include 漏了、文件名不匹配 .module.css,这三个地方错一个,就等于没生成。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
css
css

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

4956

2023.06.15

css居中
css居中

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

1077

2023.07.27

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

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

1938

2023.07.28

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

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

3806

2023.08.01

css字体颜色
css字体颜色

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

7785

2023.08.10

什么是css
什么是css

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

6591

2023.08.10

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

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

2197

2023.08.21

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

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

3151

2023.08.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 6万人学习

CSS教程
CSS教程

共754课时 | 98.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn