"paths"

Des alias de chemins dans les imports, par exemple @/components au lieu de ../../components.

Sur cette page

Exemple

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

Définition et utilisation

#

L’option paths permet de dĂ©finir des raccourcis pour les chemins d’import. Au lieu de ../../../components/Button, vous Ă©crivez @/components/Button, quelle que soit la profondeur du fichier courant.

Les motifs contiennent un astĂ©risque qui remplace le reste du chemin : "@/*": ["./src/*"]. Depuis TypeScript 4.1, l’option baseUrl n’est plus nĂ©cessaire pour cela, et les chemins sont calculĂ©s par rapport au fichier tsconfig.json.

Important : paths n’affecte que la vĂ©rification des types. L’outil qui exĂ©cute ou construit le code (Next.js, Vite, un bundler, ts-node) doit connaĂźtre les mĂȘmes alias. Les frameworks les lisent en gĂ©nĂ©ral automatiquement depuis tsconfig.

Syntaxe

#
Syntaxe
"paths": {
  "@/*": ["./src/*"]
}

Plus d’exemples

#
Un import avec alias
TypeScript
import Button from '@/components/Button'
import { formatPrice } from '@/utils/format'

Bonnes pratiques

#
  • Un seul alias @/* pointant vers src suffit gĂ©nĂ©ralement. Trop d’alias rendent le projet plus difficile Ă  parcourir.
  • Lorsqu’un alias fonctionne dans l’éditeur mais pas dans l’application en cours d’exĂ©cution, configurez-le aussi dans le bundler.

Entrées associées

#

Pratiquer dans les leçons

#

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