assertNever を実装しても、後から default を「不明」を返す形に戻す変更が加えられる可能性があります。このように不具合を生むコードの変更を、誤った変更と呼びます。tsc(TypeScript の型検査コマンド)に追加する仕組みは、型のテスト、Linter のルール、テストの3種類です。
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
正しいコードからの変更(toStatusLabel の部分) − 削除した行 + 追加した行
export const toStatusLabel = (appointment: Appointment): string => {
switch (appointment.kind) {
// Scheduled から AwaitingPayment までの case は同じ
case "Paid":
return "会計済み";
case "Canceled":
return "キャンセル";
default:
return assertNever(appointment);
return "不明";
}
}; tsc は、「不明」を返す default を正しいコードとして通します。case を数える Linter のルールと、Paid を渡すテストが検出します。
export const toStatusLabel = (appointment: Appointment): string => {
switch (appointment.kind) {
// Scheduled から AwaitingPayment までの case は同じ
case "Paid":
return "会計済み";
case "Canceled":
return "キャンセル";
default:
return assertNever(appointment);
}
}; assertNever が残っているため、tsc は Paid が足りないことを型エラーとして報告します。Linter のルールとテストも検出します。tsc の検出は最初から備わっているため、次の演習の表では「対象外」と表示されます。それでも自分の仕組みで検出するのは、型エラーを無視して実行した場合や、tsc の結果を CI で失敗にしていない場合にも検出するためです。
type NoShow = Readonly<{
kind: "NoShow";
// appointmentId などのフィールド
}>;
export const toStatusLabel = (appointment: Appointment): string => {
export const toStatusLabel = (appointment: Appointment | NoShow): string => {
switch (appointment.kind) {
// 6つの case は同じ
default:
return assertNever(appointment);
return "不明";
}
}; default を「不明」に戻したため tsc は通り、6つの状態しか渡さないテストも通ります。Union の候補を数える Linter のルールだけが検出します。引数の型が Appointment | NoShow なのは、教材のコードの Appointment を書き換えずに7つ目の状態を仮に加えるためです。
export const toStatusLabel = (appointment: Appointment): string => {
export const toStatusLabel = (appointment: Readonly<{ kind: string }>): string => {
switch (appointment.kind) {
// 6つの case は同じ
default:
return assertNever(appointment);
return "不明";
}
}; kind が string になると Union ではないため、Linter のルールは候補を数えません。6つの状態を渡すテストも通ります。// @ts-expect-error は、次の行が型エラーになることを検証するようコンパイラに指示するコメントです。知らない状態を渡せるようになると型エラーが消えるため、TS2578 が報告されます。
export const toStatusLabel = (appointment: Appointment): string => {
switch (appointment.kind) {
// case と default をすべて消す
}
if (appointment.kind === "Scheduled") {
return "予約済み";
}
// CheckedIn, InExamination, AwaitingPayment も同じ形(Paid の if はない)
if (appointment.kind === "Canceled") {
return "キャンセル";
}
return "不明";
}; switch がなくなると Linter のルールは適用されず、tsc も通ります。値を渡して結果を検証するテストだけが検出します。
// toStatusLabel は元のコードのまま
export const toVisitReasonLabel = (reason: string): string => {
switch (reason) {
case "vaccination":
return "ワクチン接種";
default:
return "その他";
}
}; string は候補を数え上げられないため、この default は正しいコードです。ここで検出されたら誤検知です。
- tsc コードそのものの型検査▲ 未検出 ✓ 検出 ▲ 未検出 ▲ 未検出 ▲ 未検出 ✓ 誤検知なし
tsc --noEmittsc --noEmittsc --noEmittsc --noEmittsc --noEmittsc --noEmitエラーなしdefault の assertNever(appointment) の行で TS2345: …"Paid"… is not assignable to … 'never'.エラーなしエラーなしエラーなしエラーなし - 型のテスト 知らない状態を渡すコードを tsc に検査させる▲ 未検出 ▲ 未検出 ▲ 未検出 ✓ 検出 ▲ 未検出 ✓ 誤検知なし
// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });// @ts-expect-error toStatusLabel({ kind: "NoSuchState" });エラーなしエラーなしエラーなしstatusLabel.type-test.ts の @ts-expect-error の行で TS2578: Unused '@ts-expect-error' directive.エラーなしエラーなし - Linter のルール default があっても候補を数える✓ 検出 ✓ 検出 ✓ 検出 ▲ 未検出 ▲ 未検出 ✓ 誤検知なし
"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }"@typescript-eslint/switch-exhaustiveness-check" { considerDefaultExhaustiveForUnions: false }Switch is not exhaustive. Cases not matched: "Paid"Switch is not exhaustive. Cases not matched: "Paid"Switch is not exhaustive. Cases not matched: "NoShow"指摘なし指摘なし指摘なし - テスト 値を渡して表示名を検証する。テストは Linter の対象外で、
as neverを使えます✓ 検出 ✓ 検出 ▲ 未検出 ▲ 未検出 ✓ 検出 ✓ 誤検知なし// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);// 6つの状態をそれぞれ渡す expect(toStatusLabel({ kind } as never)).toBe(label);Paid: expected '不明' to be '会計済み'Paid: Unknown appointment status: {"kind":"Paid"}6件すべて成功6件すべて成功Paid: expected '不明' to be '会計済み'6件すべて成功