插件 SDK v1
插件开发使用的公开协议辅助文件统一维护在 docs/public/plugin-sdk/,构建时原样发布,各语言文档共用。它们用于编辑器提示和外部工具集成,不参与 res-downloader 的运行时加载或命令行校验。
文件
- Manifest Schema:为
plugin.json提供字段提示。 - plugin-v1.d.ts:为 JavaScript 插件 API 提供类型声明。
在支持 JSON Schema 的编辑器中,可以把 plugin.json 与 Schema 地址关联:
text
https://res.putyy.com/plugin-sdk/plugin-v1.schema.jsonJavaScript 项目可以把 plugin-v1.d.ts 下载到开发目录,并通过编辑器配置或 /// <reference path="./plugin-v1.d.ts" /> 启用类型提示。运行时仍执行普通 JavaScript,不要求使用 TypeScript 构建。
插件校验以 Go 后端的协议模型和校验逻辑为准。提交前在 res-downloader 源码根目录运行:
text
go run main.go plugin lint <插件目录>
go run main.go plugin replay <插件目录> <fixture 文件>新增或调整插件协议时,应同步更新 Schema、类型声明、示例、fixture 和插件开发文档。
完整接口说明见插件开发和业务操作契约;安装来源与保留前缀规则见插件来源与保留 ID。
