VSCode插件调试之模拟不同用户配置与环境测试-VSCode-PHP中文网

vs code插件调试必须启动隔离的extension host实例并注入自定义settings.json和扩展，因测试进程不读取本地用户设置或已装扩展；需通过vscode-test显式安装依赖、指定临时目录，并确保配置在package.json中声明且作用域正确。

vscode插件调试之模拟不同用户配置与环境测试

VS Code 插件调试时，不能靠改全局设置或手动切换用户配置来模拟不同环境——那样既不可控，又无法复现 CI 场景。真正可行的方式是启动隔离的 Extension Host 实例，并显式注入自定义 settings.json 和 extensions 状态。

插件测试运行在独立的 Extension Host 进程中，它不读取你本地 VS Code 的用户设置（~/.vscode/settings.json 或 GUI 中的设置），也不加载你已安装的扩展。你看到的“设置生效了”，只是编辑器主进程的行为，和测试进程完全无关。

常见错误现象：

vscode-test 提供了 launchFromPath 和 installExtensions 两个关键能力，配合临时工作区目录，可精准控制测试环境。

实操建议：

在测试前创建一个干净临时文件夹，写入你的目标 settings.json（例如启用/禁用某功能、设 mock token）
调用 installExtensions(['ms-python.python', 'esbenp.prettier-vscode']) 显式安装依赖扩展（路径需为 .vsix 或 marketplace ID）
启动时传入 extraArgs: ['--user-data-dir', tempUserDataDir, '--extensions-dir', tempExtensionsDir]
确保 testRunner.js 中的 run() 函数在 Extension Host 加载完成后才执行断言，否则 vscode.workspace.getConfiguration() 可能尚未就绪

即使用了 vscode-test，配置仍可能“看不见”，原因很具体：

VSCode

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

下载

配置项未在插件的 package.json 的 contributes.configuration.properties 中声明——VS Code 不会将其注入到配置 API
你在 settings.json 里写了 "myExt.logLevel"，但插件只声明了 "myExt.verbose"，字段名必须完全一致
配置作用域写错：用户级配置（application）不会自动覆盖工作区级（resource）配置；测试时建议统一用 resource 级并指定 uri 参数

示例验证方式：

const config = vscode.workspace.getConfiguration('myExt', vscode.Uri.file('/fake/path'));
console.log(config.inspect('logLevel'));

看 workspaceValue 和 defaultValue 是否匹配预期。

插件若使用 context.globalState 或 context.workspaceState 存数据，测试间容易污染——哪怕你每次新建 tempUserDataDir，如果没在 beforeEach 中显式清除，上一次测试写入的值可能还在。

正确做法：

在 beforeEach 中调用 extension?.activate() 前，先清空 globalState 的 key（可用 globalState.keys().forEach(k => globalState.delete(k))）
避免在 activate() 外部初始化单例状态管理器；所有状态读写应绑定到当前 ExtensionContext
CI 环境中禁止依赖 process.env 传递配置——它不随 Extension Host 隔离，会导致跨测试泄漏

真实项目里，80% 的“本地能过、CI 报错”问题，都卡在这类状态残留上。