ReadAware

发布插件

公开插件存储库 承载市场包并透过拉取请求接受变更。准备提交时,请依照其目前的贡献说明与验证器操作。

与你支持的客户端保持一致

开发目录可能领先于最新发布的客户端。仓库中的 types/host-capabilities.json 描述了该发布版本,其校验器会拒绝该版本无法满足的 requires 范围。需要新能力的插件必须等待兼容的宿主版本发布;仅修改 minAppVersion 并不会补上缺失的 API。

请使用能力浏览器查看方法与版本,然后只声明你实际测试过的最小兼容集合。

让包可受审查

提交 manifest.json、可读的源码、构建后的独立 main.js,以及所需的运行时资源。保持文件夹名称与清单 ID 相同。请勿加载远端可执行代码,或依赖包之外的文件。

tree
plugins/my-plugin/
  manifest.json
  main.js
  package.json
  src/main.ts
  src/main.test.ts
  assets/

检查行为与权限

  • 说明功能、其入口,以及每个权限的必要原因。
  • 声明确切的 Settings 授权与所需的网络来源。说明哪些数据会传送至外部服务。
  • 测试书籍范围、缺少权限、取消、禁用/重新启用,以及实际的桌面 UI。
  • 保持启用为声明式,迁移仅限存储。
  • 检查私有数据保留、配额,以及作用中资源的清理。
  • 对于更新,请以真实数据演练现有安装,包括失败的迁移与复原。

本机清单预览有助于找出兼容性与权限错误。它不能取代存储库验证器、桌面测试或审查。

构建并提交

在公共仓库根目录运行检查;bun run check 就是 CI 在你的 pull request 上运行的命令:

bash
bun install
bun run build
bun run check

按照仓库当前的 schema 和排序规则,添加对应的注册表条目。提交 pull request 时,请描述最终行为、已测试的应用与能力版本、私有数据、外部服务以及权限变更。并附上可复现的验证步骤。

更新

在清单与注册表中递增包版本。仅在私有数据结构变更时变更 schemaVersion,并在同一个包中附上其迁移。要求更多权限时,需要清楚的说明与可用的拒绝途径。

签署、发布者身分、包完整性、审查来源追溯与撤销是各自独立的发布考量。请说明实际适用于包的控管措施;仅靠 Worker 隔离并不能保证任意代码的安全。

建立插件 · API 参考