migrate-to-shoehorn

name	migrate-to-shoehorn
description	将测试文件中的 `as` 类型断言迁移到 @total-typescript/shoehorn。当用户提到 shoehorn、想要在测试中替换 `as`、或需要部分测试数据时使用。

迁移到 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 多个属性
};

it("根据 id 获取用户", () => {
  // 只关心 body.id 但必须伪造整个 Request
  getUser({
    body: { id: "123" },
    headers: {},
    cookies: {},
    // ...伪造全部 20 多个属性
  });
});

迁移后：

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

it("根据 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); // 故意使用错误类型

迁移后：

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 的导入
   • 运行类型检查以验证