La Herramienta CLI
La herramienta CLI de Traducciones Generales
Visión general
Este es un documento de referencia sobre la herramienta CLI de Traducción General.
Lea más sobre gtx-cli aquí.
Para una guía paso a paso, consulte la guía Desplegando a Producción.
Instalación
¿Qué hace la herramienta CLI?
La herramienta CLI se utiliza para gestionar tu proyecto y tus traducciones.
Hay dos comandos principales que debes conocer: translate y setup.
- El comando
translateestá destinado a ser añadido al pipeline de CD. Se utiliza para escanear tu proyecto en busca de contenido para traducir. El contenido se carga luego en un CDN o se añade a tu paquete de aplicación para ser utilizado en tiempo de ejecución. - El comando
setupse utiliza para integrar automáticamente la biblioteca de Traducción General en tu proyecto. Escaneará tu proyecto y envolverá cualquier contenido JSX con un componente<T>.
Traducción
Para usar la herramienta CLI, ejecuta el siguiente comando desde la raíz de tu proyecto:
¡Solo para uso en producción!
Debido a que esta herramienta CLI publica contenido traducido en el CDN, está destinada a ser utilizada solo para compilaciones de producción y no debe usarse en desarrollo. Antes de ejecutar este comando, asegúrate de estar en la rama que se utilizará para producción. Recuerda también especificar tu clave API de producción y el ID del proyecto en tus variables de entorno.
Flags
| Prop | Type | Default |
|---|---|---|
--api-key? | string | - |
--project-id? | string | - |
--options? | string | gt.config.json |
--new? | string | - |
--dictionary? | string | - |
--dry-run? | boolean | false |
--ignore-errors? | boolean | false |
--inline? | boolean | true |
Al ejecutar la herramienta CLI por primera vez, intentará crear un archivo gt.config.json en la raíz de tu proyecto.
Este archivo contiene metadatos sobre tu proyecto que se utilizan para traducir tu contenido.
Configuración
Además, la herramienta CLI puede escanear y configurar automáticamente su proyecto para la traducción. Si está utilizando la Traducción General por primera vez, recomendamos ejecutar la configuración para comenzar.
¡Guarda tus cambios!
Esto modificará tu base de código, así que asegúrate de guardar o confirmar tus cambios primero.
Ejecutar este comando envolverá componentes <T> alrededor del nivel superior de elementos JSX que contienen contenido traducible.
También envolverá cualquier contenido no estático con componentes <Var>.
Aquí hay algunos ejemplos de lo que convertirá el escaneo:
Se convertirá en:
El CLI solo envolverá los hijos directos dentro de los elementos JSX. Envolverá otros elementos JSX por separado con sus propios componentes <T>.
Experimental
Esta característica es actualmente experimental y puede no funcionar perfectamente.
Después de ejecutar el escaneo, debes revisar manualmente el resultado y asegurarte de que sea correcto.
En particular, ten en cuenta que cualquier Expresión JSX no estática {...} se envolverá en componentes <Var>.
Es posible que necesites revisar y editar manualmente estos casos.
Por favor, informa cualquier problema que encuentres aquí.
Flags
| Prop | Type | Default |
|---|---|---|
--src? | string | - |