Обзор

gtx-cli можно использовать для автоматического перевода файлов JavaScript (js) и TypeScript (ts) в вашем проекте.

Мы пройдём через 4 шага:

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

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

GT_API_KEY=<ваш ключ API>
GT_PROJECT_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": "en",
  "locales": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}

Измените defaultLocale и locales так, чтобы они соответствовали локалям вашего проекта.

Если у вас файлы JavaScript, вы можете использовать ключ js вместо ts. Массив строк в ключе include должен быть glob‑шаблоном, который охватывает все ваши JS‑файлы.

Используйте плейсхолдер [locale], чтобы сопоставлять локаль файла.

См. раздел configuration для получения дополнительной информации о файле gt.config.json.

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

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

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

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

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

Примечания

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

Следующие шаги

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