Documentation de Configuration Intlayer

import { Locales, type IntlayerConfig } from "intlayer";import { nextjsRewrite } from "intlayer/routing";import { z } from "zod";/** * Exemple de fichier de configuration Intlayer affichant toutes les options disponibles. */const config: IntlayerConfig = {  /**   * Configuration pour les paramètres d'internationalisation.   */  internationalization: {    /**     * Liste des locales supportées dans l'application.     * Par défaut : [Locales.ENGLISH]     */    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    /**     * Liste des locales obligatoires qui doivent être définies dans chaque dictionnaire.     * Si vide, toutes les locales sont obligatoires en mode `strict`.     * Par défaut : []     */    requiredLocales: [Locales.ENGLISH],    /**     * Niveau de stricte conformité pour le contenu internationalisé.     * - "strict": Erreur si une locale déclarée est manquante ou non déclarée.     * - "inclusive": Avertissement si une locale déclarée est manquante.     * - "loose": Accepte n'importe quelle locale existante.     * Par défaut : "inclusive"     */    strictMode: "inclusive",    /**     * Locale par défaut utilisée comme solution de secours si la locale demandée n'est pas trouvée.     * Par défaut : Locales.ENGLISH     */    defaultLocale: Locales.ENGLISH,  },  /**   * Paramètres contrôlant les opérations de dictionnaire et le comportement de repli.   */  dictionary: {    /**     * Contrôle la manière dont les dictionnaires sont importés.     * - "static": Importé statiquement au moment du build.     * - "dynamic": Importé dynamiquement en utilisant Suspense.     * - "fetch": Récupéré dynamiquement via l'API live sync.     * Par défaut : "static"     */    importMode: "static",    /**     * Stratégie pour remplir automatiquement les traductions manquantes à l'aide de l'IA.     * Peut être une valeur booléenne ou un motif de chemin pour enregistrer le contenu rempli.     * Par défaut : true     */    fill: true,    /**     * Emplacement physique des fichiers de dictionnaire.     * - "local": Stocké dans le système de fichiers local.     * - "remote": Stocké dans l'Intlayer CMS.     * - "hybrid": Stocké à la fois localement et dans l'Intlayer CMS.     * - "plugin" (ou toute chaîne personnalisée) : Fourni par un plugin ou une source personnalisée.     * Par défaut : "local"     */    location: "local",    /**     * Indique si le contenu doit être automatiquement transformé (ex: Markdown en HTML).     * Par défaut : false     */    contentAutoTransformation: false,  },  /**   * Configuration du routage et du middleware.   */  routing: {    /**     * Stratégie de routage des locales.     * - "prefix-no-default": Préfixe tout sauf la locale par défaut (ex: /dashboard, /fr/dashboard).     * - "prefix-all": Préfixe toutes les locales (ex: /en/dashboard, /fr/dashboard).     * - "no-prefix": Pas de locale dans l'URL.     * - "search-params": Utilise ?locale=...     * Par défaut : "prefix-no-default"     */    mode: "prefix-no-default",    /**     * Où stocker la locale sélectionnée par l'utilisateur.     * Options : 'cookie', 'localStorage', 'sessionStorage', 'header', ou un tableau de ceux-ci.     * Par défaut : ['cookie', 'header']     */    storage: ["cookie", "header"],    /**     * Chemin de base pour les URL de l'application.     * Par défaut : ""     */    basePath: "",    /**     * Règles de réécriture d'URL personnalisées pour des chemins spécifiques par locale.     */    rewrite: nextjsRewrite({      "/[locale]/about": {        en: "/[locale]/about",        fr: "/[locale]/a-propos",      },    }),    /**     * Mappe les locales aux noms d'hôte de domaine pour le routage basé sur le domaine.     * Les URL pour ces locales seront absolues (ex: https://intlayer.cn/).     * Le domaine implique la locale, donc aucun préfixe de locale n'est ajouté au chemin.     * Par défaut : undefined     */    domains: {      en: "intlayer.org",      zh: "intlayer.cn",    },  },  /**   * Paramètres relatifs à la recherche et au traitement des fichiers de contenu.   */  content: {    /**     * Extensions de fichiers pour le scan des dictionnaires.     * Par défaut : ['.content.ts', '.content.js', '.content.json', etc.]     */    fileExtensions: [".content.ts", ".content.js", ".content.json"],    /**     * Répertoires où se trouvent les fichiers .content.     * Par défaut : ["."]     */    contentDir: ["src"],    /**     * Où se trouve le code source.     * Utilisé pour l'optimisation du build et la transformation de code.     * Par défaut : ["."]     */    codeDir: ["src"],    /**     * Motifs exclus du scan.     * Par défaut : ['node_modules', '.intlayer', etc.]     */    excludedPath: ["node_modules"],    /**     * Indique s'il faut surveiller les modifications et reconstruire les dictionnaires pendant le développement.     * Par défaut : true en développement     */    watch: true,    /**     * Commande utilisée pour formater les fichiers .content nouvellement créés / mis à jour.     */    formatCommand: 'npx prettier --write "{{file}}"',  },  /**   * Configuration de l'Éditeur Visuel (Visual Editor).   */  editor: {    /**     * Indique si l'éditeur visuel est activé.     * Par défaut : false     */    enabled: true,    /**     * L'URL de votre application pour la validation de l'origine.     * Par défaut : ""     */    applicationURL: "http://localhost:3000",    /**     * Port pour le serveur local de l'éditeur.     * Par défaut : 8000     */    port: 8000,    /**     * URL publique de l'éditeur.     * Par défaut : "http://localhost:8000"     */    editorURL: "http://localhost:8000",    /**     * URL de l'Intlayer CMS.     * Par défaut : "https://app.intlayer.org"     */    cmsURL: "https://app.intlayer.org",    /**     * URL de l'API Backend.     * Par défaut : "https://back.intlayer.org"     */    backendURL: "https://back.intlayer.org",    /**     * Indique s'il faut activer la synchronisation du contenu en temps réel.     * Par défaut : false     */    liveSync: true,  },  /**   * Paramètres de traduction et de construction basés sur l'IA.   */  ai: {    /**     * Fournisseur d'IA à utiliser.     * Options : 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio'     * Par défaut : 'openai'     */    provider: "openai",    /**     * Modèle du fournisseur sélectionné à utiliser.     */    model: "gpt-4o",    /**     * Clé API du fournisseur.     */    apiKey: process.env.OPENAI_API_KEY,    /**     * Contexte global pour guider l'IA dans la génération des traductions.     */    applicationContext: "Ceci est une application de réservation de voyages.",    /**     * URL de base pour l'API AI.     */    baseURL: "http://localhost:3000",    /**     * Sérialisation des données (Data Serialization)     *     * Options :     * - "json" : Par défaut, robuste ; consomme plus de tokens.     * - "toon" : Consomme moins de tokens, peut ne pas être aussi cohérent que le JSON.     *     * Par défaut : "json"     */    dataSerialization: "json",  },  /**   * Paramètres de build et d'optimisation.   */  build: {    /**     * Mode d'exécution du build.     * - "auto": Construit automatiquement pendant le build de l'application.     * - "manual": Nécessite une commande de build explicite.     * Par défaut : "auto"     */    mode: "auto",    /**     * Indique s'il faut optimiser le bundle final en supprimant les dictionnaires inutilisés.     * Par défaut : true en production     */    optimize: true,    /**     * Minifier les dictionnaires pour réduire la taille du bundle.     * Par défaut : true     *     * Note :     * - Cette option sera ignorée si `optimize` est désactivé.     * - Cette option sera ignorée si `editor.enabled` est vrai.     */    minify: true,    /**     * Purger les clés inutilisées dans les dictionnaires.     * Par défaut : true     *     * Note :     * - Cette option sera ignorée si `optimize` est désactivé.     */    purge: true,    /**     * Format de sortie pour les fichiers de dictionnaire générés.     * Par défaut : ['cjs', 'esm']     */    outputFormat: ["cjs", "esm"],    /**     * Indique si le build doit vérifier les types TypeScript.     * Par défaut : false     */    checkTypes: false,  },  /**   * Configuration du Logger.   */  log: {    /**     * Niveau de log.     * - "default": Logging standard.     * - "verbose": Logging de débogage approfondi.     * - "disabled": Désactive le logging.     * Par défaut : "default"     */    mode: "default",    /**     * Préfixe pour tous les messages de log.     * Par défaut : "[intlayer]"     */    prefix: "[intlayer]",  },  /**   * Configuration Système (Pour usage avancé)   */  system: {    /**     * Répertoire pour stocker les dictionnaires localisés.     */    dictionariesDir: ".intlayer/dictionary",    /**     * Répertoire pour l'augmentation de modules TypeScript.     */    moduleAugmentationDir: ".intlayer/types",    /**     * Répertoire pour stocker les dictionnaires non fusionnés.     */    unmergedDictionariesDir: ".intlayer/unmerged_dictionary",    /**     * Répertoire pour stocker les types de dictionnaires.     */    typesDir: ".intlayer/types",    /**     * Répertoire où sont stockés les fichiers principaux de l'application.     */    mainDir: ".intlayer/main",    /**     * Répertoire où sont stockés les fichiers de configuration.     */    configDir: ".intlayer/config",    /**     * Répertoire où sont stockés les fichiers de cache.     */    cacheDir: ".intlayer/cache",  },  /**   * Configuration du Compilateur (Pour usage avancé)   */  compiler: {    /**     * Indique si le compilateur (compiler) doit être activé.     *     * - false: Désactive le compilateur.     * - true: Active le compilateur.     * - "build-only": Ignore le compilateur pendant le développement et accélère le temps de démarrage.     *     * Par défaut : false     */    enabled: true,    /**     * Définit le chemin pour les fichiers de sortie. Remplace `outputDir`.     *     * - Les chemins `./` sont résolus par rapport au répertoire du composant.     * - Les chemins `/` sont résolus par rapport à la racine du projet (`baseDir`).     *     * - L'inclusion de la variable `{{locale}}` dans le chemin déclenchera la création de dictionnaires séparés par langue.     *     * Exemple :     * ```ts     * {     *   // Créer des fichiers .content.ts multilingues à côté du composant     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,     *     *   // output: './{{fileName}}{{extension}}', // Équivalent en utilisant une chaîne de caractères     * }     * ```     *     * ```ts     * {     *   // Créer des JSON centralisés par langue à la racine du projet     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,     *     *   // output: '/locales/{{locale}}/{{key}}.content.json', // Équivalent en utilisant une chaîne de caractères     * }     * ```     *     * Liste des variables :     *   - `fileName`: Nom du fichier.     *   - `key`: Clé du contenu.     *   - `locale`: Locale du contenu.     *   - `extension`: Extension du fichier.     *   - `componentFileName`: Nom du fichier du composant.     *   - `componentExtension`: Extension du fichier du composant.     *   - `format`: Format du dictionnaire.     *   - `componentFormat`: Format du dictionnaire du composant.     *   - `componentDirPath`: Chemin du répertoire du composant.     */    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,    /**     * Indique si les composants doivent être enregistrés après avoir été transformés.     *     * - Si `true`, le compilateur réécrira le fichier du composant sur le disque. Ainsi, la transformation sera permanente et le compilateur sautera la transformation pour le prochain processus. De cette façon, le compilateur peut transformer l'application, puis être supprimé.     *     * - Si `false`, le compilateur injectera l'appel de fonction `useIntlayer()` dans le code du build uniquement et gardera la base de code intacte. La transformation sera effectuée uniquement en mémoire.     */    saveComponents: false,    /**     * Insère uniquement le contenu dans le fichier généré. Utile pour une sortie JSON par langue pour i18next ou ICU MessageFormat.     */    noMetadata: false,    /**     * Préfixe de clé de dictionnaire     */    dictionaryKeyPrefix: "", // Ajoutez un préfixe optionnel aux clés de dictionnaire extraites  },  /**   * Schémas personnalisés pour valider le contenu du dictionnaire.   */  schemas: {    "my-schema": z.object({      title: z.string(),    }),  },  /**   * Configuration des plugins.   */  plugins: [],};export default config;

routing: {  mode: "prefix-no-default", // Stratégie de repli  rewrite: nextjsRewrite({    "/about": {      en: "/about",      fr: "/a-propos",    },    "/product/[slug]": {      en: "/product/[slug]",      fr: "/produit/[slug]",    },    "/blog/[category]/[id]": {      en: "/blog/[category]/[id]",      fr: "/journal/[category]/[id]",    },  }),}

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: [      {        type: "localStorage",        name: "user-locale",      },      {        type: "cookie",        name: "user-locale",        secure: true,        sameSite: "strict",        httpOnly: false,      },    ],    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "search-params",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "no-prefix",    storage: {      type: "sessionStorage",      name: "app-locale",    },    basePath: "/my-app",  },};export default config;

// intlayer.config.tsimport { nextjsRewrite } from "intlayer/routing";const config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default", // Repli pour les chemins non réécrits    storage: "cookie",    rewrite: nextjsRewrite({      "/about": {        en: "/about",        fr: "/a-propos",      },      "/product/[slug]": {        en: "/product/[slug]",        fr: "/produit/[slug]",      },      "/blog/[category]/[id]": {        en: "/blog/[category]/[id]",        fr: "/journal/[category]/[id]",      },    }),  },};export default config;

dictionary: {  fill: {    en: "/locales/en/{{key}}.content.json",    fr: ({ key }) => `/locales/fr/${key}.content.json`,    es: false,  },};