migrate-to-shoehorn · diff
git:20260428.62f43a1 to git:20260806.5bfe60b
31 added, 31 removed. Audit A to A.
---
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.
+ description: 將測試檔案從 `as` 型別斷言遷移到 @total-typescript/shoehorn。當使用者提到 shoehorn、想在測試中取代 `as`，或需要部分測試資料時使用。
---
- # Migrate to Shoehorn
+ # 遷移到 Shoehorn
- ## Why shoehorn?
+ ## 為什麼用 shoehorn？
- `shoehorn` lets you pass partial data in tests while keeping TypeScript happy. It replaces `as` assertions with type-safe alternatives.
+ `shoehorn` 讓您可以在測試中傳入部分資料，同時讓 TypeScript 保持滿意。它以型別安全的替代方案取代 `as` 斷言。
- **Test code only.** Never use shoehorn in production code.
+ **僅限測試程式碼。** 絕不要在正式程式碼中使用 shoehorn。
- Problems with `as` in tests:
+ 測試中 `as` 的問題：
- - Trained not to use it
- - Must manually specify target type
- - Double-as (`as unknown as Type`) for intentionally wrong data
+ - 被訓練成不要使用它
+ - 必須手動指定目標型別
+ - 對刻意錯誤的資料使用雙重 `as`（`as unknown as Type`）
- ## 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?
+ 1. **收集需求** - 詢問使用者：
+ - 哪些測試檔案有造成問題的 `as` 斷言？
+ - 他們是否在處理只有某些屬性重要的大型物件？
+ - 他們是否需要傳入刻意錯誤的資料來進行錯誤測試？
- 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
+ 2. **安裝並遷移**：
+ - [ ] 安裝：`npm i @total-typescript/shoehorn`
+ - [ ] 找到帶有 `as` 斷言的測試檔案：`grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"`
+ - [ ] 用 `fromPartial()` 取代 `as Type`
+ - [ ] 用 `fromAny()` 取代 `as unknown as Type`
+ - [ ] 從 `@total-typescript/shoehorn` 新增 imports
+ - [ ] 執行型別檢查來驗證