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 idiomas que soportas y más. También almacena información interna relevante como el versionId de tu proyecto.

Este archivo es leído por (1) tu componente withGTConfig() y (2) el comando gtx-cli translate. Por esta razón, recomendamos guardar tu configuración en el archivo gt.config.json en lugar de pasarla como prop a tu componente withGTConfig().

En general, cualquier cosa que comience con un guion bajo (por ejemplo, _versionId) es una propiedad interna y no debe ser modificada. Todo lo demás se puede modificar libremente.

Campos

Campo	Tipo	Descripción
`projectId`	`string`	Identificador único para tu proyecto en el sistema GT
`locales`	`string[]`	Arreglo de códigos de locales soportados para tu proyecto
`defaultLocale`	`string`	El código de local principal usado como respaldo cuando faltan traducciones
`cacheUrl`	`string`	URL del endpoint para el almacenamiento en caché de datos de traducción
`runtimeUrl`	`string`	URL del endpoint para servicios de traducción en tiempo de ejecución
`stageTranslations`	`boolean`	Configuración para funciones de traducción en staging/preview
`files`	`object`	Ruta a archivos de traducción locales para desarrollo y pruebas
`_versionId`	`string`	Propiedad interna utilizada para rastrear la versión del proyecto (no modificar)

`cacheUrl` y `runtimeUrl`

Si almacenas tus traducciones en la nube, el cacheUrl es la URL base para la caché. El runtimeUrl es la URL base para el entorno de ejecución y solo aplica a traducciones en desarrollo.

`stageTranslations`

El stageTranslations es una bandera utilizada por la herramienta gtx-cli para marcar tus traducciones como requeridas para revisión. Esto significa que deben ser aprobadas manualmente antes de que puedan ser desplegadas a producción mediante el comando gtx-cli translate.

`files`

El campo files especifica una ruta a traducciones almacenadas localmente (en contraste con almacenarlas en la nube). Específicamente, el campo output especifica 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 más información sobre cómo usar el campo files.

Ejemplos

Especificar tus locales

gt.config.json

{
  "defaultLocale": "en", // Primary locale is English
  "locales": ["fr", "es"] // Secondary locales are French and Spanish
}

Notas

El archivo gt.config.json se utiliza para especificar la configuración de tu proyecto.
Es leído tanto por el componente withGTConfig() como por el comando gtx-cli translate.

Próximos pasos

Aprende cómo agregar tus traducciones al paquete de tu proyecto.

gt.config.json

En esta página