mcpField
M
migrate-to-shoehorn

migrate-to-shoehorn

github.com/devcxl测试与质量52068 次安装1 天前更新
代码仓库

关于 migrate-to-shoehorn

migrate-to-shoehorn 是帮助 TypeScript 项目将测试代码中的类型断言迁移到 shoehorn 函数的技能。它根据部分数据或故意错误数据等测试需求，选择相应函数并指导迁移。

主要功能

  1. 01用 fromPartial 替换部分对象断言
  2. 02用 fromAny 表示故意错误数据
  3. 03用 fromExact 强制完整对象
  4. 04指导安装与测试文件迁移
  5. 05通过类型检查验证迁移

适用场景

  1. 01为大型对象构造部分测试数据
  2. 02编写故意传入错误类型的测试
  3. 03清理测试中的双重类型断言

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/devcxl/mattpocock-skills-zh --skill migrate-to-shoehorn

安装后在 Claude Code 中输入/migrate-to-shoehorn确认已加载。

附带文件agents/openai.yaml

详细介绍

来自项目 README

迁移到 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 添加 import
    • 运行类型检查以验证

评论

支持 Markdown