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

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 } }));

何时使用每个

工作流程

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