Консоль
Config

gt.config.json

Файл gt.config.json

Обзор

Файл gt.config.json отвечает за хранение конфигурации проекта. В нём содержится важная информация: projectId вашего проекта, поддерживаемые локали и многое другое. Также он включает внутренние данные, например versionId проекта.

Этот файл считывают (1) ваш компонент <GTProvider> и (2) команда gtx-cli translate. Поэтому мы рекомендуем хранить конфигурацию в gt.config.json, а не передавать её как проп компоненту <GTProvider>.

Как правило, всё, что начинается с подчёркивания (например, _versionId), является внутренним свойством и не должно изменяться. Остальное — на ваше усмотрение.

Поля

ПолеТипОписание
projectIdstringУникальный идентификатор вашего проекта в системе GT
localesstring[]Массив поддерживаемых кодов локалей вашего проекта
defaultLocalestringОсновной код локали, используемый в качестве резерва при отсутствии переводов
cacheUrlstringURL‑эндпоинт для кэширования данных переводов
runtimeUrlstringURL‑эндпоинт для сервисов перевода во время выполнения
stageTranslationsbooleanНастройки функций перевода для стейджинга/предпросмотра
filesobjectПуть к локальным файлам переводов для разработки и тестирования
_versionIdstringВнутренняя служебная переменная для отслеживания версии проекта (не изменяйте)

cacheUrl и runtimeUrl

Если вы храните переводы в облаке, cacheUrl — это базовый URL кэша. runtimeUrl — это базовый URL среды выполнения и применяется только к переводам, используемым в разработке.

stageTranslations

Флаг stageTranslations используется инструментом gtx-cli для пометки переводов как требующих ревью. Это означает, что перед выкатом в продакшен через команду gtx-cli translate их нужно вручную одобрить.

files

Поле files задаёт путь к локальным переводам (в отличие от хранения их в облаке). Поле output указывает, куда будут записываться переводы.

{
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  },
}

См. документацию по конфигурации для CLI‑инструмента, чтобы узнать больше об использовании поля files.

Примеры

Определение локалей

gt.config.json
{
  "defaultLocale": "en", // Основная локаль — английский
  "locales": ["fr", "es"] // Дополнительные локали — французский и испанский
}

Примечания

  • Файл gt.config.json используется для настройки вашего проекта.
  • Его считывают как компонент <GTProvider>, так и команда gtx-cli translate.

Что дальше

Насколько полезно это руководство?

На этой странице

Обзор
Поля
cacheUrl и runtimeUrl
stageTranslations
files
Примеры
Определение локалей
Примечания
Что дальше
gt.config.json