针对VSCode插件市场开发多语言支持插件的本地化方法

冬晨君_8062

冬晨君_8062

2026-08-29

517人浏览

原创

vscode.l10n.t()是vs code 1.80+推荐的唯一运行时翻译方式,需在package.json声明"l10n"字段、使用utf-8无bom的package.nls.zh-cn.json文件、key严格匹配,且contributes文案须用%key%占位而非直接调用t()。

针对vscode插件市场开发多语言支持插件的本地化方法

vscode.l10n.t() 是当前唯一推荐的运行时翻译方式

VS Code 1.80+ 版本已正式弃用 vscode-nls 工具链,vscode.l10n.t() 成为插件本地化的事实标准。它不依赖构建步骤,也不需要 webpack loader 配置,但要求你严格遵守几个前提:

  • 必须在 package.json 中声明 "l10n": "./nls" 字段,指向存放 .nls.*.json 的目录(通常为根目录)
  • package.nls.jsonpackage.nls.zh-cn.json 必须同级存在,且 key 完全一致
  • 调用 vscode.l10n.t() 时,第一个参数必须是字符串字面量(如 "saveConfirm"),不能是变量或拼接结果,否则编译期无法提取到资源文件
  • 所有 .json 文件必须保存为 UTF-8 无 BOM 编码——Windows 记事本默认带 BOM,极易导致中文解析失败并显示为空白或乱码

配置项(contributes)里的文案根本不会走 l10n 流程

这是最容易被忽略的盲区:package.jsoncontributes.commandscontributes.configurationcontributes.menus 等字段里的 "title""description" 等文案,**完全不经过 vscode.l10n.t() 或任何运行时翻译逻辑**。VS Code 在加载插件 manifest 时就直接读取这些字符串。

  • 正确做法是:把这些文案全部挪进 package.nls.json,并在 package.json 中用 %key% 占位,例如 "title": "%command.save.title%"
  • 确保 package.nls.json 里有对应 key:"command.save.title": "保存文件"
  • 注意:这种占位符只对 contributes 生效,对代码中 vscode.window.showInformationMessage() 这类调用无效,后者仍需显式调用 vscode.l10n.t()

打包时中文资源没嵌入?检查 vsce 的工作路径和文件匹配

vsce package 默认只打包 package.jsonmainiconlicense 等显式声明的路径,.nls.*.json 文件不会自动包含——除非它们被识别为本地化资源。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 确认 package.json"l10n" 字段值(如 "./nls")与实际目录名完全一致,大小写敏感
  • 确保 .nls.*.json 文件位于该目录下,且文件名符合 package.nls.{locale}.json 格式(如 package.nls.zh-cn.json
  • 运行 vsce package --no-yarn 时观察控制台输出:若看到 Found 2 language packs 类提示,说明识别成功;若无声无息,大概率路径或命名不匹配
  • 打包后解压 .vsix 文件,手动检查 extension/ 目录下是否存在 package.nls.zh-cn.json —— 没有它,用户装了插件也看不到中文

用户语言是 zh-cn,但插件里 vscode.env.language 返回 en?

这不是 bug,而是 VS Code 启动时序问题:插件 activate() 执行时,语言环境可能尚未初始化完成,vscode.env.language 会暂时返回 fallback 值(通常是 "en")。

  • 不要在 activate() 开头就依赖 vscode.env.language 做条件加载
  • 改用 vscode.l10n.t() —— 它内部会自动监听语言变更,并在环境就绪后重渲染,无需你手动处理延迟
  • 如果必须提前读取语言(比如初始化 Webview 资源路径),可加一层判断:if (vscode.env.language !== 'en') { /* 可信 */ },或监听 vscode.env.onDidChangeLanguage 事件
  • 测试时务必重启 VS Code(不是重载窗口),否则旧语言缓存可能残留

真正麻烦的从来不是“怎么加中文”,而是确保每个文案都走对路径:contributes 用 %key%、运行时用 vscode.l10n.t()、打包时文件不丢、用户语言变化时能响应——漏掉任意一环,那个按钮或那条提示就永远卡在英文上。

相关文章

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

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

下载

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

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1135

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2252

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1789

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1587

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2487

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1758

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1202

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1076

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

394

5

热门下载

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

精品课程

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