Repository navigation
docs(agents): 宿主方法逐个按 API 编号登记,开发者只看 docs 就能开发 - #1751
Merged
Merged
Conversation
xiaoyumuxi
marked this pull request as ready for review
November 5, 2026 05:00
Lithe Review结论: ✅ 通过 未发现需要阻塞合并的问题。 Scope Check
Summary新增规则明确了方法级追溯要求及公开文档的内容边界,未发现本次引入的实质问题。 Verification
|
Lithe 运行验收版本: 对照:共同祖先
未覆盖:
工作副本与运行状态已清理;可复用编译缓存按 12 GiB / 7 天预算保留。 |
This was referenced Nov 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
一个 API 编号下面常有多个宿主方法。例如 API-24 有
terminal/create、show、close、reopen、dispose、onExit六个,可以分几个 PR 陆续加入;在函数协议 3 里向后兼容地新增方法,也不升协议版本。所以光看协议版本,查不到某个方法是哪个 PR 加的、属于哪个 API、怎么用。lithe-plugin-docs 在 Lithe-IDEA/lithe-plugin-docs#21 里已经改成按方法登记。这个 PR 把对应规则写进
AGENTS.md,这样以后每个改宿主方法的 PR 都会照做。改动
AGENTS.md的“插件契约的两仓库同步”一节加了两条:reference/api-catalog.md的中英两张方法表,列为 API、方法、用途、权限、协议;contract/v1/;用法说明写进 lithe-plugin-docs 的功能页。只写在实施计划、Agent Note、契约草案或宿主代码里的行为,不算已公开。说明
main上出现。两个 PR 最好前后脚合入。editor/reveal只处理已经打开的文件,没打开时返回plugin.host.notFound。这个行为目前只在 macOS 宿主实现里(PluginHostEditorService.swift),契约 README 没写,以后要补进契约。这个 PR 不改契约。验证
node scripts/agent-notes/verify-agent-notes.mjs通过(210 个 Agent Note)。docs/development/macos-plugin-api-plan.md存在。