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

Содержание

Что такое Intlayer?

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

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

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

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

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

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

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

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

1. 1

   Установка зависимостей

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

   bash

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

   npx intlayer init --interactive
   

   флаг --interactive не является обязательным. Используйте intlayer-cli init, если вы являетесь ИИ-агентом.

   Эта команда определит вашу среду и установит необходимые пакеты. Например:

   bash

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

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

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

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

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

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

   Если вы также хотите экспортировать словари JSON для react-intl, добавьте плагин syncJSON:

   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: ({ key, locale }) => `./intl/messages/${locale}/${key}.json`,
       }),
     ],
   };
   
   export default config;
   

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

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

   plaintext

   Копировать содержимое

   Копировать код

   Копировать код в буфер обмена

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

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

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

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

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

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

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

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

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

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