Skip to content
This repository was archived by the owner on Nov 11, 2026. It is now read-only.

README.md

Latest commit

 

History

History
95 lines (75 loc) · 8.64 KB

README.md

File metadata and controls

95 lines (75 loc) · 8.64 KB
Raw

插件参考 / Plugin reference

中文 · English

中文

这里按功能整理插件契约：每个编号的 API 现在能用什么，每个能力、协议和格式有哪些版本，Core、macOS、Windows 和官方 SDK 各自支持到哪一版。规范以英文的 contract/v1/README.md 为准，本目录只做导航和对照；两边不一致时以契约为准，并请提交问题。

从哪里开始

想知道 看这里
API-01–44 每一项现在能用什么、还缺什么 插件 API 总表
插件 API 级别、requires 能力版本、进程协议版本、文档格式版本，以及各宿主和 SDK 支持到哪一版 能力与协议版本对照
每个协议、能力和 API 是哪天、哪个 PR 改的 插件协议更新记录（只有中文）
某个功能的字段、版本、宿主现状、契约章节和示例 下方的功能页
一步步做出一个插件 开发指南

功能页

功能页 内容 API 编号 能力（requires）
清单与打包 plugin.json 字段、插件 API 级别、权限与激活事件、包目录 不在编号内 —
语言、语言服务器与运行/测试 语言、语法、语言服务器、进程启动、运行和测试命令、控制台输出链接 API-25 languages、languageServers、serverProcess、executionProviders、outputLinkMatchers
插件后端与插件函数 后端进程、函数协议（1–4）、宿主方法、工作区上下文、文件、凭据、终端、跨插件调用 API-01、04–08、20–22、24、35、37、40、41 backend、serverProcess 1、pluginFunctions
编辑器、文档与预览 文档和选区、版本化编辑、打开与定位、HTML 预览、编辑器动作、编辑器语言功能 Provider、虚拟文档内容提供者 API-09、10、12、15、16、25、27 backend 2
界面 工具窗口、命令、包内网页、原生控件、后端命令、消息框 API-02、03、13、14、17 ui
插件设置 声明式设置、放置位置、作用域、生效方式、设置页按钮 API-19 settings
声明式构建系统 构建检测、模型、命令规划、项目准备角色 API-29 buildSystems
构建提供者 litheBuild 协议：同步、任务、测试、运行和调试准备、模型输入 API-29 buildProviders、buildModelInputs
调试适配器 DAP 适配器声明、启动和传输 API-30 debugAdapters、serverProcess 2
版本控制提供者 VCS 提供者进程和协议 API-31 vcsProviders
项目生成器 新建项目的模板和步骤 API-33 projectGenerators
工具链 工具定义、可执行文件候选、工具链提供者、Core 命令 API-23 toolDefinitions、toolchainProviders、executableResolution
快捷键导入 从其他编辑器导入快捷键的提供者 不在编号内 keymapImportProviders
包信任 签名要求、签名文件格式、随应用发布的插件 不在编号内 packageTrust
插件市场 索引来源和格式、可用性判断、安装审查和确认 不在编号内 —

计划中、还没有方法的 API（API-11、18、26、28、32、34、36、38、39、42–44）只在总表列出，没有功能页。

每个功能页的结构

  1. 用途和摘要表：能力 ID、版本、Core 命令或协议方法、Windows 现状、官方 SDK。
  2. 版本对照：每个版本新增什么，Core、macOS、Windows 是否支持。
  3. 字段、方法、错误码等细节表。
  4. 契约章节：链接到 contract/v1/README.md 的对应小节。
  5. 示例与用例：contract/v1/fixtures/ 里的文件和用例数量。
  6. 相关指南。

English

This directory organizes the plugin contract by feature: what each numbered API offers today, which versions each capability, protocol, and format has, and which version Core, macOS, Windows, and the official SDKs support. The English contract/v1/README.md is normative; this directory only navigates and compares. When they disagree the contract wins, and please file an issue.

Where to start

To find Go to
What each of API-01–44 offers today and what is missing Plugin API catalog
Plugin API levels, requires capability versions, process protocol versions, document format versions, and which version each host and SDK supports Capability and protocol versions
When, and in which PR, each protocol, capability, and API changed Plugin protocol changelog (Chinese only)
A feature's fields, versions, host status, contract sections, and examples The feature pages below
Building a plugin step by step Guides

Feature pages

Page Covers API numbers Capabilities (requires)
Manifest and packaging plugin.json fields, plugin API levels, permissions and activation events, package layout Not numbered —
Languages, language servers, run and test Languages, grammars, language servers, process launch, run and test commands, console output links API-25 languages, languageServers, serverProcess, executionProviders, outputLinkMatchers
Plugin backend and plugin functions Backend process, function protocol (1–4), host methods, workspace contexts, files, credentials, terminals, cross-plugin calls API-01, 04–08, 20–22, 24, 35, 37, 40, 41 backend, serverProcess 1, pluginFunctions
Editor, documents, and previews Documents and selections, versioned edits, open and reveal, HTML preview, editor actions, editor language-feature providers, virtual-document content providers API-09, 10, 12, 15, 16, 25, 27 backend 2
UI Tool windows, commands, package web content, native controls, backend commands, message boxes API-02, 03, 13, 14, 17 ui
Plugin settings Declarative settings, placement, scope, apply behavior, settings page actions API-19 settings
Declarative build systems Build detection, models, command planning, project preparation roles API-29 buildSystems
Build providers The litheBuild protocol: sync, tasks, tests, run and debug preparation, model inputs API-29 buildProviders, buildModelInputs
Debug adapters DAP adapter declarations, launch, and transports API-30 debugAdapters, serverProcess 2
VCS providers VCS provider processes and protocol API-31 vcsProviders
Project generators New-project templates and steps API-33 projectGenerators
Toolchains Tool definitions, executable candidates, toolchain providers, Core commands API-23 toolDefinitions, toolchainProviders, executableResolution
Shortcut import Providers that import shortcuts from other editors Not numbered keymapImportProviders
Package trust Signature requirements, the signature file format, plugins bundled with the application Not numbered packageTrust
Marketplace Index sources and format, availability, install review and confirmation Not numbered —

Planned APIs that have no methods yet (API-11, 18, 26, 28, 32, 34, 36, 38, 39, 42–44) are listed only in the catalog and have no feature page.

Layout of each feature page

  1. Purpose and a summary table: capability IDs, versions, Core commands or protocol methods, Windows status, official SDKs.
  2. Versions compared: what each version adds, and whether Core, macOS, and Windows support it.
  3. Detail tables for fields, methods, error codes, and so on.
  4. Contract sections: links to the matching sections of contract/v1/README.md.
  5. Examples and cases: files in contract/v1/fixtures/ and their case counts.
  6. Related guides.