为自定义脚本语言编写 VS Code 调试适配器,核心是实现基于 DAP 协议的服务器端程序,通过 stdin/stdout 解析 JSON 请求、调用解释器并返回响应;需继承 DebugSession 类重写 launchRequest 等方法,集成解释器控制、断点管理、变量查询等功能,并在扩展中配置 package.json 和 launch.json 以注册调试器类型。
为自定义脚本语言编写 vs code 调试适配器,核心是实现一个调试适配器协议(debug adapter protocol, dap)的服务器端,让 vs code 能通过它与你的语言运行时通信。整个过程不复杂,但需要理解几个关键组件和流程。
理解调试适配器的工作原理
VS Code 本身并不直接理解如何调试某种语言,它依赖外部的“调试适配器”作为中间层。这个适配器运行在独立进程中,接收来自 VS Code 的 DAP 消息(如“启动程序”、“设置断点”、“继续执行”),然后将其翻译成对目标语言解释器或虚拟机的操作,并将结果返回给编辑器。
你需要做的是:实现一个程序,监听标准输入输出(stdin/stdout),解析 JSON 格式的 DAP 请求,执行相应逻辑,并返回响应。
选择实现方式与工具
你可以用任何语言编写调试适配器,只要能处理 JSON 和进程通信。常用选择包括 TypeScript/Node.js,因为有官方提供的 vscode-debugadapter 库,极大简化开发。
步骤概览:- 创建 Node.js 项目,安装 vscode-debugadapter 和 vscode-debugprotocol
- 继承 DebugSession 类,重写关键方法如 launchRequest、attachRequest、setBreakPointsRequest 等
- 在适配器中集成你的脚本语言解释器或控制外部进程
- 使用 readLine 监听 stdin,将收到的消息交给 DebugSession 处理
处理核心调试功能
适配器必须支持基本调试操作。以启动调试为例:
- launchRequest:用户点击“启动调试”时触发。你需启动你的脚本解释器,可以是在同一进程模拟,或 spawn 子进程
- setBreakPointsRequest:VS Code 发来当前文件的断点列表。你需要记录这些位置,并在解释器执行时判断是否命中
- 当脚本暂停(如遇到断点),调用 sendEvent(new StoppedEvent('breakpoint', threadId)) 通知 VS Code
- 响应 stackTraceRequest:返回调用栈信息,通常包含文件、行号、作用域 ID
- 响应 scopesRequest 和 variablesRequest:提供当前作用域的变量列表及其值,便于调试面板展示
配置 launch.json 并注册适配器
在你的 VS Code 扩展(extension)中,需在 package.json 的 contributes.debuggers 中声明调试器类型、启动命令、支持的语言等。
用户创建 .vscode/launch.json 时会看到你的调试器选项。例如 type 设为 “mylang”,那么你的适配器需能处理该类型的请求。
启动时,VS Code 会按配置运行你的适配器程序(如 node debugAdapter.js),建立双向通信通道。
基本上就这些。关键是把 DAP 请求映射到你的语言运行时行为。即使解释器很简单,只要能暂停、查变量、走一步,就能做出可用的调试体验。测试时可用 Debug Console 输出日志,逐步验证各请求响应是否正确。










