typescript-plugin-css-modules

typescript-plugin-css-modules

TypeScript语言服务插件实现CSS Modules智能提示功能

typescript-plugin-css-modules是一款TypeScript语言服务插件,为CSS Modules提供类型信息和智能提示功能。该插件支持多种CSS预处理器,允许自定义类名转换、渲染器和模板。它增强了IDE和其他开发工具对TypeScript的支持,提升开发效率,但不干扰编译过程。插件配置简便,兼容Visual Studio Code,并提供多样化的自定义选项,以满足各类项目需求。

TypeScriptCSS Modules插件IDE开发工具Github开源项目

typescript-plugin-css-modules

npm npm license

这是一个用于 CSS ModulesTypeScript 语言服务插件

<img src="https://yellow-cdn.veclightyear.com/835a84d5/8aaacf9c-0ad8-4ff0-8547-09afcde2078d.gif" alt="typescript-plugin-css-modules 示例" />

目录

关于此插件

此插件为 IDE 和其他使用 TypeScript 语言服务插件 的工具提供类型信息。

目前,TypeScript 在编译过程中不支持插件。这意味着此插件无法:

  • 在编译过程中提供错误信息,或
  • 为您的项目添加 CSS 模块支持。

有关更多信息,或者要添加对此功能的支持,请参阅:https://github.com/microsoft/TypeScript/issues/16607。

如果您需要其他解决方案,这些项目可能会有帮助:

安装

使用 Yarn 安装:

yarn add -D typescript-plugin-css-modules

使用 npm 安装:

npm install -D typescript-plugin-css-modules

安装完成后,将此插件添加到您的 tsconfig.json 中:

{ "compilerOptions": { "plugins": [{ "name": "typescript-plugin-css-modules" }] } }

如果您使用的是 Visual Studio Code,请同时按照这些说明进行操作。

由于 Webpack 配置各不相同,您可能需要为此插件提供额外的选项以匹配您的项目配置。对于 Create React App 用户,此插件无需额外配置即可工作。

导入 CSS

您的 CSS 模块始终提供默认导出。

import styles from 'my.module.css'; const a = styles.myClass; const b = styles['my_other-class'];

从版本 1.1.0 开始,您还可以对不包含连字符或下划线的类使用命名导出。您仍然可以通过默认导出访问其他类。

import styles, { myClass } from 'my.module.css'; const a = myClass; const b = styles['my_other-class'];

选项

请注意,没有任何选项是必需的。但是,根据您的配置,您可能需要自定义这些选项。

选项默认值描述
additionalDataundefined一个可选的字符串,附加到源文件的顶部。
allowUnknownClassnamesfalse禁用 TypeScript 对未知类名的警告(仅适用于默认导入)。
classnameTransform"asIs"请参阅下面的 classnameTransform
customMatcher"\\.module\\.((c|le|sa|sc)ss|styl)$"更改此插件处理的文件扩展名。
customRendererfalse请参阅下面的 customRenderer
customTemplatefalse请参阅下面的 customTemplate
goToDefinitionfalse启用跳转到定义功能。请参阅下面的 goToDefinition
noUncheckedIndexedAccessfalse启用以兼容 TypeScript 的 noUncheckedIndexedAccess
namedExportstrue为兼容的类名启用命名导出。
dotenvOptions{}提供 dotenv 的选项。请注意,此插件仅接受 pathstring 值。
postcssOptions{}请参阅下面的 postcssOptions
rendererOptions{}请参阅下面的 rendererOptions
{ "compilerOptions": { "plugins": [ { "name": "typescript-plugin-css-modules", "options": { "classnameTransform": "dashes", "customMatcher": "\\.m\\.css$", "customRenderer": "./myRenderer.js", "dotenvOptions": {}, "postcssOptions": {}, "rendererOptions": {} } } ] } }

classnameTransform

实现 localsConvention css-loader 选项的行为。

可用选项有:'asIs''camelCase''camelCaseOnly''dashes''dashesOnly'

customRenderer

customRenderer 是一个高级选项,允许您提供 CSS 渲染器。

当提供自定义渲染器时,不会使用其他渲染器。

customRenderer 的路径必须相对于项目根目录(例如 ./myRenderer.js)。

自定义渲染器本身应该是一个 JavaScript 文件。该函数将被调用,并传入三个参数:一个 css 字符串、一个 options 对象(参见 options.ts)和一个 compilerOptions 对象 - 包含在 tsconfig.json 中设置的选项。它必须是同步的,并且必须返回有效的 CSS。

