Back to Details

migrate-to-shoehorn

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Migrate to Shoehorn

迁移至Shoehorn

Why shoehorn?

为什么选择Shoehorn？

shoehorn
允许你在 tests 中传入 partial data，同时保持 TypeScript 满意。它用 type-safe alternatives 替换 
as
assertions。
只用于 test code。 永远不要在 production code 中使用 shoehorn。
Tests 中 
as
的问题：
  • 会训练人忽略类型安全
  • 必须手动指定 target type
  • 对故意错误的数据需要 double-as（
    as unknown as Type
    ）
shoehorn
允许你在测试中传入部分数据（partial data），同时满足TypeScript的类型检查要求。它用类型安全的替代方案替换
as
类型断言。
仅用于测试代码。 切勿在生产代码中使用shoehorn。
测试中使用
as
的问题：
  • 会引导开发者忽略类型安全
  • 必须手动指定目标类型
  • 传入故意错误的数据时需要双重断言（
    as unknown as Type
    ）

Install

安装

bash
npm i @total-typescript/shoehorn
bash
npm i @total-typescript/shoehorn

Migration patterns

迁移模式

Large objects with few needed properties

仅需少数属性的大型对象

Before:
ts
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
  });
});
After:
ts
import { fromPartial } from "@total-typescript/shoehorn";

it("gets user by id", () => {
  getUser(
    fromPartial({
      body: { id: "123" },
    }),
  );
});
迁移前：
ts
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个属性
  });
});
迁移后：
ts
import { fromPartial } from "@total-typescript/shoehorn";

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

as Type
→ 
fromPartial()

as Type
→ 
fromPartial()

Before:
ts
getUser({ body: { id: "123" } } as Request);
After:
ts
import { fromPartial } from "@total-typescript/shoehorn";

getUser(fromPartial({ body: { id: "123" } }));
迁移前：
ts
getUser({ body: { id: "123" } } as Request);
迁移后：
ts
import { fromPartial } from "@total-typescript/shoehorn";

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

as unknown as Type
→ 
fromAny()

as unknown as Type
→ 
fromAny()

Before:
ts
getUser({ body: { id: 123 } } as unknown as Request); // wrong type on purpose
After:
ts
import { fromAny } from "@total-typescript/shoehorn";

getUser(fromAny({ body: { id: 123 } }));
迁移前：
ts
getUser({ body: { id: 123 } } as unknown as Request); // 故意传入错误类型
迁移后：
ts
import { fromAny } from "@total-typescript/shoehorn";

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

When to use each

各函数适用场景

FunctionUse case
fromPartial()
传入仍能 type-check 的 partial data
fromAny()
传入故意错误的数据（保留 autocomplete）
fromExact()
强制 full object（之后可换成 fromPartial）
函数名称适用场景
fromPartial()
传入仍可进行类型检查的部分数据
fromAny()
传入故意错误的数据（保留自动补全功能）
fromExact()
强制传入完整对象（后续可替换为fromPartial）

Workflow

工作流程

  1. Gather requirements — 询问用户：
    • 哪些 test files 中的 
      as
      assertions 造成问题？
    • 是否在处理大型 objects，但只关心部分 properties？
    • 是否需要传入故意错误的数据来测试 error paths？
  2. Install and migrate：
    • Install: 
      npm i @total-typescript/shoehorn
    • 查找 test files 中的 
      as
      assertions: 
      grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"
    • 用 
      fromPartial()
      替换 
      as Type
    • 用 
      fromAny()
      替换 
      as unknown as Type
    • 添加来自 
      @total-typescript/shoehorn
      的 imports
    • 运行 type check 验证
  1. 收集需求 — 询问用户：
    • 哪些测试文件中的
      as
      类型断言存在问题？
    • 是否在处理大型对象，但只关心其中部分属性？
    • 是否需要传入故意错误的数据来测试错误路径？
  2. 安装并迁移：
    • 安装：
      npm i @total-typescript/shoehorn
    • 查找测试文件中的
      as
      类型断言：
      grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"
    • 用
      fromPartial()
      替换
      as Type
    • 用
      fromAny()
      替换
      as unknown as Type
    • 添加来自
      @total-typescript/shoehorn
      的导入语句
    • 运行类型检查验证