🚀 快速安装

复制以下命令并运行，立即安装此 Skill：

npx skills add https://skills.sh/mattpocock/skills/migrate-to-shoehorn

💡 提示：需要 Node.js 和 NPM

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

📄 原始文档

完整文档（英文）：

https://skills.sh/mattpocock/skills/migrate-to-shoehorn

💡 提示：点击上方链接查看 skills.sh 原始英文文档，方便对照翻译。

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。