TypeScript-Projektverweise
Projektverweise sind eine von TypeScript bereitgestellte Funktion zur Organisation großer Projekte, mit der TypeScript-Projekte in kleinere Teile aufgeteilt werden können.
Sie ermöglichen inkrementelle Builds, eine bessere Codeorganisation und eine schnellere Kompilierung.
SVG-Diagramm: Funktionsweise von Projektverweisen
Warum Projektreferenzen benötigt werden
Wenn ein Projekt wächst, kann eine einzelne tsconfig.json die Kompilierung verlangsamen.
Projektreferenzen ermöglichen es, ein Projekt in unabhängige Teilprojekte aufzuteilen, die jeweils unabhängig kompiliert werden können.
Dies verbessert nicht nur die Kompilierungsgeschwindigkeit, sondern bietet auch eine bessere Möglichkeit, Code zu organisieren.
Konzept:Projektreferenzen ermöglichen es einem TypeScript-Projekt, auf andere Projekte zu verweisen, was inkrementelle Kompilierung und eine bessere Codeorganisation ermöglicht.
Ein referenziertes Projekt erstellen
Erstellen Sie zunächst das referenzierte Teilprojekt.
packages/utils/tsconfig.json
// Basiskonfiguration erben
"extends": "../../tsconfig.base.json",
// Compiler-Optionen
"compilerOptions": {
// Ausgabeverzeichnis
"outDir": "./dist",
// Verzeichnis für Deklarationsdateien
"declarationDir": "./dist/types",
// Deklarationsdateien generieren
"declaration": true,
// Sourcemap generieren
"sourceMap": true,
// Ob es sich um eine Bibliothek handelt
"composite": true
},
// Enthaltene Dateien
"include": ["src/**/*"],
// Ausgeschlossene Dateien
"exclude": ["node_modules", "dist", "**/*.test.ts"]
}
composite:Auf true setzen, um die Projektreferenzfunktion zu aktivieren; dies ist eine erforderliche Option für referenzierte Projekte.
Konfiguration des Hauptprojekts
Konfigurieren Sie Referenzen in der tsconfig.json des Hauptprojekts.
tsconfig.json (Hauptprojekt)
// Basiskonfiguration erben
"extends": "./tsconfig.base.json",
// Compiler-Optionen
"compilerOptions": {
// Ausgabeverzeichnis
"outDir": "./dist",
// Verzeichnis für Deklarationsdateien
"declarationDir": "./dist/types",
// Deklarationsdateien generieren
"declaration": true,
// Sourcemap generieren
"sourceMap": true
},
// Konfiguration der Projektverweise
"references": [
// Verweis auf das utils-Projekt
{ "path": "./packages/utils" },
// Verweis auf das ui-Projekt
{ "path": "./packages/ui" },
// Verweis auf das types-Projekt
{ "path": "./packages/types" }
],
// Enthaltene Dateien
"include": ["src/**/*"],
// Abhängigkeiten umfassen Node-Module
// "files": []
}
references:Jedes Objekt im Array gibt den Pfad eines referenzierten Projekts an; path ist relativ zum aktuellen Projekt.
Typverweise
Verwende Typen aus referenzierten Projekten im Code.
src/index.ts
import { formatDate, formatCurrency } from '@my-utils/format';
// Komponenten importieren (aus dem ui-Paket)
import { Button, Modal, Input } from '@my-ui/core';
// Typen importieren (aus dem types-Paket)
import { User, ApiResponse } from '@my-types/common';
// Benutzerdaten definieren
const user: User = {
id: 1,
name: "Alice",
email: "alice@example.com"
};
// Datum formatieren
const dateStr = formatDate(new Date(), "YYYY-MM-DD");
console.log("Datum: " + dateStr);
// Währung formatieren
const price = formatCurrency(999);
console.log("Preis: " + price);
// Benutzeroberfläche erstellen
const button = new Button({
text: "Absenden",
variant: "primary"
});
console.log("Anwendung erfolgreich initialisiert");
Importmethoden:Exporte aus referenzierten Projekten können direkt importiert werden; TypeScript löst die Typen automatisch auf.
Inkrementelle Builds
Projektreferenzen unterstützen inkrementelle Builds, wobei nur die geänderten Teile kompiliert werden.
Build-Befehle
npm run build
# Nur das Hauptprojekt bauen (Abhängigkeiten nicht neu bauen)
npm run build -- --build
# Bereinigen und neu erstellen
npm run clean
npm run build
# Inkrementeller Build (empfohlen)
# Nach dem Ändern eines Pakets nur dieses Paket und die davon abhängigen Pakete neu kompilieren
npx tsc -b packages/utils
npx tsc -b packages/ui
npx tsc -b .
Inkrementeller Build:Bei Verwendung der Option -b (build) erkennt TypeScript automatisch, welche Projekte neu kompiliert werden müssen.
Hinweise
- composite-Option:Referenzierte Projekte müssen composite: true setzen
- Ausgabeverzeichnis:Jedes Projekt benötigt ein eigenes Ausgabeverzeichnis
- Deklarationsdateien:Referenzierte Projekte müssen Deklarationsdateien generieren
- Build-Reihenfolge:Abhängige Projekte müssen zuerst gebaut werden
Best Practices:Gemeinsamen Code in unabhängige Pakete aufteilen und mit Projektverweisen verwalten, um die Kompilierungseffizienz zu verbessern.
Zusammenfassung
Projektverweise sind eine Kernfunktion von TypeScript für die Verwaltung großer Projekte.
- references:Projektverweisbeziehungen konfigurieren
- composite:Projektverweise aktivieren
- Inkrementeller Build:Nur die geänderten Teile kompilieren
- Codeorganisation:In unabhängige Module aufteilen
Weitere ErweiterungenEmpfehlung:In großen Projekten Projektverweise verwenden, um Code zu organisieren und die Entwicklungseffizienz zu verbessern.