記事の編集画面に、公開前チェックの欄を追加する

保存済みの要約を読み、入力済みか空欄かを管理画面のパネルへ表示します。

目次

編集者が記事を開いたときに、「要約は入力できているか」をその場で確認できるようにします。EmDashの編集パネルという追加欄を使います。

このパネルが確認するのは、保存済みの内容です。入力中の文章を確認したいときは、先に保存します。

先に用意するもの

共通の練習用サイトを準備します。教材の publish-check がプラグイン、weekend-note がそれを使うサイトです。完成コードは教材に入っています。このページでは、該当する処理を読んで動かし、一部を変更して確かめます。

サイトの起動画面は開いたままにします。テストやビルドの命令は、VS Codeで別のコマンド入力画面を開き、各手順で指定するフォルダーへ移動して実行してください。

対象はEmDash 1.4.0、プラグインCLI 0.13.5、テスト用パッケージ 0.2.11、Vitest 4.1.0、Node.js 24.22.1です。macOSで実行しました。Windowsで試す場合はコマンドプロンプトを使ってください。Windows実機での確認はまだ行っていません。

1. パネルを登録する

publish-check/emdash-plugin.jsonc の admin は次の設定です。この部分だけを確認してください。

{
  "editorPanels": [
    {
      "id": "summary",
      "title": "公開前チェック",
      "route": "editor/summary",
      "collections": [
        "posts"
      ]
    }
  ]
}

title が画面に出る名前、collections が表示対象です。route の editor/summary は、次に書く処理の名前と一致させます。プラグイン内の呼び出し先なので、ブラウザーへそのまま入力するURLではありません。

この設定がビルド後のファイルにどう載るかは、プラグインの設定とビルド結果の対応表で確かめられます。

2. 保存済みの値を読んで表示する

publish-check/src/plugin.ts の routes の中に、次の処理が入っています。抜粋です。

'editor/summary': {
      permission: 'content:read',
      handler: async (route, ctx) => {
        const entry = route.ui?.entry;
        if (!entry) return { blocks: [{ type: 'section', text: '記事を保存してから開いてください。' }] };
        const saved = await ctx.content.get(entry.collection, entry.id);
        const excerpt = saved?.data.excerpt;
        const ready = typeof excerpt === 'string' && excerpt.trim() !== '';
        return { blocks: [{ type: 'section', text: ready ? '保存済みの要約は入力されています。' : '保存済みの要約が空欄です。入力して保存してください。' }] };
      },
    },

route.ui.entry は、今開いている記事の情報です。そのIDを使い、ctx.content.get で保存済みの記事を読みます。記事がまだ特定できない場合は、先に保存してもらう説明を返します。

blocks は、画面に出す部品の配列です。この例は section という部品に短い文章を渡しています。管理画面のHTMLを一から組み立てなくても、EmDash側の見た目で表示できます。

3. 管理画面で確かめる

プラグインのビルドとサイトの再起動が済んだら、管理画面で「週末の記録 01」を開きます。右側の「公開前チェック」を開くと「保存済みの要約は入力されています。」と表示されます。実際の管理画面でも、この表示を確認しました。

次に、下書きの記事の要約を空にして保存し、その記事を開き直します。パネルを開いて「保存済みの要約が空欄です。入力して保存してください。」になれば、空欄も判別できています。確認後は要約を元へ戻して保存します。

入力したのに判定が変わらない場合は、保存してから記事を開き直してください。この例では、開き直したときに保存済みの内容を読み、表示を更新します。

パネルの表示と公開の制限は別の役割

パネルは、編集者に現在の状態を伝える機能です。公開そのものを止めるのは公開前のフックです。両方を入れることで、事前に気付ける表示と、最後の確認を組み合わせられます。

変更をサイトへ反映する・終了する

publish-checkのコマンド入力画面でnpm run buildを実行します。成功したらサイトを再起動します。

起動に使った画面が入力待ちに戻っていなければ、その画面でControl + Cを押します。その場合は、下の1行目を飛ばしてnpm run devだけを実行してください。入力待ちに戻ったあともサイトが動いている場合は、weekend-noteで下の2行を順に実行します。再起動後は、管理画面を開き直してください。

npx astro dev stop
npm run dev

プラグインを変更したときは、ビルドとサイトの再起動が必要です。作業を終えるときも、起動画面の状態に合わせてControl + Cまたはnpx astro dev stopで停止します。次回はweekend-noteでnpm run devを実行して再開できます。

公式の参照元

関連ガイド

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

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