--- name: mattpocock-migrate-to-shoehorn description: "Migrate test fixtures to Shoehorn." license: MIT metadata: source: mattpocock/skills source-commit: 4ae2317ddb22b046e26455e4f9c9b3aaaf62212d upstream-name: migrate-to-shoehorn upstream-status: published adaptation: namespaced-port --- ## Skillz integration This is Matt Pocock's version. Skill references use the `mattpocock-` prefix. Read a referenced skill's `SKILL.md` through the host's skill loader or file tools. Map AskUserQuestion to the host's question tool and shell examples to its shell. Use delegation only when available and permitted by the active instructions; otherwise perform the same work sequentially and report that limit. The user's scope and repository rules govern setup, file writes, tracker changes, messages, schedules, publishing, merging, and cleanup. A skill invocation alone does not broaden the user's request. Preserve existing work and configuration. Verify provider examples against current primary documentation before use. Install Shoehorn as a development dependency using the repository's package manager. Keep deliberately invalid fixtures in tests. # Migrate to Shoehorn ## Why shoehorn? `shoehorn` lets you pass partial data in tests while keeping TypeScript happy. It replaces `as` assertions with type-safe alternatives. **Test code only.** Never use shoehorn in production code. Problems with `as` in tests: - Trained not to use it - Must manually specify target type - Double-as (`as unknown as Type`) for intentionally wrong data ## Install ```bash npm i @total-typescript/shoehorn ``` ## Migration patterns ### Large objects with few needed properties Before: ```ts type Request = { body: { id: string }; headers: Record; cookies: Record; // ...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" }, }), ); }); ``` ### `as Type` → `fromPartial()` Before: ```ts getUser({ body: { id: "123" } } as Request); ``` After: ```ts import { fromPartial } from "@total-typescript/shoehorn"; getUser(fromPartial({ body: { id: "123" } })); ``` ### `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 } })); ``` ## When to use each | Function | Use case | | --------------- | -------------------------------------------------- | | `fromPartial()` | Pass partial data that still type-checks | | `fromAny()` | Pass intentionally wrong data (keeps autocomplete) | | `fromExact()` | Force full object (swap with fromPartial later) | ## Workflow 1. **Gather requirements** - ask user: - What test files have `as` assertions causing problems? - Are they dealing with large objects where only some properties matter? - Do they need to pass intentionally wrong data for error testing? 2. **Install and migrate**: - [ ] Install: `npm i @total-typescript/shoehorn` - [ ] Find test files with `as` assertions: `grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"` - [ ] Replace `as Type` with `fromPartial()` - [ ] Replace `as unknown as Type` with `fromAny()` - [ ] Add imports from `@total-typescript/shoehorn` - [ ] Run type check to verify