Shoehorn'a Geçiş

Neden shoehorn?

shoehorn testlerde kısmi veri geçirmenizi sağlarken TypeScript'i mutlu tutar. as assertions'ını type-safe alternatiflerle değiştirir.

Sadece test kodu için. Shoehorn'u asla production kodunda kullanmayın.

Testlerde as kullanmanın sorunları:

• Kullanmamak için eğitildiniz
• Hedef tipi manuel olarak belirtmeniz gerekir
• İsteyerek yanlış veriler için double-as (as unknown as Type)

Kurulum

npm i @total-typescript/shoehorn

Geçiş desenleri

Az sayıda gerekli özelliği olan büyük nesneler

Öncesi:

type Request = {
  body: { id: string };
  headers: Record<string, string>;
  cookies: Record<string, string>;
  // ...20 daha fazla özellik
};

it("gets user by id", () => {
  // Sadece body.id'ye ihtiyaç duyar ama tüm Request'i fake etmeli
  getUser({
    body: { id: "123" },
    headers: {},
    cookies: {},
    // ...tüm 20 özelliği fake et
  });
});

Sonrası:

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

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

as Type → fromPartial()

Öncesi:

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

Sonrası:

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

getUser(fromPartial({ body: { id: "123" } }));

as unknown as Type → fromAny()

Öncesi:

getUser({ body: { id: 123 } } as unknown as Request); // isteyerek yanlış tip

Sonrası:

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

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

Her biri ne zaman kullanılmalı

Function	Kullanım durumu
fromPartial()	Yine de type-check olan kısmi veri geçir
fromAny()	İsteyerek yanlış veri geçir (autocomplete'i koru)
fromExact()	Tam nesneyi zorla (daha sonra fromPartial ile değiş)

İş akışı

1. Gereksinimleri toplayın - kullanıcıya sorun:

   • Hangi test dosyalarında as assertions sorun oluşturuyor?
   • Sadece bazı özelliklerin önemli olduğu büyük nesnelerle mi çalışıyorlar?
   • Hata testleri için isteyerek yanlış veri geçirmeleri mi gerekiyor?

2. Kurun ve geçişi yapın:

   • [ ] Kurun: npm i @total-typescript/shoehorn
   • [ ] as assertions'ı içeren test dosyalarını bulun: grep -r " as [A-Z]" --include="*.test.ts" --include="*.spec.ts"
   • [ ] as Type yerine fromPartial() yazın
   • [ ] as unknown as Type yerine fromAny() yazın
   • [ ] @total-typescript/shoehorn'dan import'ları ekleyin
   • [ ] Type check'i çalıştırarak doğrulayın