Обзор

В этом руководстве вы узнаете, как автоматически управлять файлами переводов вашего проекта при использовании i18next.

Мы пройдём эти 4 шага:

Шаг 1: Добавьте переменные окружения

Добавьте ключ API для production и ID проекта в переменные окружения. Это необходимо для использования инструмента gtx-cli. Вы получите их в панели управления General Translation.

GT_API_KEY=<ваш-api-ключ>
GT_PROJECT_ID=<ваш-id-проекта>

Шаг 2: Установите gtx-cli

Установите инструмент gtx-cli в свой проект.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Шаг 3: Создайте файл gt.config.json

Создайте файл gt.config.json в корне проекта.

{
  "defaultLocale": "ru",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["messages/[locale]/*.json"]
    },
  },
}

При необходимости настройте файл gt.config.json под свои задачи. Подробнее см. в документации по конфигурации.

Обновите формат файла json, чтобы путь include соответствовал структуре вашего проекта.

Шаг 4: Добавьте команду gtx-cli translate в процесс сборки

Добавьте команду gtx-cli translate в процесс сборки или CI перед командой сборки, чтобы автоматически добавлять переводы в проект.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <команда для сборки>"
  }
}

Это сгенерирует переводы для всех ваших локалей и сохранит их в проекте. Если вы хотите добавить эти файлы в репозиторий, вместо этого выполните эту команду перед коммитом.

Готово! Теперь проект будет автоматически обновлять все JSON‑файлы переводов каждый раз, когда в проекте происходят изменения.

Примечания

• Вы можете автоматически добавлять переводы в свой проект с помощью команды gtx-cli translate.
• Если хотите закоммитить файлы переводов, вместо этого выполните команду gtx-cli translate перед коммитом.
• Чтобы настроить путь вывода для ваших переводов, см. раздел configuration в документации.

Дальнейшие шаги

• См. руководство по использованию для инструмента CLI.