Migrer de vue-i18n à Intlayer

Pourquoi migrer de vue-i18n à Intlayer ?

Stratégies de migration

Il existe deux stratégies complémentaires pour migrer de vue-i18n à Intlayer :

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

2. Migration complète — Remplacez progressivement les API vue-i18n par des hooks natifs Intlayer (useIntlayer) et colocalisez le contenu dans des fichiers .content.ts avec vos composants.

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 vue-i18n existante sur Intlayer avec zéro changement de code dans vos composants.

1. 1

   Installer les Dépendances

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

   npm install intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
   npx intlayer init

   pnpm add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
   pnpm intlayer init

   yarn add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
   yarn intlayer init

   bun add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
   bun x intlayer init

   Vous pouvez garder vue-i18n 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 :

   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é vue-i18n : {name}
         format: "icu",
         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: 'icu' garantit que les espaces réservés sont analysés correctement pour vue-i18n.

3. 3

   Ajouter le Plugin Intlayer à votre Bundler

   Enveloppez votre configuration de bundler existante avec le plugin de compatibilité. Il compose le plugin Intlayer de base, configure la surveillance du contenu, et — point critique — injecte un alias de module afin que vos appels existants import … from 'vue-i18n' soient redirigés de manière transparente vers @intlayer/vue-i18n lors de la construction. Aucun changement de fichier source n'est nécessaire.

   Pour Vite :

   import { defineConfig } from "vite";
   import vue from "@vitejs/plugin-vue";
   import { vueI18nVitePlugin } from "@intlayer/vue-i18n/plugin";
   
   export default defineConfig({
     plugins: [vue(), vueI18nVitePlugin()],
   });

   vueI18nVitePlugin() enveloppe le plugin intlayer() de vite-intlayer et ajoute l'alias vue-i18n. L'utilisation du simple plugin intlayer() de vite-intlayer compile les dictionnaires mais n'ajoute pas l'alias — vous devrez alors renommer les imports vers @intlayer/vue-i18n manuellement (voir l'étape 4).

   Pour Nuxt :

   Si vous utilisez @nuxtjs/i18n (intégration Nuxt), installez nuxt-intlayer et ajoutez-le à votre nuxt.config.ts :

   npm install nuxt-intlayer

   export default defineNuxtConfig({
     modules: ["nuxt-intlayer"],
     // Vous pouvez supprimer en toute sécurité @nuxtjs/i18n de vos modules
   });

   Vous n'avez plus besoin de createI18n() ou du bootstrap manuel du provider. Intlayer compile tous les dictionnaires au moment de la construction, il n'y a donc pas d'étape de chargement à l'exécution. Le provider aliasé gère l'initialisation pour vous.

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

Clés de traduction typées — automatiques. Une fois qu'Intlayer a compilé vos dictionnaires, useI18n est typé par rapport à votre contenu réel lorsque vous passez une option namespace. Les clés sont autocomplétées dans votre IDE et les chemins invalides provoquent des erreurs TypeScript au moment de la construction — aucune configuration supplémentaire n'est requise.

// 'about' est une clé de dictionnaire enregistrée
const { t } = useI18n({ namespace: "about" });
t("counter.label"); // ✓ autocomplété
t("does.not.exist"); // ✗ Erreur TypeScript

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

   Les plugins Intlayer gèrent déjà l'aliassage au niveau du bundler. Si vous préférez rendre la dépendance explicite dans vos fichiers sources, 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 { useI18n } from 'vue-i18n'	import { useI18n } from '@intlayer/vue-i18n'
   import { createI18n } from 'vue-i18n'	import { createI18n } from '@intlayer/vue-i18n'

   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 :

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

   pnpm intlayer test
   pnpm intlayer fill

   yarn intlayer test
   yarn intlayer fill

   bun x intlayer test
   bun x intlayer fill

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

   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: "icu",
         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 les adaptateurs de compatibilité en place, le code standard vue-i18n 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 MyComponent.vue 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 avec les pages et les composants 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
• Intlayer avec Vue — Guide d'installation complet pour Vue : intlayerwithvite+vue.md
• Intlayer avec Nuxt — Guide d'installation complet pour Nuxt : intlayerwithnuxt.md