Консоль
Config

gt.config.json

Файл gt.config.json

Обзор

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

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

Как правило, всё, что начинается с символа подчёркивания (например, _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 используется для задания конфигурации проекта.
  • Его читают и компонент withGTConfig, и команда gtx-cli translate.

Что дальше

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

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

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