保存と公開を、別々のタイミングで記録する

下書き保存と読者への公開を区別し、プラグインの処理とテストで確かめます。

目次

「記事を保存した」と「読者に公開した」は別の出来事です。プラグインでも別々に扱えます。今回は、保存した記事と公開した記事のIDを、それぞれ記録する小さな機能を動かします。

先に用意するもの

共通の練習用サイトを準備します。教材の 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. 保存・公開のフックを見る

フックは、CMSで特定の出来事が起きたときに呼ばれる処理です。VS Codeで publish-check/src/plugin.ts を開きます。hooks の中に次の処理があります。これは該当部分の抜粋なので、ファイル全体へ上書きしないでください。

'content:afterSave': async (event, ctx) => {
  if (event.collection !== 'posts') return;
  ctx.log.info('記事を保存しました', { id: event.content.id });
  await ctx.kv.set('last-save', event.content.id);
},
'content:afterPublish': async (event, ctx) => {
  if (event.collection !== 'posts') return;
  ctx.log.info('記事を公開しました', { id: event.content.id });
  await ctx.kv.set('last-publish', event.content.id);
},

event には今回保存・公開された記事の情報が入ります。ctx はプラグインに許可された道具をまとめたものです。ctx.log.info は記録を出し、ctx.kv.set は名前付きで値を保存します。last-save と last-publish は、この例で決めた保存名です。

同じ名前で保存し直したら前の値はどうなるでしょうか。プラグインの値を保存・取得・削除する実習で、保存前から削除後までの結果を比べられます。

最初の条件は、対象を posts の記事だけに絞っています。return は、対象外ならここで処理を終えるという意味です。

2. 保存だけでは公開の記録が付かないか試す

コマンド入力画面の作業場所を publish-check にします。VS Codeで教材の親フォルダーを開いているなら cd publish-check、すでに weekend-note にいるなら cd ../publish-check です。

npm test -- -t "保存と公開を別々に記録する"

これは、教材に入れた1件のテストだけを実行します。テストは、一時的なEmDash環境で記事を下書き保存し、次の順番で確かめます。

  1. 保存した記事のIDが last-save に入る。
  2. まだ公開していないので、last-publish は空。
  3. その記事を公開すると、last-publish にもIDが入る。

結果に 1 passed と出れば、この3つを満たしています。他のテストが skipped と表示されるのは、今回の名前で絞り込んだからです。

3. メッセージを変えてみる

src/plugin.ts の「記事を保存しました」を「下書きの保存を記録しました」に変えて保存し、同じテストを再実行します。記録するIDの動作は変わらないので、テストは通ります。確認後は元の文章へ戻せます。

この記録は、最後の1件のIDを覚える練習です。いつ誰が何を変えたかをすべて残す監査ログではありません。また、同じ記事を何度も保存すれば、保存側のフックも複数回呼ばれます。メール送信などを足す場合は、重複した処理の扱いも設計します。

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

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を実行して再開できます。

公式の参照元

関連ガイド

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

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