Références de projet TypeScript

Les références de projet sont une fonctionnalité fournie par TypeScript pour organiser les grands projets, permettant de diviser les projets TypeScript en parties plus petites.

Cela permet des compilations incrémentielles, une meilleure organisation du code et une compilation plus rapide.


Diagramme SVG : comment fonctionnent les références de projet Background Title Project References principle Main project Main project (app) package.json tsconfig.json references: [...] Arrow Referenced project 1 Component library (ui) Button, Modal, Input Referenced project 2 Utility library (utils) formatDate, request Referenced project 3 Type definitions (types) User, API Response Arrow marker

Pourquoi les références de projet sont nécessaires

À mesure qu'un projet grandit, un seul tsconfig.json peut ralentir la compilation.

Les références de projet permettent de diviser un projet en sous-projets indépendants, chacun pouvant être compilé indépendamment.

Cela améliore non seulement la vitesse de compilation, mais offre aussi une meilleure façon d'organiser le code.

Concept :Les références de projet permettent à un projet TypeScript de référencer d'autres projets, ce qui active la compilation incrémentielle et une meilleure organisation du code.


Création d'un projet référencé

Tout d'abord, créez le sous-projet référencé.

packages/utils/tsconfig.json

{
    // Hériter de la configuration de base
    "extends": "../../tsconfig.base.json",

    // Options du compilateur
    "compilerOptions": {
        // Répertoire de sortie
        "outDir": "./dist",

        // Répertoire des fichiers de déclaration
        "declarationDir": "./dist/types",

        // Générer les fichiers de déclaration
        "declaration": true,

        // Générer une sourcemap
        "sourceMap": true,

        // Indique s'il s'agit d'une bibliothèque
        "composite": true
    },

    // Fichiers inclus
    "include": ["src/**/*"],

    // Fichiers exclus
    "exclude": ["node_modules", "dist", "**/*.test.ts"]
}

composite:Définir sur true pour activer la fonctionnalité de références de projet ; c'est une option requise pour les projets référencés.


Configuration du projet principal

Configurez les références dans le fichier tsconfig.json du projet principal.

tsconfig.json (projet principal)

{
    // Hériter de la configuration de base
    "extends": "./tsconfig.base.json",

    // Options du compilateur
    "compilerOptions": {
        // Répertoire de sortie
        "outDir": "./dist",

        // Répertoire des fichiers de déclaration
        "declarationDir": "./dist/types",

        // Générer les fichiers de déclaration
        "declaration": true,

        // Générer une sourcemap
        "sourceMap": true
    },

    // Configuration des références de projet
    "references": [
        // Référence au projet utils
        { "path": "./packages/utils" },

        // Référence au projet ui
        { "path": "./packages/ui" },

        // Référence au projet types
        { "path": "./packages/types" }
    ],

    // Fichiers inclus
    "include": ["src/**/*"],

    // Les dépendances incluent les modules node
    // "files": []
}

references:Chaque objet du tableau spécifie le path d'un projet référencé ; path est relatif au projet actuel.


Références de type

Utiliser les types des projets référencés dans le code.

src/index.ts

// Importer les fonctions utilitaires (du paquet utils)
import { formatDate, formatCurrency } from '@my-utils/format';

// Importer les composants (du paquet ui)
import { Button, Modal, Input } from '@my-ui/core';

// Importer les types (du paquet types)
import { User, ApiResponse } from '@my-types/common';

// Définir les données utilisateur
const user: User = {
    id: 1,
    name: "Alice",
    email: "alice@example.com"
};

// Formater la date
const dateStr = formatDate(new Date(), "YYYY-MM-DD");
console.log("Date: " + dateStr);

// Formater la devise
const price = formatCurrency(999);
console.log("Prix : " + price);

// Créer l'interface utilisateur
const button = new Button({
    text: "Envoyer",
    variant: "primary"
});

console.log("Application initialisée avec succès");

Méthodes d'importation :Les exports des projets référencés peuvent être importés directement ; TypeScript résoudra automatiquement les types.


Compilations incrémentielles

Les références de projet prennent en charge les compilations incrémentielles, en ne compilant que les parties modifiées.

Commandes de construction

# Compiler l'ensemble du projet (y compris toutes les références)
npm run build

# Compiler uniquement le projet principal (ne pas recompiler les dépendances)
npm run build -- --build

# Nettoyer et reconstruire
npm run clean
npm run build

# Compilation incrémentielle (recommandée)
# Après avoir modifié un paquet, recompiler uniquement ce paquet et les paquets qui en dépendent
npx tsc -b packages/utils
npx tsc -b packages/ui
npx tsc -b .

Compilation incrémentielle :Lors de l'utilisation de l'option -b (build), TypeScript détecte automatiquement quels projets doivent être recompilés.


Notes

  • option composite :Les projets référencés doivent définir composite: true
  • Répertoire de sortie :Chaque projet a besoin d'un répertoire de sortie indépendant
  • Fichiers de déclaration :Les projets référencés doivent générer des fichiers de déclaration
  • Ordre de compilation :Les projets dont on dépend doivent être compilés en premier

Bonnes pratiques :Divisez le code commun en packages indépendants et gérez-les avec des références de projet pour améliorer l'efficacité de compilation.


Résumé

Les références de projet sont une fonctionnalité essentielle de TypeScript pour gérer les grands projets.

  • references:Configurer les relations de référence de projet
  • composite:Activer les références de projet
  • Compilation incrémentale :Compiler uniquement les parties modifiées
  • Organisation du code :Diviser en modules indépendants

Suggestion :Dans les grands projets, utilisez les références de projet pour organiser le code et améliorer l'efficacité du développement.

Autres extensions