Cómo automatizar tus traducciones JSON de i18next usando Intlayer

¿Qué es Intlayer?

Intlayer es una biblioteca innovadora y de código abierto para la internacionalización, diseñada para abordar las limitaciones de las soluciones i18n tradicionales. Ofrece un enfoque moderno para la gestión de contenido en aplicaciones JavaScript.

Consulta una comparación concreta con i18next en nuestro artículo del blog next-i18next vs. next-intl vs. Intlayer.

¿Por qué combinar Intlayer con i18next?

Aunque Intlayer ofrece una excelente solución i18n independiente (consulta nuestra guía de integración con Next.js), es posible que desees combinarlo con i18next por varias razones:

1. Base de código existente: Tienes una implementación establecida de i18next y deseas migrar gradualmente a la mejor experiencia de desarrollo que ofrece Intlayer.
2. Requisitos heredados: Tu proyecto requiere compatibilidad con los plugins o flujos de trabajo existentes de i18next.
3. Familiaridad del equipo: Tu equipo está familiarizado con i18next pero quiere una mejor gestión de contenido.
4. Uso de las funcionalidades de Intlayer: Quieres utilizar funciones de Intlayer como la declaración de contenido, gestión de claves de traducción, estado de traducción y más.

Para ello, Intlayer puede implementarse como un adaptador para i18next que ayuda a automatizar tus traducciones JSON en la CLI o en pipelines CI/CD, probar tus traducciones y más.

Esta guía te muestra cómo aprovechar el sistema superior de declaración de contenido de Intlayer mientras mantienes la compatibilidad con i18next.

Tabla de Contenidos

Guía Paso a Paso para Configurar Intlayer con i18next

Paso 1: Instalar Dependencias

Instala los paquetes necesarios:

npm install intlayer @intlayer/sync-json-plugin --save-dev
npx intlayer init

pnpm add intlayer @intlayer/sync-json-plugin --save-dev
pnpm intlayer init

yarn add intlayer @intlayer/sync-json-plugin --dev
yarn intlayer init

bun add intlayer @intlayer/sync-json-plugin --dev
bun x intlayer init

Descripción de los paquetes:

• intlayer: Biblioteca principal para la gestión de internacionalización, declaración de contenido y construcción
• @intlayer/sync-json-plugin: Plugin para exportar las declaraciones de contenido de Intlayer a un formato JSON compatible con i18next

Paso 2: Implementar el plugin de Intlayer para envolver el JSON

Crea un archivo de configuración de Intlayer para definir los locales soportados:

Si también quieres exportar diccionarios JSON para i18next, añade el plugin syncJSON:

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({
      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,
    }),
  ],
};

export default config;

El plugin syncJSON envolverá automáticamente el JSON. Leerá y escribirá los archivos JSON sin cambiar la arquitectura del contenido.

Si quieres hacer coexistir ese JSON con los archivos de declaración de contenido de Intlayer (archivos .content), Intlayer procederá de la siguiente manera:

1. cargará tanto los archivos JSON como los archivos de declaración de contenido y los transformará en un diccionario de Intlayer.
2. si hay conflictos entre el JSON y los archivos de declaración de contenido, Intlayer procederá a fusionar todos esos diccionarios. Dependiendo de la prioridad de los plugins y de la del archivo de declaración de contenido (todos son configurables).

Si se realizan cambios usando la CLI para traducir el JSON, o usando el CMS, Intlayer actualizará el archivo JSON con las nuevas traducciones.

Para ver más detalles sobre el plugin syncJSON, por favor consulta la documentación del plugin syncJSON.

Configuración de Git

Se recomienda ignorar los archivos generados automáticamente por Intlayer:

# Ignorar archivos generados por Intlayer
.intlayer

Estos archivos pueden regenerarse durante tu proceso de compilación y no necesitan ser comprometidos en el control de versiones.

Extensión de VS Code

Para mejorar la experiencia del desarrollador, instala la extensión oficial Intlayer VS Code Extension:

Instalar desde el Marketplace de VS Code