Configurer Astro

Personnalisez le fonctionnement d’Astro en ajoutant un fichier astro.config.mjs dans votre projet. Il s’agit d’un fichier commun aux projets Astro, et tous les modèles et thèmes d’exemple officiels en contiennent un par défaut.

📚 Consultez la référence d’API d’Astro pour une vue d’ensemble des options supportées.

Un fichier de configuration Astro valide exporte sa configuration en utilisant l’exportation default, et en utilisant l’aide recommandée defineConfig :

import { defineConfig } from 'astro/config'

export default defineConfig({
  // vos options de configuration ici...
  // https://docs.astro.build/fr/reference/configuration-reference/
})

Utiliser defineConfig() est recommandé pour obtenir l’aide sur les types utilisés dans votre éditeur de code, mais c’est aussi optionnel. Un fichier de configuration absolument minimal, valide, pourrait ressembler à ça :

// Exemple : Fichier de configuration minimal, vide
export default {}

Astro supporte plusieurs formats de fichiers pour son fichier de configuration JavaScript : astro.config.js, astro.config.mjs, astro.config.cjs et astro.config.ts.

Le chargement du fichier de configuration TypeScript est géré par tsm et respecte les options tsconfig de votre projet.

Astro essaiera automatiquement de résoudre un fichier de configuration nommé astro.config.mjs à la racine du projet. Si aucun fichier de configuration n’est trouvé à cet endroit, les options par défaut d’Astro seront utilisées.

# Exemple : Lit votre configuration à partir de ./astro.config.mjs
astro build

Vous pouvez explicitement définir un fichier de configuration à utiliser avec l’option --config du CLI. Cette option est toujours relative au répertoire de travail actuel dans lequel vous avez exécuté la commande astro.

# Exemple : Lit votre configuration à partir de ce fichier
astro build --config my-config-file.js

Astro recommande d’utiliser l’aide defineConfig() dans votre fichier de configuration. defineConfig() fournit une autocomplétion automatique dans votre IDE. Les éditeurs comme VS Code sont capables de lire les définitions TypeScript d’Astro et de fournir des indications de type JSDoc automatiques, même si votre fichier de configuration n’est pas écrit en TypeScript.

import { defineConfig } from 'astro/config'

export default defineConfig({
  // vos options de configuration ici...
  // https://docs.astro.build/fr/reference/configuration-reference/
})

Vous pouvez également fournir des définitions de type manuellement à VS Code, en utilisant cette notation JSDoc :

 export default /** @type {import('astro').AstroUserConfig} */ ({
  // vos options de configuration ici...
  // https://docs.astro.build/fr/reference/configuration-reference/
}

Si vous indiquez un chemin relatif à root ou à l’option --root, Astro va résoudre ce chemin par rapport au répertoire de travail actuel où vous avez exécuté la commande astro.

export default defineConfig({
    // Cherches vers le répertoire "./foo" dans le répertoire de travail actuel
    root: 'foo'
})

Astro va chercher toutes les autres chaînes de caractères de fichiers et de répertoires par rapport à la racine du projet :

export default defineConfig({
    // Se dirige vers le répertoire "./foo" dans le répertoire de travail actuel
    root: 'foo',
    // Se dirige vers le répertoire "./foo/public" dans le répertoire de travail actuel
    publicDir: 'public',
})

Pour référencer un fichier ou un répertoire relatif au fichier de configuration, utilisez import.meta.url (sauf si vous écrivez un fichier commonJS astro.config.cjs).

export default defineConfig({
    // Se dirige vers le répertoire "./foo", relatif à ce fichier de configuration
    root: new URL("./foo", import.meta.url),
    // Se dirige vers le répertoire "./public", relatif à ce fichier de configuration
    publicDir: new URL("./public", import.meta.url),
})

📚 Lis la référence d’API de configuration d’Astro pour une vue d’ensemble des options de configuration supportées.