migrate-to-shoehorn · v1.0 · 2026-09-11 · sha256 fb17f8398cae8d85
migrate-to-shoehorn v1.0A
Immutable. This exact content is served forever at /api/v1/blob/fb17f8398cae8d85.
---
name: migrate-to-shoehorn
description: >
Migrate test files from `as` type assertions to @total-typescript/shoehorn. Use when user
mentions shoehorn, wants to replace `as` in tests, or needs partial test data.
allowed-tools: Read Grep Glob Bash Write Edit
compatibility: >
TypeScript test files only. Route broader test policy to testing-strategies.
metadata:
tags: typescript, shoehorn, type-assertions, test-data, total-typescript
platforms: Claude, ChatGPT, Gemini, Codex
version: "1.0"
source: mattpocock/skills
upstream_commit: 3cca18b368ae95cdbdebbff572ccafa662551015
invocation: model-invoked
---
# Migrate to Shoehorn
Migrate test files from `as` type assertions to @total-typescript/shoehorn. Use when user mentions shoehorn, wants to replace `as` in tests, or needs partial test data.
This skill is imported from `mattpocock/skills` (MIT) and is **model-invoked** upstream.
## When to use this skill
- Migrate test files from `as` type assertions to @total-typescript/shoehorn.
- Use when user mentions shoehorn, wants to replace `as` in tests, or needs partial test data.
## Instructions
## 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<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:
```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
## Examples
- Apply this skill to one narrow scope first, confirm the output matches the shape described above, then widen to the full task.
- When a step needs a fact from the repository or the environment, look it up instead of asking the user for it.
## Best practices
- Keep the upstream procedure intact; record deviations explicitly instead of silently improvising.
- Stop and hand control back to the user at every decision point this skill marks as theirs.
- Prefer small reversible changes, and state assumptions rather than burying them.
## References
- Upstream skill: `mattpocock/skills` `skills/misc/migrate-to-shoehorn/SKILL.md` (commit `3cca18b`, MIT)
- Project standards: `.agent-skills/skill-standardization/SKILL.md`
- Validator script: `.agent-skills/skill-standardization/scripts/validate_skill.sh`