mcpField
M
migrate-to-shoehorn

migrate-to-shoehorn

github.com/vinvcnTesting & quality5.4k5.5k installsUpdated 1d ago
Repository

About migrate-to-shoehorn

A skill for migrating TypeScript test code from type assertions to @total-typescript/shoehorn. It guides use of fromPartial, fromAny, and fromExact to construct test data, and limits shoehorn to tests.

Key features

  1. 01Replace assertions with fromPartial
  2. 02Create deliberately invalid data with fromAny
  3. 03Require full objects with fromExact
  4. 04Find assertions in test files
  5. 05Verify migration with type checking

Use cases

  1. 01Provide only needed fields for large test objects
  2. 02Test handling of deliberately invalid data

Install

Copy the command and run it in a terminal.

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

After installing, type/migrate-to-shoehornin Claude Code to confirm it loaded.

Bundled filesagents/openai.yaml

Details

From the project 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 验证

Comments

Markdown supported