"sourceMap"
Génère des source maps .js.map, grâce auxquelles le débogueur affiche votre code TypeScript au lieu du JavaScript généré.
Exemple
#{
"compilerOptions": {
"strict": true,
"target": "ES2022",
"module": "ESNext",
"sourceMap": true,
"outDir": "./dist"
},
"include": ["src"]
}Définition et utilisation
#Avec sourceMap: true, le compilateur écrit un fichier .js.map à côté de chaque fichier .js. C’est une carte qui relie les endroits du JavaScript généré aux lignes et colonnes du fichier .ts d’origine.
Les outils de développement du navigateur et le débogueur de l’éditeur s’en servent pour afficher votre code TypeScript : vous posez les points d’arrêt dans le fichier .ts, et les traces de pile indiquent les bonnes lignes. À la fin du fichier .js apparaît un commentaire //# sourceMappingURL=…, grâce auquel les outils retrouvent la carte.
Node.js utilisera les cartes dans les traces de pile lorsqu’il est lancé avec le drapeau --enable-source-maps. L’option inlineSourceMap colle la carte directement dans le fichier .js, sans fichier séparé. Dans les applications avec bundler, les source maps se configurent en général dans le bundler lui-même.
Syntaxe
#"sourceMap": truePlus d’exemples
#export interface Course {
title: string
}
export function findCourse(courses: Course[], title: string): Course {
const course = courses.find((c) => c.title === title)
if (!course) throw new Error(`Cours introuvable : ${title}`)
return course
}
findCourse([{ title: 'HTML' }], 'Rust')npx tsc
ls dist
# app.js app.js.map
node dist/app.js
# Error: Cours introuvable : Rust
# at findCourse (file:///projet/dist/app.js:4:15)
node --enable-source-maps dist/app.js
# Error: Cours introuvable : Rust
# at findCourse (/projet/src/app.ts:7:22)Bonnes pratiques
#- Les source maps en production facilitent l’analyse des erreurs, mais elles exposent le code source. De nombreuses équipes ne les envoient qu’à un outil de suivi des erreurs, au lieu de les publier avec le site.
- Lorsque vous déplacez les fichiers compilés, déplacez aussi les fichiers
.js.map. Le commentairesourceMappingURLdésigne la carte par un chemin relatif. - Dans les bibliothèques, ajoutez aussi
declarationMap, afin que « Aller à la définition » dans l’éditeur mène à la source.tset non au fichier.d.ts.
Entrées associées
#- "outDir" et "rootDir"Le dossier où va le code compilé et le dossier des sources.
- "declaration"Génère des fichiers .d.ts avec les types à côté du JavaScript compilé.
- "target"La version de JavaScript vers laquelle le compilateur transforme votre code.
- "module"Le format de modules du code généré et la manière de comprendre les imports.
Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.