01
節
ローカルアドオン
リポジトリ内ローカルアドオンの入口はsrc/plugins/registerAnalysisAddons.tsです。質的分析タブ追加と量的分析手法追加の2系統があります。
02
節
配布用プラグイン
配布用プラグインはstellar-plugin.jsonとindex.jsを含むフォルダ、または.zip / .stellar-pluginとして扱います。プラグインIDは安定した英数字とハイフンにします。
03
節
公開前の確認
プラグイン機能は実装状況と公開状態を確認してからWikiに載せます。仕様ページでは実装済みと計画中を混ぜません。
04
節
アドオン設計の基本
アドオンやプラグインは、Stellar本体の研究データを扱うため、便利さだけでなく、権限、保存先、失敗時の挙動、ユーザーへの説明を設計します。分析アドオンは、入力データと出力データが分かるようにします。
配布用プラグインでは、ID、バージョン、互換Stellarバージョン、必要な権限、ライセンス、更新履歴を明確にします。
- 安定したplugin IDを使う
- 入力と出力を説明する
- 必要な権限だけを要求する
- 失敗時のメッセージを用意する
- 互換バージョンを明記する
05
節
公開前のセルフチェック
プラグインを公開する前に、クリーンな環境でインストールできるか、サンプルデータで動くか、不要な外部通信がないか、エラー時に研究データを壊さないかを確認します。
公式Wikiには、実装済みでユーザーが利用できる範囲だけを書きます。計画中のAPIや未公開の仕様は、実装と公開状態が揃ってから追加します。