"outDir" et "rootDir"

Le dossier où va le code compilé et le dossier des sources.

Sur cette page

Exemple

#
JSON
{
  "compilerOptions": {
    "rootDir": "./src",
    "outDir": "./dist",
    "declaration": true
  },
  "include": ["src"]
}

Définition et utilisation

#

L’option outDir désigne le dossier des fichiers JavaScript générés (et éventuellement des fichiers .d.ts). Sans elle, le compilateur écrit le résultat à côté des fichiers sources, ce qui met vite du désordre dans le projet.

rootDir définit le dossier de base des sources. La structure des dossiers à l’intérieur de rootDir est reproduite dans outDir : le fichier src/utils/format.ts se retrouve dans dist/utils/format.js.

Dans les projets avec un bundler ou un framework (Next.js, Vite), la compilation est assurée par l’outil de build, et tsconfig contient souvent noEmit: true. outDir n’a alors aucune importance.

Syntaxe

#
Syntaxe
"rootDir": "./src",
"outDir": "./dist"

Bonnes pratiques

#
  • Ajoutez le dossier dist à .gitignore. Le code généré ne doit pas aller dans le dépôt.
  • L’option declaration: true génère des fichiers .d.ts avec les types, nécessaires pour publier des bibliothèques.

Entrées associées

#

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.