Configuration de tsconfig.json TypeScript

tsconfig.json est le fichier de configuration des projets TypeScript, utilisé pour spécifier les options du compilateur et les paramètres du projet.


Configuration de base

Le fichier tsconfig.json le plus basique.

Exemple

{
    "compilerOptions": {
        "target": "ES2020",
        "module": "commonjs",
        "strict": true,
        "outDir": "./dist"
    },
    "include": ["src/**/*"],
    "exclude": ["node_modules", "dist"]
}

Description de la configuration :

  • target :Version JavaScript cible vers laquelle compiler
  • module :Système de modules à utiliser
  • strict :Activer toutes les vérifications de type strictes
  • outDir :Répertoire de sortie

Version cible de compilation

Utilisez "target" pour spécifier la version JavaScript vers laquelle compiler.

Exemple

// tsconfig.json
{
    "compilerOptions": {
        // ES3, ES5, ES6/ES2015, ES2020, ESNext
        "target": "ES2020"
    }
}

Différences de sortie pour différentes cibles :

// target: ES5 - 使用 var
var greeting = "Hello";

// target: ES2020 - 使用 let/const
let greeting = "Hello";

Système de modules

Configurer le schéma de modularisation.

Exemple

{
    "compilerOptions": {
        "module": "commonjs",
        // Options : none, commonjs, amd, umd, es6, es2020, esnext
    }
}

Mode strict

L'option strict active toutes les vérifications de type strictes.

Exemple

{
    "compilerOptions": {
        "strict": true,
        // Équivalent à l'activation de toutes les options suivantes :
        // "strictNullChecks": true,
        // "noImplicitAny": true,
        // "strictFunctionTypes": true,
        // etc.
    }
}

Recommandation :Activez toujours strict: true, c'est une bonne pratique.


Alias de chemins

Configurer des alias de chemins pour simplifier les imports.

Exemple

{
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "@/*": ["src/*"],
            "@components/*": ["src/components/*"]
        }
    }
}

Utilisation :

import Button from "@components/Button";
import { Header } from "@/components";

Inclusion et exclusion de fichiers

Contrôler quels fichiers sont inclus dans la compilation.

Exemple

{
    "include": ["src/**/*"],
    "exclude": [
        "node_modules",
        "dist",
        "**/*.test.ts",
        "**/*.spec.ts"
    ]
}

Aperçu des options courantes du compilateur

Option Description
target Version cible de compilation
module Système de modules
strict Mode strict
outDir Répertoire de sortie
rootDir Répertoire racine des sources
esModuleInterop Autoriser l'interopérabilité des modules ES
skipLibCheck Ignorer la vérification de la bibliothèque
declaration Générer des fichiers de déclaration .d.ts

Résumé

  • tsconfig.json:Fichier de configuration du projet TypeScript
  • compilerOptions:Configuration principale des options du compilateur
  • include/exclude:Contrôler la portée des fichiers
  • Alias de chemins :Simplifier les chemins d'importation
  • strict: true:Toujours activer le mode strict
Autres extensions