antfu
Konwencje i narzędzia Anthony'ego Fu dla projektów JavaScript/TypeScript
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill zawierający opinionated setup Anthony'ego Fu dla projektów JavaScript i TypeScript. Obejmuje praktyki kodowania, organizację plików, konfigurację TypeScript, testowanie z Vitest oraz wybór narzędzi takich jak @antfu/ni. Użyj go przy tworzeniu nowych projektów, konfiguracji ESLint/Prettier alternatyw, zarządzaniu monorepo czy publikowaniu bibliotek. Idealny, gdy chcesz zastosować preferencje i standardy Anthony'ego Fu w swoim kodzie.
Jak używać
Zainstaluj narzędzie @antfu/ni, które upraszcza zarządzanie zależnościami niezależnie od menedżera pakietów (npm, yarn, pnpm). Uruchom
ni, aby zainstalować zależności projektu, lubni -D pakiet, aby dodać paczkę jako devDependency.Organizuj kod zgodnie z zasadą single responsibility — każdy plik powinien mieć jasny, skoncentrowany cel. Gdy plik rośnie, podziel go na mniejsze moduły. Wydziel typy do pliku
types.tslub folderutypes/*.ts, a stałe doconstants.ts.Pisz kod isomorphic, który działa w Node.js, przeglądarce i workers. Gdy kod jest specyficzny dla środowiska, oznacz to komentarzem na górze pliku:
// @env nodelub// @env browser.W TypeScript zawsze deklaruj jawnie typy zwracane przez funkcje i wydzielaj złożone typy do dedykowanych deklaracji
typelubinterfacezamiast definiować je inline.Dodawaj komentarze, które wyjaśniają "dlaczego", a nie "jak" — kod powinien być samowyjaśniający się. Unikaj zbędnych komentarzy opisujących oczywiste operacje.
Testuj z Vitest — umieszczaj testy w tym samym katalogu co kod (
foo.ts→foo.test.ts), używaj APIdescribe/it, a dla złożonych wyników stosujtoMatchSnapshotlubtoMatchFileSnapshotz jawną ścieżką.