Обзор

withGTConfig — основной способ конфигурации библиотеки gt-next. Он напрямую оборачивает объект NextConfig.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
    // ваш существующий next.config.js
}

export default withGTConfig(nextConfig, {
  // Дополнительные опции конфигурации
});

Используйте withGTConfig, чтобы:

• Настроить поддерживаемые языки и локаль по умолчанию (fallback‑язык).
• Указать API‑ключи и идентификаторы проектов для доступа к сервисам GT.
• Задать поведение загрузки.
• Настроить параметры тайм‑аута.
• Настроить пользовательские endpoints.
• Настроить поведение перевода, кэширование и пакетирование запросов.
• Включить проверку на этапе сборки через плагин SWC.

Справочник

По умолчанию withGTConfig ищет файл gt.config.json в том же каталоге, что и ваш next.config.js.

Этот JSON‑файл будет загружен и объединён с конфигурацией, переданной в withGTConfig.

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

Обязательные параметры

Рекомендуемые пропсы

Расширенные пропсы

Возвращает

Функцию (NextConfig) => NextConfig, которая расширяет объект конфигурации Next.js заданными настройками GT.

Исключения

Генерирует Error, если отсутствует projectId и используются URL по умолчанию, либо если необходим, но отсутствует API‑ключ.

Параметры рендеринга

Параметры рендеринга определяют поведение переводов во время их загрузки. Это относится только к переводам, выполняемым на этапе выполнения (runtime). Если перевод закэширован, время отклика слишком мало, чтобы иметь заметное поведение загрузки.

Методы рендеринга

• skeleton: Отображает фрагмент.
• replace: Отображает контент на языке по умолчанию во время ожидания.
• default: Для локалей с одним языком (например, en-US и en-GB) работает как replace. Для локалей с разными языками (например, en-US и fr) работает как skeleton.

Тайм-аут

Тайм-ауты применяются только к переводу на этапе выполнения — то есть к переводам, которые выполняются по запросу, потому что они не были закэшированы.

По умолчанию тайм-аут составляет 8 секунд. Это решение призвано упростить работу пользователям Vercel, у которых на бесплатном плане действует стандартный тайм-аут 10 секунд для бессерверных функций.

Примеры

Параметры рендеринга

В этом примере gt-next настроен на отображение скелетона, пока загружаются переводы. Если загрузка переводов занимает более 8 секунд, метод завершится по тайм‑ауту и отрендерит содержимое на языке по умолчанию.

{
  "defaultLocale": "ru-RU",
  "locales": ["ru-RU", "es", "fr"],
}

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Остальные настройки Next.js
};

export default withGTConfig(nextConfig, {
  renderSettings: {
    method: 'skeleton',
    timeout: 10000,
  },
});

Проверка на этапе сборки

В этом примере плагин SWC настраивается так, чтобы нарушения динамического контента считались ошибками сборки, а не предупреждениями.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Остальные настройки Next.js
};

export default withGTConfig(nextConfig, {
  // Прерывать сборку при нарушениях в динамическом JSX
  dynamicJsxCheckLogLevel: 'error',
  // Предупреждать о нарушениях в динамических строках  
  dynamicStringCheckLogLevel: 'warn',
});

Примечания

• withGTConfig встраивает функциональность переводов GT в ваше приложение Next.js и должен использоваться в корневом файле конфигурации.
• Параметры, такие как apiKey и projectId, можно задать напрямую в конфигурации или через переменные окружения.
• Расширенные параметры, такие как renderSettings и _batchInterval, позволяют тонко управлять поведением переводов и производительностью.

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

• Добавьте перевод в процесс непрерывной доставки (CD).