Options du compilateur TypeScript

Le compilateur TypeScript (tsc) possède de nombreuses options de compilation. Ce tutoriel fournit une introduction détaillée aux options de compilation couramment utilisées et à leurs objectifs.

Diagramme SVG : processus de compilation TypeScript Background Title TypeScript Compilation Process and Compiler Options Source Code TypeScript Source Code .ts / .tsx Contains Type Annotations Arrow 1 TypeScript Compiler TypeScript Compiler (tsc) Compiler Options Compiler Option Functions: • Type checking (strict) • Output format (module) • Target version (target) • Declaration files (declaration) ...More options Arrow 2 Compilation Output Compilation Output .js - JavaScript .d.ts - Type Declarations .map - Source Map Lower Section: Compiler Option Categories Compiler Option Categories Category 1 Type Checking strict noImplicitAny strictNullChecks Category 2 Output Control outDir declaration sourceMap Category 3 Module System module moduleResolution esModuleInterop Category 4 Language Features target lib jsx Arrow Marker

Options de contrôle de sortie

Exemple

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

        // Répertoire racine des sources
        "rootDir": "./src",

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

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

        // Générer les cartes sources
        "sourceMap": true,

        // Générer les fichiers .js.map
        "mapRoot": "./map"
    }
}

Options de vérification des types

Exemple

{
    "compilerOptions": {
        // Mode strict (recommandé de toujours l'activer)
        "strict": true,

        // Vérifier null et undefined
        "strictNullChecks": true,

        // Vérifier le paramètre this
        "noImplicitThis": true,

        // Types de fonctions stricts
        "strictFunctionTypes": true,

        // Initialisation stricte des propriétés
        "strictPropertyInitialization": true,

        // Interdire les any implicites
        "noImplicitAny": true,

        // Interdire le retour de void
        "noImplicitReturns": true,

        // Activer toutes les vérifications strictes
        "strict": true
    }
}

Options de module

Exemple

{
    "compilerOptions": {
        // Système de modules
        "module": "commonjs",

        // Stratégie de résolution des modules
        "moduleResolution": "node",

        // Chemin de base pour la résolution
        "baseUrl": ".",

        // Alias de chemins
        "paths": {
            "@/*": ["src/*"]
        },

        // Interopérabilité des modules ES
        "esModuleInterop": true,

        // Autoriser les imports par défaut
        "allowSyntheticDefaultImports": true,

        // Isoler les modules
        "isolatedModules": true
    }
}

Options de fonctionnalités ES

Exemple

{
    "compilerOptions": {
        // Cible de compilation
        "target": "ES2020",

        // Bibliothèques activées
        "lib": ["ES2020", "DOM"],

        // Autoriser les variables locales inutilisées
        "noUnusedLocals": true,

        // Autoriser les paramètres inutilisés
        "noUnusedParameters": true,

        // Abaissement du code
        "downlevelIteration": true
    }
}

Options expérimentales

Exemple

{
    "compilerOptions": {
        // Activer les décorateurs
        "experimentalDecorators": true,

        // Activer les métadonnées de décorateur
        "emitDecoratorMetadata": true,

        // Activer les itérateurs asynchrones
        "emitDecoratorMetadata": true,

        // Ignorer les vérifications de bibliothèque
        "skipLibCheck": true
    }
}

Combinaisons courantes d'options du compilateur

Exemple

// Configuration recommandée pour les projets Node.js
{
    "compilerOptions": {
        "target": "ES2020",
        "module": "commonjs",
        "lib": ["ES2020"],
        "outDir": "./dist",
        "rootDir": "./src",
        "strict": true,
        "esModuleInterop": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true,
        "moduleResolution": "node",
        "declaration": true
    }
}

Tableau des options du compilateur

Catégorie Options courantes
Sortie outDir, rootDir, declaration, sourceMap
Vérification des types strict, strictNullChecks, noImplicitAny
Module module, moduleResolution, paths, esModuleInterop
Fonctionnalités ES target, lib, downlevelIteration
Expérimental experimentalDecorators, emitDecoratorMetadata

Résumé

  • Mode strict :Toujours activer strict: true
  • Version cible :Choisissez la cible appropriée en fonction de l’environnement
  • Système de modules :Choisissez module en fonction de l’environnement de déploiement
  • Déclarations de types :Activez declaration lors du développement de bibliothèques
Autres extensions