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, tus idiomas compatibles y más.
También contiene información interna importante como el versionId
de tu proyecto.
Este archivo es leído por (1) tu componente withGTConfig()
y (2) el comando gtx-cli translate
.
Debido a esto, recomendamos almacenar tu configuración en tu archivo gt.config.json
en lugar de pasarla como una prop a tu componente withGTConfig()
.
Generalmente, cualquier cosa que comience con un guion bajo (por ejemplo, _versionId
) es una propiedad interna y no debe modificarse.
Todo lo demás se puede modificar.
Campos
| Campo | Tipo | Descripción |
|-------|-------------|
| projectId
| string
| Identificador único para tu proyecto en el sistema GT |
| locales
| string[]
| Array de códigos de idioma soportados para tu proyecto |
| defaultLocale
| string
| El código de idioma principal utilizado como respaldo cuando faltan traducciones |
| cacheUrl
| string
| URL de punto final para almacenar en caché los datos de traducción |
| runtimeUrl
| string
| URL de punto final para servicios de traducción en tiempo de ejecución |
| stageTranslations
| boolean
| Configuración para funciones de traducción en entorno de pruebas/vista previa |
| 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 estás almacenando 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 se aplica a traducciones en desarrollo.
stageTranslations
El stageTranslations
es una bandera utilizada por la herramienta gtx-cli
para marcar tus traducciones como pendientes de revisión.
Esto significa que deben ser aprobadas manualmente antes de que puedan ser desplegadas a producción a través del 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.
Ejemplos
Especificando tus locales
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 comandogtx-cli translate
.
Próximos pasos
- Aprende cómo agregar tus traducciones al paquete de tu proyecto.