必须将插件源码根目录改为纯英文路径,因vsce及底层zip-stream在windows下无法正确处理中文路径,导致enoent等错误,配置无法修复,需统一构建输出路径并避免硬编码中文资源名。

VSCode插件开发时,vsce package 报错“路径包含中文”怎么办?
根本原因不是 VSCode 本身不支持中文路径,而是 Node.js 生态中部分工具(尤其是 vsce 和底层的 zip-stream)在 Windows 上对非 ASCII 路径处理不一致,导致打包时读取 package.json 或资源文件失败,典型错误如:ENOENT: no such file or directory, open 'D:\项目\my-ext\package.json'。
这不是配置问题,是工具链限制。临时规避方式有限,长期应主动规避中文路径:
- 插件源码根目录必须全英文(如
D:\dev\my-extension),不能含空格、中文、特殊符号 -
vsce package命令必须在该英文路径下执行,不能从中文路径的终端启动 - 若用 PowerShell 或 CMD,确认当前
$PWD或cd后路径为纯英文;WSL 中也要检查挂载路径是否映射到中文 Windows 目录 - VS Code 工作区打开的也是这个英文路径——即使设置里写了
"files.autoSave": "onFocusChange",中文路径下仍可能触发底层 fs 模块乱码
插件调试时 launch.json 的 outFiles 路径含中文,断点不命中
VS Code 插件调试依赖 Source Map 映射,而 outFiles 字段用于告诉调试器去哪里找生成的 JS 文件。一旦路径含中文,Node.js 的 source-map-support 模块常无法正确解析原始 TS 文件位置,导致断点灰掉或跳转失效。
关键不是改配置,而是统一构建输出路径:
- 在
tsconfig.json中强制指定"outDir": "./dist"(固定英文名) -
launch.json中outFiles改为:["${workspaceFolder}/dist/**/*.js"],避免任何变量拼接中文路径 - 删除
dist目录后重新运行npm run compile,确认生成的 JS 文件路径确实不含中文(比如不要让workspaceFolder是C:\用户\张三\vscode-ext) - 如果必须用中文用户名,把项目放在
D:\ext\my-plugin这类路径,而非C:\Users\张三\...
插件发布后,用户安装时报 Extension host terminated unexpectedly
这不是你本地环境的问题,而是你的插件代码里硬编码了中文路径——比如用 path.join(__dirname, '配置文件.txt') 加载资源,当用户系统 locale 是英文、且文件名含中文时,Node.js fs.readFile 会因编码歧义直接抛错。
安全做法只有一条:所有资源路径用英文命名,且通过 vscode.workspace.getConfiguration() 或 context.extensionPath 动态拼接:
- 静态资源(图标、模板)全部重命名为英文,如
icon.svg、template.json - 运行时需读取的配置文件,不要依赖用户文件系统路径,改用
vscode.workspace.openTextDocument()+ URI 方式加载 - 绝对不要在
activate()里写fs.readFileSync(path.join(__dirname, '说明.md'))——中文文件名在某些 locale 下会 decode 失败 - 如果真要支持多语言文案,把文本内容放进
package.nls.json,走 VS Code 官方国际化机制
为什么改了 locale.json 还是看到英文插件界面?
插件自身的 UI 文字(比如命令面板里的命令名、设置项 label)是否显示中文,和 VS Code 主体语言无关,取决于插件是否内置了 package.nls.json 和对应语言包。你本地改 locale.json 只影响 VS Code 自身菜单、设置页等,不影响第三方插件。
如果你正在开发插件并希望它支持中文:
- 必须在插件根目录添加
package.nls.json(主语言)和package.nls.zh-cn.json -
package.json中声明:"contributes": { "configuration": { "properties": { "myext.enable": { "type": "boolean", "default": true, "description": "%myext.enable.description%" } } } } - 对应 key
myext.enable.description必须在package.nls.zh-cn.json里定义,值为中文字符串 - 发布前运行
vsce package --yarn,确保 nls 文件被打进 .vsix 包内(可解压 .vsix 验证)
真正容易被忽略的是:插件里所有用户可见字符串都必须走 nls 占位符,硬编码中文会导致其他语言用户看到乱码,且 VS Code 不会自动 fallback。











