ReadAware

プラグインを公開する

公開プラグインリポジトリにはマーケットプレイスのパッケージが置かれ、プルリクエストで変更を受け付けています。提出準備では、現在の貢献手順とバリデーターを使ってください。

対応するアプリに合わせる

開発カタログは、最新リリース版のアプリより先に進むことがあります。リポジトリの types/host-capabilities.json はそのリリースを記述しており、そのバリデーターはリリースが満たせない requires 範囲を拒否します。新しい機能を必要とするパッケージは、互換性のあるホストのリリースを待つ必要があります。minAppVersion を変更するだけでは、欠けているAPIは生まれません。

Capabilities Explorer を使ってメソッドとバージョンを確認し、実際にテストした最小限の互換セットを宣言してください。

レビュー可能なパッケージを作る

manifest.json、読みやすいソース、自己完結したビルド済みmain.js、必要なランタイムアセットをコミットします。フォルダー名をマニフェストIDと一致させてください。リモートの実行コードを読み込んだり、パッケージ外のファイルに依存したりしないでください。

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

動作と権限を確認する

  • 機能、その入口、各権限が必要な理由を説明します。
  • 正確な設定付与と必要なネットワークオリジンを宣言し、外部サービスへ送るデータを説明します。
  • 本のスコープ、権限がない場合、キャンセル、無効化/再有効化、実際のデスクトップUIをテストします。
  • 有効化は宣言的に保ち、移行はストレージ専用にします。
  • プライベートデータの保持、クォータ、使用中リソースのクリーンアップを確認します。
  • 更新では、移行失敗と復旧を含む現実的なデータで既存インストールを試します。

ローカルのマニフェストプレビューは、互換性と権限の誤りを見つける助けになります。リポジトリのバリデーター、デスクトップテスト、レビューの代わりにはなりません。

ビルドと提出

公開リポジトリのルートでチェックを実行します。bun run check は、CI がプルリクエストに対して実行する内容です:

bash
bun install
bun run build
bun run check

リポジトリの現在のスキーマと並び順に従って、対応するレジストリエントリを追加してください。最終的な動作、テスト済みのアプリと機能のバージョン、プライベートデータ、外部サービス、権限の変更を記述したプルリクエストを開いてください。再現可能な検証手順を含めてください。

更新

マニフェストとレジストリのパッケージバージョンを上げます。schemaVersionを変更するのはプライベートデータのスキーマ変更時だけとし、同じパッケージに移行を含めます。追加権限の要求には、明確な説明と使える拒否経路が必要です。

署名、発行者の身元、パッケージ完全性、レビューの出所、失効は、配布上の別の問題です。実際にパッケージへ適用される管理策を記載してください。Workerの分離だけでは、任意のコードに対する保証になりません。

プラグインをビルドする · APIリファレンス