Migrer de i18next à Intlayer

Pourquoi migrer de i18next à Intlayer ?

Stratégies de migration

Il existe deux stratégies complémentaires pour migrer de i18next à Intlayer :

1. Adaptateur de compatibilité (recommandé pour les applications existantes) — Installez @intlayer/i18next. Ce package expose exactement la même API que i18next mais délègue tout le travail de traduction à Intlayer en coulisses. Vous conservez vos appels existants à i18next.t(), i18next.changeLanguage(), et createInstance() — le seul changement est le chemin d'importation et l'initialisation.

2. Migration complète — Remplacez progressivement les API i18next par des outils natifs Intlayer et colocalisez le contenu dans des fichiers .content.ts.

Ce guide couvre d'abord la Stratégie 1 (adaptateur de compatibilité prêt à l'emploi), puis passe en revue la migration complète optionnelle.

Table des Matières

Migration rapide

Les étapes suivantes sont le minimum requis pour faire fonctionner votre application i18next existante sur Intlayer avec zéro changement de code.

1. 1

   Installer les Dépendances

   Installez les packages principaux d'Intlayer et l'adaptateur de compatibilité :

   bash

   Copier le contenu

   Copier le code

   Copier le code dans le presse-papiers

   npm install intlayer @intlayer/i18next @intlayer/sync-json-pluginnpx intlayer init

   Vous pouvez garder i18next installé — l'adaptateur de compatibilité l'utilise comme devDependency / peerDependency pour les types TypeScript.

2. 2

   Configurer Intlayer

   La commande intlayer init crée un fichier intlayer.config.ts de démarrage. Mettez-le à jour pour qu'il corresponde à vos paramètres régionaux existants et pointez le plugin syncJSON sur vos fichiers de messages :

   intlayer.config.ts

   Copier le contenu

   Copier le code

   Copier le code dans le presse-papiers

   import { Locales, type IntlayerConfig } from "intlayer";
   import { syncJSON } from "@intlayer/sync-json-plugin";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [
         Locales.ENGLISH,
         Locales.FRENCH,
         Locales.SPANISH,
         // Ajoutez tous vos paramètres régionaux existants ici
       ],
       defaultLocale: Locales.ENGLISH,
     },
     plugins: [
       syncJSON({
         // correspond à la syntaxe d'espace réservé i18next : {{name}}
         format: "i18next",
         source: ({ locale }) => `./src/locales/${locale}.json`,
         location: "src/locales",
       }),
     ],
   };
   
   export default config;

   source mappe un paramètre régional à son chemin de fichier JSON. location indique à l'observateur Intlayer quel dossier surveiller pour les modifications. L'option format: 'i18next' garantit que les espaces réservés comme {{name}} sont analysés correctement.

3. 3

   Mettre à jour les alias du bundle (Optionnel)

   Si vous utilisez un bundle (Vite, Webpack, esbuild), vous pouvez injecter un alias de module afin que import ... from 'i18next' se résolve automatiquement vers @intlayer/i18next. Cela élimine le besoin de modifier manuellement les imports dans votre base de code.

   Pour Vite :

   vite.config.ts

   Copier le contenu

   Copier le code

   Copier le code dans le presse-papiers

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

   i18nextVitePlugin() enveloppe le plugin intlayer() de vite-intlayer et ajoute l'alias i18next → @intlayer/i18next pour vous. L'utilisation du simple plugin intlayer() de vite-intlayer compile les dictionnaires mais n'ajoute pas cet alias — vous devrez alors renommer les imports vers @intlayer/i18next manuellement (voir l'étape suivante).

C'est tout pour la migration rapide. Votre application fonctionne désormais sur Intlayer tout en conservant chaque import et API i18next intacts.

Migration complète

Les étapes ci-dessous sont facultatives et peuvent être effectuées de manière incrémentielle. Elles débloquent l'ensemble des fonctionnalités d'Intlayer : éditeur visuel, CMS, fichiers de contenu typés, traduction alimentée par l'IA, et plus encore.

1. 4

   Renommage explicite des imports (optionnel)

   Facultatif

   Si vous préférez rendre la dépendance explicite dans vos fichiers sources, ou si vous n'utilisez pas de plugin de bundle pour aliasser les imports, vous pouvez renommer les imports manuellement :

   Afficher tout le contenu du tableau

   Afficher tout le contenu du tableau

   Ouvrir le tableau dans une fenêtre modale pour voir tout le contenu clairement

   Avant	Après
   import i18next from 'i18next'	import i18next from '@intlayer/i18next'
   import { createInstance } from 'i18next'	import { createInstance } from '@intlayer/i18next'
   import { t } from 'i18next'	import { t } from '@intlayer/i18next'

   Ce sont des remplacements directs — aucun changement de signatures d'appel, d'arguments ou de types de retour n'est requis.

2. 5

   Activer l'automatisation de la traduction alimentée par l'IA

   Facultatif

   Une fois Intlayer configuré, utilisez sa CLI pour remplir automatiquement les traductions manquantes :

   bash

   Copier le contenu

   Copier le code

   Copier le code dans le presse-papiers

   # Tester les traductions manquantes (ajouter au CI)npx intlayer test# Remplir les traductions manquantes avec l'IAnpx intlayer fill

   Ajoutez la configuration de l'IA à intlayer.config.ts :

   intlayer.config.ts

   Copier le contenu

   Copier le code

   Copier le code dans le presse-papiers

   import { Locales, type IntlayerConfig } from "intlayer";
   import { syncJSON } from "@intlayer/sync-json-plugin";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
       defaultLocale: Locales.ENGLISH,
     },
     plugins: [
       syncJSON({
         format: "i18next",
         source: ({ locale }) => `./src/locales/${locale}.json`,
         location: "src/locales",
       }),
     ],
     ai: {
       apiKey: process.env.OPENAI_API_KEY,
       // provider: "openai",     // défaut
       // model: "gpt-4o-mini",   // défaut
     },
   };
   
   export default config;

   Consultez la documentation de la CLI Intlayer pour toutes les options disponibles.

Ce que vous pouvez supprimer après la migration

Une fois l'adaptateur de compatibilité en place, le code standard i18next suivant peut être supprimé :

Lorsque vous êtes prêt à aller plus loin, Intlayer découvre automatiquement tous les fichiers .content.ts et .content.json n'importe où dans votre base de code (par défaut, n'importe où dans ./src). Vous pouvez placer un fichier my-component.content.ts juste à côté de votre logique et Intlayer le détectera au moment de la construction sans configuration supplémentaire — pas d'imports, pas d'enregistrement, pas besoin de fichier d'index centralisé. Cela rend la colocalisation des traductions complètement transparente.

Configurer TypeScript

Intlayer utilise l'augmentation de module pour fournir une intellisense TypeScript complète pour vos clés de traduction. Assurez-vous que votre tsconfig.json inclut les types générés automatiquement :

{  // ... Vos configurations TypeScript existantes  "include": [    // ... Vos configurations TypeScript existantes    ".intlayer/**/*.ts", // Inclure les types générés automatiquement  ],}

Configuration Git

Ajoutez le répertoire généré par Intlayer à votre .gitignore :

# Ignorer les fichiers générés par Intlayer.intlayer

Aller plus loin

• Éditeur visuel — Gérez les traductions visuellement dans votre navigateur : Éditeur visuel Intlayer
• CMS — Externalisez et gérez le contenu à distance : Intlayer CMS
• Extension VS Code — Obtenez l'autocomplétion et la détection d'erreurs de traduction en temps réel : Extension VS Code Intlayer
• Référence CLI — Liste complète des commandes CLI : Intlayer CLI