VSCode插件调试持续集成配置

夜敏姑娘_1812

夜敏姑娘_1812

2026-09-05

453人浏览

原创

调试vscode插件时,program字段不能指向ts/js源码,必须通过extensionhost类型配置,用--install-extension参数加载已打包的.vsix文件,并配合prelaunchtask确保打包完成。

vscode插件调试持续集成配置

调试插件时 launch.json 的 program 字段必须指向 .vsix 文件

VSCode 插件本身是用 TypeScript 编写的,但调试运行时不是直接跑源码,而是加载打包后的 .vsix 包。如果你在 launch.json 里把 "program" 指向 extension.ts 或 out/extension.js,启动调试会失败并报错 Cannot find module 'vscode' 或 Extension host terminated unexpectedly。

正确做法是:确保插件已打包(vsce package),然后在调试配置中指定该 .vsix 路径:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch Extension",
      "type": "extensionHost",
      "request": "launch",
      "runtimeExecutable": "${execPath}",
      "args": [
        "--extensionDevelopmentPath=${workspaceFolder}",
        "--extensionTestsPath=${workspaceFolder}/out/test",
        "--install-extension=${workspaceFolder}/my-extension-1.0.0.vsix"
      ],
      "outFiles": ["${workspaceFolder}/out/**/*.js"],
      "preLaunchTask": "package"
    }
  ]
}
  • --install-extension 参数必须是绝对路径或相对于 ${workspaceFolder} 的有效 .vsix 文件
  • 如果没生成 .vsix,调试前务必加 "preLaunchTask": "package" 并在 tasks.json 中定义打包任务
  • Windows 下路径含空格时,--install-extension 值需用双引号包裹(VSCode 1.89+ 已修复部分场景,但保守起见仍建议加引号)

CI 环境下无法调用 VSCode UI,改用 headless 模式运行测试

GitHub Actions、GitLab CI 等持续集成环境默认无图形界面,直接运行 code --extensionDevelopment 会卡住或报错 Failed to get display。你不能依赖“弹出新窗口”这种交互式调试方式。

必须切换到 headless 测试模式,使用 vscode-test 提供的 CLI 工具:

VSCode
VSCode

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

下载
  • 安装依赖:npm install --save-dev @vscode/test-electron
  • 测试脚本示例(test/runTest.js)中调用 runTests(),传入 extensionDevelopmentPath 和 extensionTestsPath
  • CI 中执行命令:npx @vscode/test-electron --extensionDevelopmentPath=. --extensionTestsPath=./out/test
  • 注意:Electron 版本需与目标 VSCode 兼容(例如 VSCode 1.89 对应 Electron 25,不匹配会导致 ERR_CONNECTION_REFUSED)

调试器连不上 extensionHost,检查 webSocket 端口和 --disable-extensions 冲突

本地调试插件时,常见现象是断点不命中、调试控制台空白、F5 启动后立即退出。多数情况是调试通道被阻断:

  • VSCode 默认为插件调试分配一个随机 WebSocket 端口(如 ws://localhost:6060/...),若系统防火墙或公司代理拦截了该端口,调试器无法 attach
  • 某些企业策略会强制注入 --disable-extensions 启动参数,导致你的插件根本没加载——检查进程命令行:ps aux | grep code(macOS/Linux)或任务管理器详情页(Windows)
  • 调试器类型必须是 extensionHost,不是 node 或 chrome;类型写错会导致 VSCode 尝试用错误协议连接
  • 如果使用 WSL2,localhost 在 Windows 和 Linux 子系统中指向不同网络栈,需显式设 "port": 9333 并确认端口转发已开

CI 中 test runner 找不到 mocha 或找不到 test 文件,根源在 out 目录结构

插件测试通常基于 Mocha,但 CI 报错 Error: Cannot find module 'mocha' 或 No test files found 很少是依赖没装,更多是构建产物路径错位:

  • vscode-test 只认 out/test/index.js(或 out/test/suite/index.js)作为入口,不是 src/test/ 下的 TS 文件
  • 确保 tsconfig.json 的 "outDir" 设为 "out",且 "rootDir" 指向 "src";否则编译后文件散落在各处,测试 runner 扫不到
  • CI 中若用 npm ci,需确认 devDependencies 包含 mocha、chai、@types/mocha,且版本与 vscode-test 兼容(例如 v2.4+ 要求 mocha ≥10)
  • 不要在 package.json 的 "scripts" 里写 "test": "mocha out/test" —— 这绕过了 vscode-test 的沙箱环境,测的不是真实插件行为

最易被忽略的是:CI 构建阶段是否真的执行了 tsc 编译?很多 pipeline 忘记加 npm run compile 或 npm run build 步骤,导致 out/ 目录为空,测试自然失败。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1235

18

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

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

2023.07.21

2572

3

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

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

2024.03.14

1869

12

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

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

2024.03.14

1707

8

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

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

2024.03.15

2567

12

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

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

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1242

10

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

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

2024.03.15

1096

8

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

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

2024.03.15

454

5

热门下载

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

精品课程

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