入力項目から型を作り、コードの打ち間違いを見つける
EmDashの項目定義をTypeScriptへ書き出し、titleをtitelと書いたときに検出できるか試します。
目次
EmDashの入力項目から「型」のファイルを作ると、コードに書いた項目名の間違いを、実行前に調べられます。たとえば、titleをtitelと打ち間違えた場合です。型には「どんな名前の項目があり、文字列や数値のどちらを入れるか」といった情報が入っています。
この実習では、EmDashの入力項目から型を作り、正しいコードと間違ったコードを1つずつ確認します。型の仕組みを全部覚える必要はありません。
先に用意するもの
写真付き一覧のガイドの「練習用サイトを準備する」まで済ませてください。同じダウンロード教材「週末ノート」を使います。EmDash 1.4.0、Astro 7.4.5、Node.js 24.22.1が対象です。実行確認はmacOSで行いました。Windows向けの入力例はコマンドプロンプト用で、Windows実機では未確認です。
以下のファイル名は、特に断りがなければ教材の weekend-note フォルダーからの場所です。ファイルの内容はVS Codeで編集し、指定された名前で保存します。コマンドはファイルに保存せず、コマンド入力画面へ貼り付けて実行します。どちらも、囲みの前にある説明で作業する場所を確認してください。開発サーバーは weekend-note のコマンド入力画面で npm run dev を実行しておきます。
起動に使った画面は開いたままにします。このあとのコマンドは、別の入力画面で実行します。VS Code左側のファイル一覧で weekend-note フォルダーを右クリックし、**Open in Integrated Terminal(統合ターミナルで開く)**を選ぶと、そのフォルダーを作業場所にした画面を開けます。Windowsでは、パソコンの準備で選んだコマンドプロンプトを使います。
ここからのコマンドはすべて weekend-note で実行します。MacならVS Codeのコマンド入力画面またはターミナル、Windowsならコマンドプロンプトです。npx emdash は、この練習サイトに入れたEmDashの操作用プログラムを呼び出します。--url は操作先で、毎回 http://127.0.0.1:4350 と指定します。
この教材の開発サーバーにだけ接続します。自分の会社のサイトへURLを差し替えて試す必要はありません。
1. 型のファイルを作る
npx emdash types --url http://127.0.0.1:4350.emdash/types.ts が作られます。VS Codeで開き、export interface Post と、その中の title: string を探してください。「Postという記事には、文字列のtitleがある」という意味です。このファイルに入るのは項目の名前や種類で、記事の本文は入りません。
先頭に自動生成だと書かれているので、このファイルを手で修正する必要はありません。入力項目を変更したら、もう一度このコマンドで作り直します。
2. 正しい名前で使う
exercises/check-fields.ts を開きます。教材には次が入っています。
import type { Post } from '../.emdash/types';
export function heading(post: Post) {
return post.title;
}import type は型情報を読み込む指定です。post: Post によって、この関数へ渡す記事はPostの形だと伝えています。
次は、間違った項目名がないかを調べるコマンドです。1行で入力します。
npx tsc --noEmit --skipLibCheck --module nodenext --moduleResolution nodenext exercises/check-fields.ts何もエラーが出ず、入力待ちへ戻れば成功です。--noEmit は確認だけを行い、実行用ファイルを書き出さない指定です。--skipLibCheck は、利用している外部ライブラリーの型定義の検査を省きます。自分で書いたこのファイルは検査されます。
3. わざと打ち間違えてみる
return post.title; を return post.titel; に変えて保存し、同じ tsc のコマンドを実行します。
Property 'titel' does not exist on type 'Post'. Did you mean 'title'?このエラーは「Postにはtitelという項目がありません。titleのことですか?」という意味です。検証でも同じ指摘が出て、打ち間違いを検出できました。title に戻して保存し、もう一度エラーなしで終わることを確認します。
型で分かること・分からないこと
この例で分かるのは、コードの項目名が定義と合っているかです。データベースの中身を修正する命令ではありません。型を作り直しただけで、本番に入力欄が追加されることもありません。
写真が必ず入力されているか、記事の内容が正しいか、といった確認は別に必要です。項目定義が変わったら型を更新し、表示側の確認も行いましょう。
型ファイルが見つからない場合は、最初の emdash types を weekend-note で実行したかを確認します。
終了するとき・次回続けるとき
npm run devを実行した画面が入力待ちに戻っていなければ、その画面でControl + Cを押して停止します。入力待ちに戻ったあともサイトが動き続けている場合は、weekend-noteでnpx astro dev stopを実行します。次回は同じフォルダーでnpm run devを実行してください。初期データを入れるseedコマンドを繰り返す必要はありません。