ホーム 全セッション S01

演習: 誤った変更を検出する仕組みを追加する

8 / 10 目安 8分

ページ一覧

解決策: 学んだ仕組みを追加して、誤った変更を検出します。

eslint.config.mjsimport tseslint from "typescript-eslint";// ルールの骨組み:// "no-restricted-syntax": ["error", {//   selector: "検出するコードの形",//   message: "報告する文",// }]// selector の読み方:// 「A > B」は A の直下の B です。// 「B[x.y=/…/]」は、項目 x.y が// 正規表現に一致する B です。// TSAsExpression は as の式です。// as const も as の式(TSAsExpression)です。// 状態の型の名前で対象を限定します。// TSTypeReference は型の名前です。// TSUnknownKeyword は unknown です。const rules = {};export default [  {    files: ["exercises/guard/cases/**/*.ts"],    languageOptions: {      parser: tseslint.parser,      parserOptions: { projectService: true, tsconfigRootDir: import.meta.dirname },    },    plugins: { "@typescript-eslint": tseslint.plugin },    rules,  },];

必須の3件が「検出」、正しいコード3件が「誤検知なし」で合格です。

この演習の手順

  1. 誤った変更ごとに「本来」と「この変更では」を比較し、1件選んでコードを確認します。
  2. 仕組みを追加する場所は次のとおりです。
    • Linter: eslint.config.mjs(ルールの骨組みと selector の読み方を、ファイルの先頭に記載しています)
    • 型: transitions.type-test.ts
    • テスト: transitions.test.ts と callers.test.ts
    Linter のルールの書き方

    selector は、検出するコードの形を指定します。下の例の TSAsExpression は as の式、TSUnknownKeyword は unknown を表し、「A > B」は A の直下の B を表します。この組み合わせは、as の式の直下にある unknown を検出します。TSAsExpression だけを指定すると、正しいコードの as const も as の式であるため、誤検知(正しいコードを誤った変更として検出すること)になります。検出の範囲は、型の名前などで限定します。Linter のルールは、as をすべて禁止する形にしません。表の「状態の型以外への as を残す正しいコード」の行は、状態の型以外への as が残る正しいコードであり、誤検知にしてはいけません。

    実装先: eslint.config.mjs の const rules = {} の {} の中
    "no-restricted-syntax": [
      "error",
      {
        selector: "TSAsExpression > TSUnknownKeyword",
        message: "unknown を経由した型アサーションで、型検査を回避しません。",
      },
    ],
  3. callers.test.ts が呼ぶ関数の定義を確認します。
    callers.test.ts が呼ぶ関数の定義

    callers.test.ts が呼ぶ startExaminationFor と recordPaymentFor は、routes.ts の kind の検証を関数に切り出したものです。引数は、startExaminationFor が (current, veterinarianId, examinationStartedAt)、recordPaymentFor が (current, input, paidAt) です。recordPaymentFor は、startExaminationFor と同じ形で、AwaitingPayment を検証します。

    callers.test.ts が呼ぶ startExaminationFor
    export const startExaminationFor = (
      current: Appointment,
      veterinarianId: string,
      examinationStartedAt: string,
    ): InExamination => {
      if (current.kind !== "CheckedIn") throw new Error("Invalid appointment state");
      return startExamination(current, veterinarianId, examinationStartedAt);
    };
  4. 「検出を検証する」を押します。必須3件の検出結果と理由は、「解答の例を見る」で確認できます。
  5. 表の用語の意味は次のとおりです。
    • 検出: 誤った変更を見つけて報告した。
    • 未検出: 誤った変更を検出していない。
    • 対象外: その誤った変更では数えない仕組み。
    • 未判定: 検査が完了せず、判定できなかった。
    • 誤検知: 正しいコードを誤って検出した。
  6. 合格すると表に行が追加されます。「相互レビューで作る誤った変更」の行は次のページで使います。「kind の検証を削除し、unknown を経由した as で渡す」「診察開始の時刻に来院の時刻を格納する」「会計の引数を Appointment 全体に広げる」の3件は、説明のページで結果を見た3件です。時間に余裕がある場合に取り組む任意の課題です。

手元のエディタで解く

ブラウザの代わりに、手元のエディタで同じ演習を解くこともできます。編集するファイルと合否の判定は、ブラウザの演習と同じです。ブラウザで書いた内容は、手元のファイルに引き継がれません。

必要なツール

  • Node.js 20以上
  • pnpm 9.12.0
  • Git

ターミナルで次のコマンドを実行し、版を確認します。

node --version
pnpm --version
git --version

pnpmが無い場合は、次のコマンドでインストールします。

npm install --global pnpm@9.12.0

最初の1回だけ行う準備

ターミナルで次のコマンドを順に実行します。1行目でリポジトリをcloneし、3行目で依存パッケージをインストールします。

git clone https://github.com/iwasa-kosui/fp-with-ts-hands-on.git
cd fp-with-ts-hands-on
pnpm install --frozen-lockfile

ほかのSessionの演習も、同じフォルダで解きます。以前にcloneしたフォルダを使う場合は、そのフォルダで次のコマンドを実行し、最新の状態にします。

git pull
pnpm install --frozen-lockfile

演習を解く

  1. エディタで、cloneした fp-with-ts-hands-on フォルダを開きます。
  2. 次のファイルを編集します。examples/session-01-solution/exercises/guard/cases/ の誤った変更は編集しません。
    • examples/session-01-solution/eslint.config.mjs
    • examples/session-01-solution/exercises/guard/mine/ の中のファイル
  3. fp-with-ts-hands-on フォルダで次のコマンドを実行します。このコマンドは、ブラウザの「検出を検証する」と同じ判定を実行し、結果をターミナルに表示します。
    pnpm guard:01

解答の例は、このページの演習の「解答の例を見る」で確認できます。examples/session-01-solution/exercises/guard/answer/ にも解答の例があります。ただし、このフォルダのファイルは import のパスが mine/ のファイルと異なるため、mine/ にそのまま複写しても合格しません。解答の例を使うときは、「解答の例を見る」の内容を複写します。

判定の結果の読み方

  • 先頭の「結果:」の行が合否を示します。「合格です」と表示されれば合格です。
  • 誤った変更の行に「[検出]」と表示されれば、その変更を検出できています。「[未検出]」は、まだ検出できていないことを示します。
  • 正しいコードの行には「[誤検知なし]」と表示されるのが正しい状態です。「[誤検知あり]」は、追加した検出の仕組みが正しいコードまで失敗として扱っていることを示します。
  • 「[未判定]」は、実行のエラーで判定できなかったことを示します。「問題」の節に原因が表示されます。
  • 各行の下の「型のテスト / Linter / テスト」は、検出の仕組みごとの結果です。「検出 N件」は検出した件数、「−」は検出なし、「対象外」はその行の合否に数えない仕組み、「エラー」は実行の失敗を示します。
  • 「次にすること」の節は、次に取り組む作業を示します。
  • 合格するまでは、最後に ELIFECYCLE Command failed with exit code 1. と表示されます。この表示は不合格を示すもので、コマンドの不具合ではありません。

最初からやり直す

次のコマンドで、この演習のファイルへの編集を元に戻します。このコマンドは、自分で新しく作ったファイルを削除しません。

git restore examples/session-01-solution