ホーム 全セッション S04

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

16 / 19 目安 10分

ページ一覧

解決策(課題3): 学んだ仕組みを追加して、3件の誤った変更を検出します。

eslint.config.mjsimport tseslint from "typescript-eslint";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件の検出、正しいコード2件の誤検知なし、型検査の通過がすべて満たされると合格です。検出できないことの記述と話し合いは、プログラムでは判定しません。

この演習の手順

  1. 読む: 左の一覧の誤った変更を読みます。useCase は修正せず、検出する仕組みだけを追加します。route の _unsafeUnwrap は扱いません。useCase の中のものは、任意の誤った変更で扱います。
  2. 選ぶ: 必須の3件それぞれについて、検出する仕組みを Linter のルールとテストから選び、選んだ理由を1文で、自分のメモに記載します。判断の材料は、その変更がコードの書き方(構文)に現れるか、実行したときの動作にだけ現れるかです。どの変更でも型検査は通ります。
  3. 作る: 選んだ仕組みを実装します。ルールを選んだ場合は、「Linter のルールの書き方」の例を参考に、検出する構文を表す selector と message を、eslint.config.mjs の const rules = {} の {} の中に実装します。テストは mine/startExamination.test.ts に実装します。最初の1件が記述例です。例外が投げられると outcome.kind が threw になり、outcome.error に例外が格納されます。
    Linter のルールの書き方

    selector は、検出するコードの形を指定します。下の例の VariableDeclarator[id.name='startExamination'] は、startExamination という名前の変数宣言(useCase)を指し、ThrowStatement は、throw 文を表す構文の名前です。この組み合わせで、検出の範囲を useCase の中に限定します。ThrowStatement だけを指定すると、useCase の外の正当な throw も誤検知(正しいコードを誤った変更として検出すること)になります。ルールが検出するのは useCase に実装された throw だけで、useCase の外で発生した例外は検出しません。

    実装先: eslint.config.mjs の3行目の {} の中
    "no-restricted-syntax": [
      "error",
      {
        selector: "VariableDeclarator[id.name='startExamination'] ThrowStatement",
        message: "業務の失敗を throw しません。失敗は err で返します。",
      },
    ],
  4. 確認する: 「検出を検証する」を押します。「誤検知」は、正しいコードを誤った変更として検出することです。「対象外」は、この教材の判定で、その誤った変更の検出に数えない仕組みです。答え合わせは、「解答の例を見る」の必須3件の検出結果と理由で行います。
  5. 合格すると、任意の誤った変更が一覧に追加されます。一覧の「_unsafeUnwrap で、失敗を例外に変える」などの名前を押して、自分の仕組みで検出されない変更を探します。検出されない変更が見つかったときは、表のその行を開き、「この仕組みで検出できないこと」に、その変更が何を変えるかと、検出されない理由を1文で記入します。班で議論するか、1人の場合は記入した文を読み返します。

手元のエディタで解く

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

必要なツール

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

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

判定の結果の読み方

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

最初からやり直す

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

git restore examples/session-04-solution