TypeScript Academy · Lekcja

Objaśnienie referencji projektów TypeScript

Używaj ustawień composite i references podczas kompilacji wielu pakietów.

Lekcja 1 z 413 kroki

Objaśnienie referencji projektów TypeScript to bezpłatna lekcja TypeScript Academy na CoddyKit. To lekcja 1 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej TypeScript Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs TypeScript Academy zawiera 4 lekcji w sumie.

Czym są referencje projektów

Referencje projektów pozwalają podzielić bazę kodu TypeScript na wiele projektów tsconfig, które deklarują wzajemne zależności, umożliwiając przyrostowe i izolowane kompilacje.

// tsconfig.json (root)
{
  "references": [
    { "path": "./packages/core" },
    { "path": "./packages/ui" }
  ]
}

Projekty kompozytowe

Każdy projekt, do którego istnieje odwołanie, musi mieć w swoim tsconfig ustawienie "composite": true. Włącza ono buforowanie deklaracji i śledzenie zależności.

// packages/core/tsconfig.json
{
  "compilerOptions": {
    "composite": true,
    "declaration": true,
    "outDir": "./dist"
  }
}

Kompilowanie za pomocą tsc --build

Należy uruchomić tsc --build (lub tsc -b) w katalogu głównym, aby skompilować wszystkie projekty, do których istnieją odwołania, w kolejności wynikającej z zależności.

# Build all projects
tsc --build

# Build and watch
tsc --build --watch

# Clean build outputs
tsc --build --clean

Kompilacje przyrostowe

Po pierwszej kompilacji tsc --build ponownie kompiluje tylko te projekty, których pliki źródłowe lub zależności uległy zmianie, znacznie przyspieszając pracę z dużymi repozytoriami.

# Only changed packages are rebuilt
tsc --build
# Output: 2/5 projects up to date — skipping

Korzystanie z plików deklaracji

Projekt, do którego istnieje odwołanie, korzysta ze swoich zależności za pośrednictwem wygenerowanych plików .d.ts w katalogu dist/, a nie przez ponowne analizowanie źródłowych plików TypeScript.

// packages/ui imports from packages/core
import { Button } from "@myapp/core"; // resolved via dist/index.d.ts

Konfiguracja ścieżek

Należy skonfigurować paths w głównym tsconfig albo użyć exports w package.json, aby TypeScript prawidłowo rozwiązywał importy pakietów podczas tworzenia aplikacji.

{
  "compilerOptions": {
    "paths": {
      "@myapp/core": ["./packages/core/src/index.ts"]
    }
  }
}

Zachowanie kolejności kompilacji

TypeScript automatycznie określa kolejność kompilacji na podstawie grafu referencji. Odwołania cykliczne są wykrywane i zgłaszane jako błędy.

// Circular reference error example:
// packages/core references packages/ui
// packages/ui references packages/core
// Error: Circular project reference

outDir i rootDir

Każdy projekt kompozytowy powinien mieć skonfigurowane outDir i rootDir, aby kontrolować układ plików wynikowych i zapobiegać przedostawaniu się plików poza granice pakietu.

{
  "compilerOptions": {
    "rootDir": "./src",
    "outDir": "./dist"
  }
}

Integracja z narzędziami do kompilacji

Turborepo, Nx i Lerna integrują się z referencjami projektów, aby buforować i uruchamiać równolegle kompilacje na podstawie grafu zależności.

// turbo.json — declare TypeScript build as a pipeline step
{
  "pipeline": {
    "build": { "dependsOn": ["^build"], "outputs": ["dist/**"] }
  }
}

Obserwowanie wielu projektów

tsc --build --watch obserwuje wszystkie projekty, do których istnieją odwołania, i przyrostowo kompiluje je po każdej zmianie, zapewniając niemal natychmiastową informację zwrotną w monorepo.

# Terminal: tsc --build --watch
# [9:00:01 AM] Found 0 errors. Watching for file changes.

Podsumowanie: referencje projektów

Referencje projektów dzielą TypeScript na izolowane jednostki kompilacji, które można buforować. Należy ustawić composite: true, zadeklarować references i używać tsc --build, aby uzyskać szybką i poprawną kompilację przyrostową w monorepo.

Szybkie sprawdzenie

Jaka opcja tsconfig jest wymagana, aby inny projekt mógł odwoływać się do danego projektu?

Czego się Państwo nauczyli

Referencje projektów TypeScript umożliwiają szybką i izolowaną kompilację w monorepo. Należy skonfigurować composite: true, zadeklarować zależności za pomocą references i kompilować przy użyciu tsc --build, aby uzyskać kompilację przyrostową.

Bezpłatny start

Ucz się TypeScript dzięki korepetycjom AI — za darmo

Pisz i uruchamiaj kod w przeglądarce, otrzymuj natychmiastową pomoc od korepetytora AI dostępnego 24/7 i kontynuuj naukę w sieci lub w aplikacji.

Kursy
101
Lekcje
352

Często zadawane pytania

Czy lekcja „Objaśnienie referencji projektów TypeScript” jest bezpłatna?

Tak — pełny tekst „Objaśnienie referencji projektów TypeScript” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu TypeScript Academy, przejdź na CoddyKit PRO. Kurs TypeScript Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „Objaśnienie referencji projektów TypeScript”?

Używaj ustawień composite i references podczas kompilacji wielu pakietów. Ćwiczysz TypeScript Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć TypeScript Academy?

Nie wymagamy żadnego doświadczenia. TypeScript Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 1 z 4.

Ile czasu zajmuje lekcja „Objaśnienie referencji projektów TypeScript”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji TypeScript Academy?

Tak. Każda lekcja TypeScript Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

  1. Objaśnienie referencji projektów TypeScript
  2. Obszary robocze pnpm z TypeScript
  3. Strategia pakietu współdzielonych typów
  4. Kompilacje przyrostowe i pamięć podręczna w monorepo
← Powrót do TypeScript Academy