動作を確認してプラグインを配布する

コードの検査、実際のサイトでの確認、配布物の確認を分けます。ネイティブのnpm配布とサンドボックスのレジストリ公開の流れを説明します。

目次

ビルド成功だけで、配布を終わりにしない

配布前には、コードの検査、実際のサイトでの動作、配布するファイルの中身を確認します。ビルドの成功でわかるのは、配布用のファイルを作れたことまでです。記事保存で処理が動くか、権限のない人が設定を変えられないか、再起動後も設定が残るかは、実際に操作して確かめます。

このページは、作ったプラグインをほかの人にも使ってもらいたい場合に進めます。配布前の確認と公開先を整理し、ローカルで配布物を作る段階から順に説明します。

3つの段階で確認する

段階確認すること失敗したら見るもの
コードと定義型、manifest、ビルドエラーのファイル名と行番号
実際のサイトフック、ルート、権限、保存サイトのログと管理画面
配布物必要なファイルと説明アーカイブの内容と新規導入結果

以下のコマンドはVS Codeのターミナルで入力します。Windowsではコマンドプロンプトを選びます。入力画面の開き方

サンドボックスの生成プロジェクトなら、プラグインのフォルダーで次を一つずつ実行します。

pnpm run validate
pnpm run typecheck
pnpm run test
pnpm run build

テストでは、「権限なしでは呼べない」「保存後に1件増える」「未設定でも動く」など、利用者にとって必要な動作を確かめます。

サイトで試す項目

新規導入した状態で、動作確認APIと記事保存を試します。設定を変え、サイトを再起動して残るかを確認します。プラグインを停止した状態でも、記事の通常操作が成立するか確認してください。

更新の確認では、以前の版で作った設定や記録を残したまま、新版へ切り替えます。空の環境でしか試していないと、既存データとの食い違いを見落とします。

自分のパソコンでNode.js用の実行部品(runner)を使って試した結果と、Cloudflare上で試した結果は、分けて記録します。実行時間や外部通信の制限が同じとは限らないためです。

ネイティブはnpm向けの配布物を作る

ネイティブの練習なら、plugin-activityで型検査とビルドを行い、次に配布物を作ります。

npm run typecheck
npm run build
npm pack

npm packは、ローカルに.tgzという圧縮ファイルを作ります。これはインターネットへの公開ではありません。表示されたファイル一覧を確認し、その圧縮ファイルを別の検証サイトへ導入してビルドします。

独自のReact画面やAstro部品を持つプラグインでは、それらのソースもサイト側のビルドに必要な場合があります。サーバー用のdistだけを配布して済むとは限りません。exportsとfilesを公式の配布ガイド(別タブで開く)に沿って確認します。

公開名の所有、利用条件、説明文を整えた後、npmへ公開する段階のコマンドがnpm publishです。練習の@example名を、そのまま自分の公開先として使わないでください。

サンドボックスはレジストリ用にまとめる

プラグインのフォルダーで、生成プロジェクトに入っているCLIを使います。

pnpm exec emdash-plugin bundle

distにレジストリ向けアーカイブができます。生成されたmanifest、実行コード、READMEなどが対象です。Node.js専用のfsなどを実行コードへ持ち込んでいないか、許可する通信先と権限が矛盾しないか、サイズ制限内かが検査されます。

配布用のマニフェストはビルドするたびに作り直されます。識別名や権限を直したいときは、プラグインの設定とビルド結果の対応表で編集元を確認できます。

公開先へ送る段階

サンドボックスの公開は、Atmosphereアカウントで認証し、publisherが一致することを確認して進めます。次のyour-handle.exampleは、自分のハンドルへ置き換える説明用の値です。

pnpm exec emdash-plugin login your-handle.example
pnpm exec emdash-plugin publish

publishはアップロードと公開記録の作成を行う操作です。ローカル確認のつもりで実行しないようにしてください。送信成功と、審査・確認を経て一覧に掲載された状態は別です。CLIが示す確認コマンドと結果を読みます。

同じ版の公開記録は原則として置き換えられません。修正して再公開するときは版を上げます。使える権限や接続できるホストを増やす変更では、プラグインが操作できる範囲も広がります。表示の修正とは区別して、変更内容を利用者へ知らせます。

READMEに残すこと

機能、対応するEmDashの版、必要なrunner、導入場所、要求権限、外部への通信、保存するデータ、設定方法、停止・削除時に残るものを記載します。

削除時に設定を残すか、利用者が明示的にデータ削除を選んだ場合だけ消すかも説明します。最新版を作れたことに加え、利用者が導入・更新・停止を判断できる資料が揃ったところで、配布の準備が整います。

導入だけでなく、停止・削除・再導入も試す

プラグインの機能を使うテスト記事と保存データを用意し、無効化したときの公開ページ・編集画面を確認します。その後、データを残して削除し、同じ版の再導入で何が戻るかを検証環境で試します。

コードを消しても、記事に保存された部品が普通の文章へ自動変換されるとは限りません。表示用のコード、設定、秘密情報、専用の保存データを分けて記録します。完全にデータを消す操作は、この確認とバックアップを済ませてから判断します。利用者向けの導入・停止手順も案内に含めてください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。