Как автоматизировать ваши JSON-переводы react-i18next с помощью Intlayer

Что такое Intlayer?

Intlayer — это инновационная, с открытым исходным кодом библиотека интернационализации, разработанная для устранения недостатков традиционных решений i18n. Она предлагает современный подход к управлению контентом в React-приложениях.

Смотрите конкретное сравнение с react-i18next в нашем блоге react-i18next vs. react-intl vs. Intlayer.

Почему стоит сочетать Intlayer с react-i18next?

Хотя Intlayer предоставляет отличное самостоятельное решение для i18n (см. наше руководство по интеграции с React), вы можете захотеть сочетать его с react-i18next по нескольким причинам:

1. Существующая кодовая база: У вас уже есть реализованная система react-i18next, и вы хотите постепенно перейти на улучшенный опыт разработчика с Intlayer.
2. Требования наследия: Ваш проект требует совместимости с существующими плагинами или рабочими процессами react-i18next.
3. Знакомство команды: Ваша команда привыкла к react-i18next, но хочет улучшить управление контентом.
4. Использование возможностей Intlayer: Вы хотите использовать функции Intlayer, такие как декларация контента, автоматизация переводов, тестирование переводов и многое другое.

Для этого Intlayer может быть реализован как адаптер для react-i18next, чтобы помочь автоматизировать ваши JSON-переводы в CLI или CI/CD пайплайнах, тестировать переводы и многое другое.

Это руководство показывает, как использовать превосходную систему декларации контента Intlayer, сохраняя при этом совместимость с react-i18next.

Содержание

Пошаговое руководство по настройке Intlayer с react-i18next

Шаг 1: Установка зависимостей

Установите необходимые пакеты:

npm install intlayer @intlayer/sync-json-plugin

Описание пакетов:

• intlayer: Основная библиотека для управления интернационализацией, декларации контента и сборки
• @intlayer/sync-json-plugin: Плагин для экспорта деклараций контента Intlayer в JSON-формат, совместимый с react-i18next

Шаг 2: Реализация плагина Intlayer для обёртки JSON

Создайте файл конфигурации Intlayer для определения поддерживаемых локалей:

Если вы также хотите экспортировать JSON-словари для react-i18next, добавьте плагин 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;

Плагин syncJSON автоматически обернет JSON. Он будет читать и записывать JSON-файлы без изменения архитектуры содержимого.

Если вы хотите, чтобы JSON сосуществовал с файлами деклараций контента Intlayer (.content файлы), Intlayer будет работать следующим образом:

1. загрузит как JSON, так и файлы деклараций контента и преобразует их в словарь Intlayer.2. если возникнут конфликты между JSON и файлами деклараций контента, Intlayer выполнит слияние всех словарей. В зависимости от приоритета плагинов и файлов деклараций контента (все настраивается).

Если изменения вносятся с помощью CLI для перевода JSON или с использованием CMS, Intlayer обновит JSON-файл с новыми переводами.

Чтобы узнать больше подробностей о плагине syncJSON, пожалуйста, обратитесь к документации плагина syncJSON.

(Необязательно) Шаг 3: Реализация перевода JSON по компонентам

По умолчанию Intlayer загружает, объединяет и синхронизирует как JSON, так и файлы деклараций контента. Подробнее смотрите в документации по декларации контента. Но если вы предпочитаете, используя плагин Intlayer, вы также можете реализовать управление локализованным JSON по компонентам в любом месте вашей кодовой базы.

Для этого вы можете использовать плагин 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,  },  // Синхронизируйте ваши текущие JSON-файлы с словарями Intlayer  plugins: [    /**     * Загрузит все JSON-файлы в папке src, соответствующие шаблону {key}.i18n.json     */    loadJSON({      source: ({ key }) => `./src/**/${key}.i18n.json`,      locale: Locales.ENGLISH,      priority: 1, // Обеспечивает приоритет этих JSON-файлов над файлами в `./locales/en/${key}.json`    }),    /**     * Загрузит и запишет результат и переводы обратно в JSON-файлы в директории locales     */    syncJSON({      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,      priority: 0,    }),  ],};export default config;

Это загрузит все JSON-файлы в каталоге src, которые соответствуют шаблону {key}.i18n.json, и загрузит их как словари Intlayer.

Конфигурация Git

Рекомендуется игнорировать автоматически сгенерированные файлы Intlayer:

# Игнорировать файлы, сгенерированные Intlayer.intlayer

Эти файлы могут быть восстановлены во время процесса сборки и не требуют добавления в систему контроля версий.

Расширение VS Code

Для улучшения опыта разработчика установите официальное расширение Intlayer для VS Code:

Установить из VS Code Marketplace