Come automatizzare le traduzioni JSON di next-intl usando Intlayer

Cos'è Intlayer?

Intlayer è una libreria di internazionalizzazione innovativa e open-source progettata per superare le limitazioni delle soluzioni i18n tradizionali. Offre un approccio moderno alla gestione dei contenuti nelle applicazioni Next.js.

Vedi un confronto concreto con next-intl nel nostro post sul blog next-i18next vs. next-intl vs. Intlayer.

Perché combinare Intlayer con next-intl?

Sebbene Intlayer offra un'eccellente soluzione i18n autonoma (vedi la nostra guida all'integrazione con Next.js), potresti volerlo combinare con next-intl per diversi motivi:

1. Codice esistente: Hai un'implementazione consolidata di next-intl e vuoi migrare gradualmente verso la migliore esperienza sviluppatore di Intlayer.
2. Requisiti legacy: Il tuo progetto richiede compatibilità con plugin o flussi di lavoro esistenti di next-intl.
3. Familiarità del team: Il tuo team è a suo agio con next-intl ma desidera una migliore gestione dei contenuti.

Per questo, Intlayer può essere implementato come un adattatore per next-intl per aiutare ad automatizzare le tue traduzioni JSON in CLI o pipeline CI/CD, testare le tue traduzioni e altro ancora.

Questa guida ti mostra come sfruttare il sistema superiore di dichiarazione dei contenuti di Intlayer mantenendo la compatibilità con next-intl.

Indice

Guida passo-passo per configurare Intlayer con next-intl

Passo 1: Installa le dipendenze

Installa i pacchetti necessari:

npm install intlayer @intlayer/sync-json-plugin

Descrizione dei pacchetti:

• intlayer: Libreria core per la gestione dell'internazionalizzazione, dichiarazione dei contenuti e build
• @intlayer/sync-json-plugin: Plugin per esportare le dichiarazioni di contenuto di Intlayer in formato JSON compatibile con next-intl

Passo 2: Implementa il plugin Intlayer per avvolgere il JSON

Crea un file di configurazione Intlayer per definire le tue localizzazioni supportate:

Se vuoi anche esportare i dizionari JSON per next-intl, aggiungi il 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 }) => `./messages/${locale}/${key}.json`,    }),  ],};export default config;

Il plugin syncJSON avvolgerà automaticamente il JSON. Leggerà e scriverà i file JSON senza modificare l'architettura del contenuto.

Se vuoi far coesistere quel JSON con i file di dichiarazione dei contenuti di intlayer (file .content), Intlayer procederà in questo modo:

1. caricherà sia i file JSON che i file di dichiarazione dei contenuti e li trasformerà in un dizionario intlayer.2. se ci sono conflitti tra i file JSON e i file di dichiarazione del contenuto, Intlayer procederà alla fusione di tutti quei dizionari. A seconda della priorità dei plugin e di quella del file di dichiarazione del contenuto (tutti configurabili).

Se vengono effettuate modifiche utilizzando la CLI per tradurre il JSON, o utilizzando il CMS, Intlayer aggiornerà il file JSON con le nuove traduzioni.

Per maggiori dettagli sul plugin syncJSON, si prega di consultare la documentazione del plugin syncJSON.

(Opzionale) Passo 3: Implementare traduzioni JSON per componente

Per impostazione predefinita, Intlayer caricherà, fonderà e sincronizzerà sia i file JSON che i file di dichiarazione del contenuto. Consulta la documentazione sulla dichiarazione del contenuto per maggiori dettagli. Ma se preferisci, utilizzando un plugin di Intlayer, puoi anche implementare la gestione per componente dei JSON localizzati ovunque nel tuo codice.

Per questo, puoi utilizzare il plugin loadJSON.

import { Locales, type IntlayerConfig } from "intlayer";import { loadJSON, syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },  // Mantieni i tuoi file JSON attuali sincronizzati con i dizionari Intlayer  plugins: [    /**     * Caricherà tutti i file JSON nella cartella src che corrispondono al pattern {key}.i18n.json     */    loadJSON({      source: ({ key }) => `./src/**/${key}.i18n.json`,      locale: Locales.ENGLISH,      priority: 1, // Garantisce che questi file JSON abbiano la precedenza sui file in `./locales/en/${key}.json`    }),    /**     * Caricherà e scriverà l'output e le traduzioni nei file JSON nella directory delle localizzazioni     */    syncJSON({      source: ({ key, locale }) => `./messages/${locale}/${key}.json`,      priority: 0,    }),  ],};export default config;

Questo caricherà tutti i file JSON nella directory src che corrispondono al pattern {key}.i18n.json e li caricherà come dizionari Intlayer.

Configurazione Git

Si consiglia di ignorare i file Intlayer generati automaticamente:

# Ignora i file generati da Intlayer.intlayer

Questi file possono essere rigenerati durante il processo di build e non è necessario includerli nel controllo di versione.

Estensione VS Code

Per migliorare l'esperienza dello sviluppatore, installa l'Estensione ufficiale Intlayer per VS Code:

Installa dal Marketplace di VS Code