Подготовка к проверке
Как подготовить переводы к ревью
Обзор
gtx-cli stage — это команда, которая генерирует переводы для вашего проекта и отправляет их на проверку.
Эта команда имеет смысл только если в вашем проекте включена ручная проверка.
В настоящее время команда поддерживается только для приложений на gt-next или gt-react.
Использование
Запустите это в вашем CI‑конвейере перед сборкой приложения для продакшена.
npx gtx-cli stageПримечание: Для этой команды требуется production API‑ключ! Получите его на платформе.
Команда gtx-cli stage работает так же, как translate, но вместо скачивания готовых переводов или публикации их в CDN, она просто подготавливает их к ревью.
После выполнения gtx-cli stage запустите gtx-cli translate, чтобы завершить процесс и скачать переводы (если так настроено).
Только для продакшена!
Эта команда предназначена для продакшен‑сборок и не должна использоваться в разработке.
Перед запуском команды убедитесь, что вы на ветке, которая пойдет в продакшен.
Не забудьте также указать в переменных окружения ваш продакшен API‑ключ (GT_API_KEY) и Project ID (GT_PROJECT_ID).
Флаги
| Параметр | Описание | Тип | Необязательный | По умолчанию |
|---|---|---|---|---|
--api-key | Указать рабочий (production) ключ API | string | true | |
--project-id | Указать ID проекта | string | true | |
--version-id | Указать ID версии (по умолчанию — хэш содержимого) | string | true | |
--config <path> | Указать путь к файлу конфигурации GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Указать путь к файлу конфигурации TS или JS | string | true | |
--src <paths> | Список glob‑шаблонов, разделённых пробелами, для поиска исходных файлов. Пути должны быть относительными от корня проекта. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | Указать путь к файлу словаря | string | true | |
--inline | Включать встроенные теги <T> в дополнение к словарю | boolean | true | true |
--timeout | Тайм‑аут запроса перевода в секундах | number | true | 600 |
--new, --locales <locales> | Локали, на которые нужно перевести проект | [string] | true | |
--default-locale <locale> | Исходная локаль проекта | string | true | en |
--ignore-errors | Игнорировать ошибки и принудительно переводить валидный контент | flag | true | false |
--dry-run | Пробный запуск команды | flag | true | false |
Все эти параметры являются необязательными.
Не добавляйте свой ключ API в файл gt.config.json!
Вместо этого задайте его как переменную окружения. CLI автоматически прочитает GT_API_KEY, если она задана.
Есть несколько ключевых параметров:
| Параметр | Описание |
|---|---|
--dry-run | Этот флаг заставит CLI разобрать и проверить ваш проект, но не будет взаимодействовать с GT API. Полезно для валидации кодовой базы. |
--api-key | Если вы не используете --dry-run, необходимо указать рабочий (production) ключ API. |
--project-id | Аналогично, если вы не используете --dry-run, необходимо указать ID проекта. |
--new, --locales <locales> | Локали, на которые нужно перевести проект. Они будут добавлены к локалям, указанным в файле gt.config.json. |
Файл конфигурации
При запуске gtx-cli stage CLI автоматически добавит свойство stageTranslations: true в ваш файл gt.config.json.
Это свойство гарантирует, что если translate запустить без предварительного выполнения stage для конкретной версии развёртывания, CLI завершится с ошибкой и прекратит работу.
Насколько полезно это руководство?