Documentation du plugin Vite intlayer

Le plugin Vite intlayer intègre la configuration Intlayer dans le processus de build. Il gère les alias des dictionnaires, lance le watcher des dictionnaires en mode développement, et prépare les dictionnaires pour le build.

Utilisation

// vite.config.tsimport { defineConfig } from "vite";import { intlayer } from "vite-intlayer";export default defineConfig({  plugins: [intlayer()],});

Options

import type { IntlayerPluginOptions } from "vite-intlayer";

IntlayerPluginOptions extends GetConfigurationOptions (voir @intlayer/config) avec les champs supplémentaires suivants :

Toutes les autres options (override, configFile, …) sont transmises directement à getConfiguration().

Exemples

Ignorer les routes API du routage des locales

// vite.config.tsimport { defineConfig } from "vite";import { intlayer } from "vite-intlayer";export default defineConfig({  plugins: [    intlayer({      proxy: {        ignore: (req) => req.url?.startsWith("/api"),      },    }),  ],});

Avec un chemin de fichier de configuration personnalisé

export default defineConfig({  plugins: [    intlayer({      configFile: "./config/intlayer.config.ts",    }),  ],});

Avec les callers compat-adapter

import { intlayer } from "vite-intlayer";import { reactI18nextCallerConfig } from "@intlayer/react-i18next/plugin";export default defineConfig({  plugins: [    intlayer({      compatCallers: [reactI18nextCallerConfig],    }),  ],});

Ce que fait le plugin

1. Préparation du dictionnaire

Avant le démarrage de la construction (et une fois par heure en dev), intlayer appelle prepareIntlayer pour compiler tous les fichiers .content.ts en dictionnaires JSON optimisés stockés dans .intlayer/.

2. Alias de modules

Le plugin ajoute des alias de résolution Vite afin que import { myDict } from 'intlayer/dictionaries/my-dict' soit résolu vers le fichier JSON compilé sur le disque. Les builds SSR utilisent ssr.noExternal pour s'assurer que tous les packages @intlayer/* sont regroupés avec les alias appliqués.

3. Dev-server watcher

En mode développement, un watcher chokidar est démarré. Quand un fichier .content.ts change, les dictionnaires sont recompilés et le HMR de Vite propage la mise à jour au navigateur.

4. Proxy de routage des locales intégré (v9+)

Depuis Intlayer v9, le middleware intlayerProxy est enregistré automatiquement à l'intérieur de intlayer(). Il gère :

• La détection de la locale à partir du préfixe d'URL, des cookies et de l'en-tête Accept-Language.
• Les redirections 301 lorsque la locale détectée ne correspond pas à l'URL actuelle.
• Les réécritures d'URL internes afin que le framework voie le bon paramètre de route [locale].

Le proxy est contrôlé par routing.enableProxy (par défaut true) dans votre configuration Intlayer. Pour le désactiver complètement :

// intlayer.config.tsimport { defineConfig } from "intlayer";export default defineConfig({  routing: { enableProxy: false },});

Pour personnaliser le comportement du proxy sans appel intlayerProxy() séparé, transmettez les options proxy au plugin principal :

intlayer({ proxy: { ignore: (req) => req.url?.startsWith("/api") } });

Consultez la documentation intlayerProxy pour la référence complète du comportement du routage.

5. Compilateur fourni (v9+)

Quand compiler.enabled est true et compiler.output est défini dans votre config Intlayer, intlayer() enregistre intlayerCompiler automatiquement. Le compilateur extrait les déclarations de contenu inline écrites directement dans les fichiers de composants et les écrit dans les dictionnaires au moment de la transformation. Voir la documentation intlayerCompiler.

6. Optimisations de build

Pendant un build de production, le plugin ajoute :

• intlayerOptimize – transformation Babel qui réécrit useIntlayer('key') → useDictionary(hash) et injecte les imports JSON directs.
• intlayerPrune – supprime les champs de contenu inutilisés du JSON du dictionnaire.
• intlayerMinify – compacte le JSON du dictionnaire et optionnellement modifie les noms de champs.

Ces derniers sont inactifs en mode développement.

Aliases dépréciés