Skip to content

docs: API 4 调试适配器插件指南,等级表与示例补上 LLDB - #3

Merged
xiaoyumuxi merged 2 commits into
mainfrom
docs/api-4-debug-adapters
Oct 26, 2026
Merged

xiaoyumuxi merged 2 commits into
mainfrom
docs/api-4-debug-adapters

Conversation

@xiaoyumuxi

@xiaoyumuxi xiaoyumuxi commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

为插件 API 4(调试适配器)补开发者文档。主仓库 1lck/Lithe-IDEA#1512 已合并,契约镜像已同步到 32021a86f。

改动

  • 新增 guides/debug-adapter-plugin.md(编写调试适配器插件):插件和宿主各自负责什么、最小清单、三种启动方式(packaged / systemCommand / runSelectedRuntime)、调试前要先编译的语言怎么用 executable、调试控制台的 commandPrefix 与 commands[]、本地验证、免重启、发布(预发布到转正)、当前边界(目前只有 macOS 宿主实现)。最小清单已用主仓库 Core 校验通过。
  • README.md:
    • 等级表补上 API 4 一行(LLDB,预发布),API 3 一行补上 VCS 提供者。
    • 说明 API 3 及以上必须在 requires 里逐项声明能力,API 4 需要支持它的 Lithe(只有 macOS)。
    • 示例表补上 LLDB 调试器。
    • 教程表加上新指南。

契约同步

指南链接到 contract/v1/README.md#api-level-4-debug-adapters,这一节随 #1512 进入主仓库契约。本 PR 的第二个提交已用 node scripts/contract.mjs sync --revision 32021a86f0c6c4ad2964dbbe3c2bb7854d84ad67 同步镜像(contract.lock.json、README、plugin-manifest.schema.json,以及新增的 debug-adapter.plugin.json、debug-adapter-rejections.json 两个 fixture),没有手改镜像。

插件后端协议没有改动;CI 里的“SDK end-to-end with Rust Core”也已通过。

验证

  • node scripts/contract.mjs verify 通过(当前镜像)
  • node --test scripts/*.test.mjs:13 个测试通过
  • 同步后:node scripts/contract.mjs verify 通过;CI 全部通过(Contract mirror、Node.js / Java / Rust SDK、SDK end-to-end with Rust Core)。

新增 guides/debug-adapter-plugin.md:最小清单(已用 Lithe Core 校验)、启动方式、先编译再调试的 executable、调试控制台补全、热激活和预发布到转正。README 的 API 等级表补上 API 4,并把 VCS 提供者补进 API 3 一行。契约副本等 Lithe 主仓库 #1512 合并后再同步,这个提交不动 contract/。
@xiaoyumuxi
xiaoyumuxi marked this pull request as ready for review October 26, 2026 22:56
@xiaoyumuxi
xiaoyumuxi merged commit aa9c443 into main Oct 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant