Shoehorn への移行

Shoehorn を使う理由

shoehorn を使うと、テストで部分的なデータを渡しつつ TypeScript を満たすことができます。as アサーションを型安全な代替案に置き換えます。

テストコードのみ使用可能。 本番コードで shoehorn を使用しないでください。

テストで as を使う際の問題点:

• 使わないよう指導されている
• 対象の型を手動で指定する必要がある
• 意図的に間違ったデータに対してダブルアサーション (as unknown as Type) が必要

インストール

npm i @total-typescript/shoehorn

移行パターン

必要なプロパティが少ない大きなオブジェクト

Before:

type Request = {
  body: { id: string };
  headers: Record<string, string>;
  cookies: Record<string, string>;
  // ...20 個以上のプロパティ
};

it("gets user by id", () => {
  // body.id だけが必要だが Request 全体をフェイクしなければならない
  getUser({
    body: { id: "123" },
    headers: {},
    cookies: {},
    // ...20 個のプロパティをフェイク
  });
});

After:

import { fromPartial } from "@total-typescript/shoehorn";

it("gets user by id", () => {
  getUser(
    fromPartial({
      body: { id: "123" },
    }),
  );
});

as Type → fromPartial()

Before:

getUser({ body: { id: "123" } } as Request);

After:

import { fromPartial } from "@total-typescript/shoehorn";

getUser(fromPartial({ body: { id: "123" } }));

as unknown as Type → fromAny()

Before:

getUser({ body: { id: 123 } } as unknown as Request); // 意図的に間違った型

After:

import { fromAny } from "@total-typescript/shoehorn";

getUser(fromAny({ body: { id: 123 } }));

各関数の使い分け

関数	用途
fromPartial()	型チェックを通す部分的なデータを渡す
fromAny()	意図的に間違ったデータを渡す (オートコンプリート継続)
fromExact()	完全なオブジェクトを強制 (後で fromPartial に置き換え可)

ワークフロー

1. 要件を確認 - ユーザーに質問:

   • どのテストファイルに問題を起こしている as アサーションがあるか?
   • 一部のプロパティだけが重要な大きなオブジェクトを扱っているか?
   • エラーテストのために意図的に間違ったデータを渡す必要があるか?

2. インストールして移行:

   • インストール: npm i @total-typescript/shoehorn
   • as アサーションを含むテストファイルを検索: grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"
   • as Type を fromPartial() に置き換える
   • as unknown as Type を fromAny() に置き換える
   • @total-typescript/shoehorn からインポートを追加
   • 型チェックを実行して確認