要約が空の記事を、公開直前に止める
下書きは保存し、公開するときだけ必須条件を確認するプラグインを作ります。
目次
プラグインを使うと、要約が空の記事を下書きとして保存しつつ、公開しようとしたときだけ止められます。この実習では、書きかけを保存できる状態を保ちながら、公開直前に入力漏れを確認します。
先に用意するもの
共通の練習用サイトを準備します。教材の 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/src/plugin.ts の hooks にある次の部分を使います。教材にはすでに入っているので、同じ処理を重ねて追加する必要はありません。
'content:beforePublish': async (event) => {
if (event.collection !== 'posts') return;
const excerpt = event.content.data.excerpt;
if (typeof excerpt !== 'string' || excerpt.trim() === '') {
return { cancel: true, reason: '公開する前に、要約を入力してください。' };
}
},beforePublish は公開の直前です。trim() は前後の空白を取り除きます。空欄に見えるスペースだけの入力も、ここで止めます。cancel: true で公開を中止し、reason が理由になります。
公開を止める権限も必要です。教材の publish-check/emdash-plugin.jsonc の capabilities に hooks.content-policy:register が入っていることを確認します。この設定ファイルは、プラグインが何を使うかを宣言するものです。
2. 管理画面で下書きを保存する
http://127.0.0.1:4350/_emdash/admin を開きます。既存の「公開しない練習用の下書き」を使い、「要約」を空にして保存してください。保存済みになれば、書きかけを残せています。
続けて「今すぐ公開」を押し、確認画面でも「今すぐ公開」を押します。「公開する前に、要約を入力してください。」と表示され、下書きのままなら成功です。http://127.0.0.1:4350/cards/ にも、この下書きは出ません。
この動作はブラウザーの管理画面でも確認しました。画面上の入力欄を必須にするだけでなく、EmDashの公開処理で確認しています。
3. 修正した後は公開できるか試す
次の自動テストは、空欄で公開を止められた後、要約を保存し直して公開できるかを確認します。publish-check で実行します。
npm test -- -t "止められた記事も"1 passed なら、入力漏れを直した記事は公開できます。テスト用の一時データを使うので、練習サイトの下書きを公開する必要はありません。
管理画面で使った下書きには「確認用です。」を要約へ戻して、下書きとして保存しておきます。他の実習で、非公開の記事が混ざらないかを確かめるために使います。
うまく止まらない場合
ファイルを変更してからプラグインをビルドし、サイトを再起動したかを確認します。afterPublish に書いても、公開前の確認にはなりません。対象の入力欄の名前が excerpt であることも確かめてください。
変更をサイトへ反映する・終了する
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を実行して再開できます。