module.exports = (css, { fileName, logger }) => { try { // ...在这里处理您的 css。 // `string` return renderedCss; } catch (error) { logger.error(error.message); } };

如果您想返回源映射,可以从导出的函数返回一个对象。

module.exports = (css, { fileName, logger }) => { try { // ...在这里处理您的 css。 return { // `string` css: renderedCss, // `RawSourceMap` sourceMap: sourceMap, }; } catch (error) { logger.error(error.message); } };

您可以在我们的测试固件中找到自定义渲染器的示例(customRenderer.js)。

提供内部 logger 用于调试

如果您使用 Webpack,请注意 Less 和 Sass 原生不支持波浪线(~)导入。

对于 Sass 用户:从 v3 开始,已实现自定义导入器来解决此问题。

对于 Less 用户:此包导出了一个启用波浪线导入的自定义渲染器:less-plugin-aliases

customTemplate

customTemplate 是一个高级选项,允许您为生成的 TypeScript 声明提供模板。

提供自定义模板时,其输出将用作虚拟声明(*.d.ts)文件。

customTemplate 的路径必须相对于项目根目录(例如 ./customTemplate.js)。

自定义渲染器本身应该是一个 JavaScript 文件。该函数将被调用,并传入两个参数:一个 dts 字符串和一个 options 对象(参见 options.ts)。它必须是同步的,并且必须返回有效的 TypeScript 声明(如 .d.ts 文件中所示)。

module.exports = (dts, { classes, fileName, logger }) => { try { // ...在这里生成您的模板。 return customTemplate; } catch (error) { logger.error(error.message); } };

你可以在我们的测试固件中找到一个自定义模板示例(customTemplate.js)。

提供内部logger用于调试

classes对象代表从CSS模块中提取的所有类名。如果你想为CSS类添加自定义表示,可以使用它们。

goToDefinition

这允许像Visual Studio Code这样的编辑器跳转到类名的定义(文件和行)。

这是实验性的,可能并不总是按预期工作。它当前支持CSS/PostCSS、Less和Sass。如果发现有什么不起作用,请提出问题。

postcssOptions

选项默认值描述
useConfigfalse设置为true以从你的PostCSS配置加载插件。
excludePluginsfalse仅支持同步插件。使用此选项设置要排除的异步插件数组(例如['postcss-mixins']

rendererOptions

选项默认值描述
less{}设置Less的渲染器选项
sass{}设置Sass的渲染器选项
stylus{}设置Stylus的渲染器选项

为方便起见,Sass的loadPaths是扩展而不是替换。默认值是当前文件的路径和'node_modules'

Visual Studio Code

推荐用法

要在Visual Studio Code中使用此插件,你应该设置工作区的TypeScript版本,它将从你的tsconfig.json文件加载插件。

有关说明,请参阅:使用工作区版本的TypeScript

替代用法

如果你没有使用任何插件选项,你可以简单地将此插件添加到设置中的"typescript.tsserver.pluginPaths"。使用这种方法无法提供插件选项。

{ "typescript.tsserver.pluginPaths": ["typescript-plugin-css-modules"] }

自定义定义

注意:如果你使用的是react-scripts@2.1.x或更高版本,Create React App用户可以跳过此部分。

如果你的项目还没有CSS模块的全局声明,你需要添加这些声明以帮助TypeScript在构建过程中理解导入的CSS的一般形状。

你可以自行决定存储全局声明的位置。一个例子可能看起来像:./src/custom.d.ts

以下是一个你可以复制或修改的示例(你只需要为项目中使用的扩展名添加声明)。如果你使用customMatcher,你需要修改这个。

declare module '*.module.css' { const classes: { [key: string]: string }; export default classes; } declare module '*.module.scss' { const classes: { [key: string]: string }; export default classes; } declare module '*.module.sass' { const classes: { [key: string]: string }; export default classes; } declare module '*.module.less' { const classes: { [key: string]: string }; export default classes; } declare module '*.module.styl' { const classes: { [key: string]: string }; export default classes; }

故障排除

对于故障排除和调试,你可以在Visual Studio Code中通过在命令面板中输入Typescript: Open TS Server log来查看TypeScript Server日志。

如果你没有使用Visual Studio Code或在使用上述方法时遇到问题,你可以设置TSS_LOG环境变量

你可以在为此项目提出的任何问题中包含这些日志。

禁用插件

如果你需要临时禁用此插件,或为单个用户禁用它,你可以通过将DISABLE_TS_PLUGIN_CSS_MODULES环境变量设置为任何值来实现,然后重启你的IDE。

请注意,这实际上并不会禁用插件,而是导致它提前退出。有关更多信息,请参见PR #244。

关于此项目

这个项目受到Create React App的一个问题的启发, 并基于css-module-types的前期工作而构建。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多