修正後の状態は、前のページの値の性質のテストと型のテストに、Linter(コードを実行せずに書き方の問題を検出するツール)のルールを加えた3つの仕組みで守ります。タブ「route が parse を通さない」のコードは、演習の題材の短い route で、本編の routes.ts とは異なります。
正しいコードからの変更(parse の部分) − 削除した行 + 追加した行
正しいコードからの変更(parse の部分) − 削除した行 + 追加した行
正しいコードからの変更(handle の部分) − 削除した行 + 追加した行
正しいコードからの変更(schema の部分) − 削除した行 + 追加した行
正しいコードからの変更(toAuditPayload の部分) − 削除した行 + 追加した行
正しいコードからの変更(parse の部分) − 削除した行 + 追加した行
// import と型の定義は schema を使わない形に変える
export const StartExaminationInput = {
schema,
parse: schemaResult(schema),
parse: (raw: any): Result<StartExaminationInput> =>
ok({
appointmentId: raw.appointmentId,
veterinarianId: raw.veterinarianId,
}),
} as const; any は型検査を無効にするため、型検査(tsc)は通ります。書き方を検査するルールと、不正な値を渡すテストが検出します。
// import と型の定義は schema を使わない形に変える
export const StartExaminationInput = {
schema,
parse: schemaResult(schema),
parse: (raw: unknown): Result<StartExaminationInput> =>
ok(raw as StartExaminationInput),
} as const; as は値を検証せず、型だけを変えます。ルールが as の使用を検出し、テストが UUID でない値を通すことを検出します。
// import は type import に変える
export const handle = async (
): Promise<Readonly<{ status: number }>> => {
const input = StartExaminationInput.parse(await c.req.json())._unsafeUnwrap();
run(input);
const body = await c.req.json();
run(body);
return { status: 200 }; c.req.json() の戻り値は any であるため、そのまま渡しても型検査は通ります。any の受け渡しを検査するルールと、不正な本文を渡すテストが検出します。
// AppointmentId と VeterinarianId の import を消す
const schema = z.object({
appointmentId: AppointmentId.schema,
veterinarianId: VeterinarianId.schema,
appointmentId: z.string().brand<"AppointmentId">(),
veterinarianId: z.string().brand<"VeterinarianId">(),
}).readonly();
// 以降は同じ UUID でなくても型は合い、書き方にも問題はありません。値を多数試すテストだけが検出します。
// import と ExaminationStartedAuditPayload の型は消す
export const toAuditPayload = ({
// appointmentId、veterinarianId、examinationStartedAt の分割代入を消す
}: InExamination): ExaminationStartedAuditPayload => ({
export const toAuditPayload = (appointment: InExamination) => ({
// 3 項目は appointment から取る
ownerContact: clinicFixture.ownerContact,
}); 項目が増えると型エラーが消えて、// @ts-expect-error が未使用のまま残ります。値の性質のテストは余分な項目で失敗します。この表の Linter のルールは書き方の問題を検出しないため、このコードは通過します。
import { schemaResult } from "../../../src/domain/shared/schemaResult.js";
const fieldNames = ["appointmentId", "veterinarianId"] as const;
// schema の定義は同じ
export const StartExaminationInput = {
schema,
fieldNames,
parse: schemaResult(schema),
} as const; as const は値を変えず、型も偽らないため、assertionStyle を "never" にしてもルールは誤検知(正しいコードを誤った変更として検出すること)しません。
any や as の使用はルールと値の性質のテスト、UUID の検査の削除は値の性質のテストだけ、個人情報の追加は型のテストと値の性質のテストが検出します。演習の表では、検出できない仕組みは「対象外」と表示されます。
- 型のテスト Extra(残す3項目以外の項目名の型)に項目名を代入すると型エラーになることを検証する▲ 未検出 ▲ 未検出 ▲ 未検出 ▲ 未検出 ✓ 検出 ✓ 誤検知なし
type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";type Extra = Exclude<keyof Payload, "appointmentId" | …>; // @ts-expect-error ← 次の行が型エラーでなければエラー const extra: Extra = "ownerContact";エラーなしエラーなしエラーなしエラーなしTS2578: Unused '@ts-expect-error' directive.エラーなし - Linter のルール
rulesに記述する✓ 検出 ✓ 検出 ✓ 検出 ▲ 未検出 ▲ 未検出 ✓ 誤検知なし"@typescript-eslint/no-explicit-any": "error""@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]"@typescript-eslint/no-unsafe-assignment": "error" "@typescript-eslint/no-unsafe-argument": "error"// UUID の形は書き方に現れないので、どのルールも検出しません// 項目の追加は書き方に現れないので、どのルールも検出しません"@typescript-eslint/consistent-type-assertions": ["error", { assertionStyle: "never" }]no-explicit-any: Unexpected any. Specify a different type.consistent-type-assertions: Do not use any type assertions.no-unsafe-assignment: Unsafe assignment of an `any` value.エラーなしエラーなしエラーなし - 値の性質のテスト ランダムな入力を多数試す✓ 検出 ✓ 検出 ✓ 検出 ✓ 検出 ✓ 検出 ✓ 誤検知なし
fc.assert(fc.property(notUuid, (id) => StartExaminationInput.parse({ appointmentId: id, … }).isErr()));fc.assert(fc.property(notUuid, (id) => StartExaminationInput.parse({ appointmentId: id, … }).isErr()));// call: route に本文を渡すテスト用の関数 // seen: 診察開始の処理への入力。空の場合は未実行 const seen = await call({ appointmentId: id, … }); return seen.length === 0;fc.assert(fc.property(notUuid, (id) => StartExaminationInput.parse({ appointmentId: id, … }).isErr()));expect(toAuditPayload(appointment)).toEqual({ appointmentId: appointment.appointmentId, … });fc.assert(fc.property(notUuid, (id) => StartExaminationInput.parse({ appointmentId: id, … }).isErr()));3件失敗: Property failed2件失敗: Property failed after 1 tests1件失敗: Property failed after 1 tests2件失敗: Counterexample: [""]1件失敗: Property failed after 1 tests5件成功
eslint.config.mjs に追加するルールの候補
eslint.config.mjs の rules に "ルール名": "error" の形で記述します。
no-explicit-any:anyの使用を検出します。no-unsafe-assignment、no-unsafe-argument、no-unsafe-member-access、no-unsafe-call、no-unsafe-return:anyの値を使う箇所を検出します。consistent-type-assertionsの["error", { assertionStyle: "never" }]:asの型アサーションを検出します。
ルール名の前には @typescript-eslint/ が付きます。