Config

gt.config.json

El archivo gt.config.json

Descripción general

El archivo gt.config.json se encarga de almacenar la configuración de tu proyecto. Contiene información importante como el projectId de tu proyecto, los locales que admites y más. También incluye información interna relevante, como el versionId de tu proyecto.

Este archivo lo leen (1) tu componente withGTConfig y (2) el comando gtx-cli translate. Por este motivo, recomendamos guardar tu configuración en el archivo gt.config.json en lugar de pasarla como prop a tu componente withGTConfig.

Por lo general, cualquier elemento que comience con un guion bajo (p. ej., _versionId) es una propiedad interna y no debería modificarse. Todo lo demás se puede editar.


Campos

CampoTipoDescripción
projectIdstringIdentificador único de tu proyecto en el sistema de GT
localesstring[]Matriz de códigos de configuración regional compatibles para tu proyecto
defaultLocalestringCódigo de configuración regional principal usado como contenido de respaldo predeterminado cuando faltan traducciones
cacheUrlstringURL de endpoint para el almacenamiento en caché de datos de traducción
runtimeUrlstringURL de endpoint para servicios de traducción en tiempo de ejecución
stageTranslationsbooleanConfiguración para funciones de staging/vista previa de traducciones
filesobjectRuta a los archivos de traducción locales para desarrollo y pruebas
_versionIdstringPropiedad interna utilizada para rastrear la versión del proyecto (no modificar)

cacheUrl and runtimeUrl

Si almacenas las traducciones en la nube, cacheUrl es la URL base de la caché. runtimeUrl es la URL base del runtime y solo aplica a las traducciones de desarrollo.

stageTranslations

El stageTranslations es un indicador que usa la herramienta gtx-cli para marcar tus traducciones como pendientes de revisión. Esto significa que deben aprobarse manualmente antes de poder desplegarse a producción mediante el comando gtx-cli translate.

files

El campo files especifica la ruta a las traducciones almacenadas localmente (en contraste con guardarlas en la nube). En particular, el campo output indica dónde se escribirán las traducciones.

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

Consulta la documentación de configuración de la herramienta CLI para obtener más información sobre cómo usar el campo files.


Ejemplos

Especificar tus locales

gt.config.json
{
  "defaultLocale": "en", // La locale principal es el inglés
  "locales": ["fr", "es"] // Las locales secundarias son francés y español
}

Notas

  • El archivo gt.config.json se usa para especificar la configuración de tu proyecto.
  • Lo leen tanto el componente withGTConfig como el comando gtx-cli translate.

Siguientes pasos

¿Qué te ha parecido esta guía?

gt.config.json