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("gets user by id", () => {
  // 只关心 body.id，但必须伪造整个 Request
  getUser({
    body: { id: "123" },
    headers: {},
    cookies: {},
    // ...伪造全部 20 个属性
  });
});

之后：

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); // 故意用错误的类型

之后：

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