ReadAware

發布外掛程式

公開外掛程式儲存庫 承載市場套件並透過合併請求接受變更。準備提交時,請依照其目前的貢獻說明與驗證器操作。

配合你所支援的 App

開發目錄可能領先於最新發布的 App。儲存庫中的 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 與排序方式,新增對應的 registry 項目。開立 pull request,說明最終行為、已測試的應用程式與能力版本、私有資料、外部服務及權限變更。請附上可重現的驗證步驟。

更新

在清單與註冊表中遞增套件版本。僅在私人資料結構變更時變更 schemaVersion,並在同一個套件中附上其遷移。要求更多權限時,需要清楚的說明與可用的拒絕途徑。

簽署、發布者身分、套件完整性、審查來源追溯與撤銷是各自獨立的發布考量。請說明實際適用於套件的控管措施;僅靠 Worker 隔離並不能保證任意程式碼的安全。

建立外掛程式 · API 參考