mcpField
M
migrate-to-shoehorn

migrate-to-shoehorn

github.com/vinvcn测试与质量5.4k5.5k 次安装1 天前更新
代码仓库

关于 migrate-to-shoehorn

用于在 TypeScript 测试代码中将类型断言迁移到 @total-typescript/shoehorn 的技能。它指导使用 fromPartial、fromAny 和 fromExact 构造测试数据，并强调 shoehorn 仅用于测试。

主要功能

  1. 01用 fromPartial 替换类型断言
  2. 02用 fromAny 构造故意错误的数据
  3. 03用 fromExact 强制完整对象
  4. 04查找测试文件中的断言
  5. 05运行类型检查验证迁移

适用场景

  1. 01为大型对象只提供测试所需属性
  2. 02测试错误类型数据的处理路径

安装

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

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

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

附带文件agents/openai.yaml

README 原文English

来自项目 README

README 暂无中文译文，以下为英文原文；中文介绍见上方。

迁移到 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）

安装

npm i @total-typescript/shoehorn

迁移模式

只需要少数属性的大型 objects

Before:

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:

import { fromPartial } from "@total-typescript/shoehorn";

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

Before:

getUser({ body: { id: "123" } } as Request);

After:

import { fromPartial } from "@total-typescript/shoehorn";

getUser(fromPartial({ body: { id: "123" } }));
as unknown as Type → fromAny()

Before:

getUser({ body: { id: 123 } } as unknown as Request); // wrong type on purpose

After:

import { fromAny } from "@total-typescript/shoehorn";

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

何时使用哪一个

FunctionUse case
fromPartial()传入仍能 type-check 的 partial data
fromAny()传入故意错误的数据（保留 autocomplete）
fromExact()强制 full object（之后可换成 fromPartial）

工作流

  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 验证

评论

支持 Markdown