migrate-to-shoehorn

Shoehorn への移行

なぜ shoehorn なのですか？

shoehorn を使うと、TypeScript の型チェックを通しながら、テストで部分的なデータを渡せます。as アサーションを型安全な代替手段に置き換えます。

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

テストで as を使用する場合の問題点：

• 使用しないように指導されている
• 対象の型を手動で指定する必要がある
• 意図的に誤ったデータを渡すには、二重の as（as unknown as Type）が必要

インストール

npm i @total-typescript/shoehorn

移行パターン

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

移行前：

type Request = {
  body: { id: string };
  headers: Record<string, string>;
  cookies: Record<string, string>;
  // ...20 more properties
};

it("gets user by id", () => {
  // Only care about body.id but must fake entire Request
  getUser({
    body: { id: "123" },
    headers: {},
    cookies: {},
    // ...fake all 20 properties
  });
});

移行後：

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

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

as Type → fromPartial()

移行前：

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

移行後：

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

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

as unknown as Type → fromAny()

移行前：

getUser({ body: { id: 123 } } as unknown as Request); // wrong type on purpose

移行後：

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 からインポートを追加する
   • 型チェックを実行して確認する