プラグインの設定とビルド結果の対応表

プラグインの名前や権限はどのファイルで変える? 配布用の manifest.json を実際に作り、元の設定やコードとの対応を確かめます。

目次

EmDash がプラグインの機能を読み取るためのファイルが、manifest.json(マニフェスト)です。教材では、識別名や権限は emdash-plugin.jsonc、バージョンは package.json、記事の保存時などに呼ぶ処理は src/plugin.ts に書かれています。これらを配布用にまとめる作業を「ビルド」と呼びます。ここでは手元でビルドして、設定がどう反映されるかを見てみましょう。

変更したい項目からファイルを引く

表の右端は、ビルド後の dist/manifest.json で確かめられる値です。「ルート」は、プラグインの処理を名前で呼び出すための入口です。

変更したい項目教材で編集する場所ビルド後の例
EmDash がプラグインを識別する名前emdash-plugin.jsonc の slugid が publish-check
配布するバージョンpackage.json の versionversion が 0.1.0
プラグインに許可する操作emdash-plugin.jsonc の capabilities記事を読むための content:read など
記事の保存時や公開前に呼ばれる処理src/plugin.ts の hookshooks に content:afterSave などが並ぶ
ルートを呼べる利用者の権限src/plugin.ts の各ルートの permissionroutes にルート名と必要な権限が並ぶ
編集画面に出すパネルemdash-plugin.jsonc の admin.editorPanelsadmin.editorPanels にタイトルと呼び出し先が載る

capabilities は「プラグインから何を操作できるか」、ルートの permission は「その処理を呼ぶ利用者には何の権限が必要か」を決めます。同じ権限名が登場しても、誰に許可を与えるかが違います。

教材のプラグインをビルドする

  1. 共通教材(ZIP)をダウンロードして展開します。Node.js と VS Code が初めての方は、先にパソコンの準備を済ませてください。教材の基準は Node.js 24.22.1 で、この例は 26.13.1 でも動作を確認しました。
  2. VS Code の「ファイル → フォルダーを開く」で emdash-technical-labs の中の publish-check を選びます。左側のファイル一覧に emdash-plugin.jsonc と package.json が並んでいれば、正しい場所です。
  3. 「ターミナル → 新しいターミナル」を選びます。Windows ではコマンドプロンプトを選んでください。次のコマンドを1行ずつ入力し、その都度 Enter を押します。
npm ci
npx emdash-plugin validate
npm run build

1行目で教材のバージョンにそろえて必要な部品を取り込みます。初回はインターネットに接続して実行してください。2行目で Manifest is valid と出れば、設定ファイルの書き方は合っています。3行目で Wrote manifest.json と出たら、dist フォルダーを開いてください。manifest.json に機能一覧、plugin.mjs にサンドボックスで動く処理、index.mjs にサイト側が読み込む登録用の情報が入っています。

生成したファイルを読み取る

publish-check 直下(package.json の隣)に inspect-manifest.mjs というファイルを作り、次の内容で保存します。これは生成結果を読むだけの、小さな Node.js のプログラムです。

import { readFile } from 'node:fs/promises';

const json = await readFile('dist/manifest.json', 'utf8');
const manifest = JSON.parse(json);
console.log(manifest.id, manifest.version);
console.log(manifest.hooks.join(', '));
for (const route of manifest.routes) {
  console.log(route.name, route.permission);
}
const panel = manifest.admin.editorPanels[0];
console.log(panel.title, panel.route);

同じコマンド入力画面で実行します。

node inspect-manifest.mjs

教材をそのままビルドしたときの表示です。

publish-check 0.1.0
content:afterSave, content:beforePublish, content:afterPublish
editor/summary content:read
notify-test plugins:manage
公開前チェック editor/summary

最後の行の「公開前チェック」は、編集画面に出るパネルのタイトルです。その隣の editor/summary は3行目のルート名と一致します。EmDash はこの名前を使ってパネルの処理を呼びます。編集画面に要約チェックを出す実習で、同じパネルの表示も試せます。

自分で設定を変えて確かめるなら、emdash-plugin.jsonc の "title": "公開前チェック" を "title": "要約の確認" に変えて保存します。npm run build、node inspect-manifest.mjs の順にもう一度実行して、最後の行が 要約の確認 editor/summary に変われば成功です。

設定を直したのに結果が変わらないとき

dist/manifest.json はビルドするたびに作り直されます。表の中央のファイルを保存した後、ビルドをもう一度実行してから確認してください。

validate で Manifest validation failed と出たら、続くファイル名・行番号・項目名を見ます。例えば slug を Invalid slug! にすると、この段階で止まります。先頭は英小文字にし、続きも英小文字・数字・ハイフン・アンダースコアで付けます。教材の値は publish-check です。

公式の参照元

関連ガイド

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

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