Guía de Uso
Guía de uso para la herramienta de línea de comandos GT
Descripción general
Esta guía te llevará a través del proceso de uso de la herramienta CLI de General Translation (gtx-cli) para traducir tu proyecto.
La herramienta CLI es compatible con cualquier biblioteca i18n, ya sea que estés usando gt-next, gt-react, o bibliotecas de terceros como next-intl o react-i18next.
La herramienta CLI es responsable de conectar tu proyecto al servicio de traducción de IA de General Translation.
Hay varias formas de usar la herramienta CLI, por favor navega a la sección relevante para tu caso de uso.
Instalación
Para instalar la herramienta CLI, ejecuta el siguiente comando:
Casos de uso
Traducción de proyectos GT
La herramienta CLI puede ser utilizada para traducir tus proyectos que usan gt-next o gt-react.
Esta guía asume que ya has configurado tu código base para usar gt-next o gt-react de acuerdo con los tutoriales de gt-next o gt-react.
- Primero, necesitarás inicializar la herramienta CLI en tu proyecto.
- A continuación, necesitarás crear un proyecto en el panel de control de General Translation.
Después de crear un proyecto, necesitarás generar una clave API de producción. Navega a la página "API Keys" y haz clic en el botón "Create API Key".
- Luego, agrega tu clave API y el ID del proyecto a tus variables de entorno.
- Finalmente, ejecuta el comando de traducción.
Por defecto, la herramienta CLI publicará las traducciones en el CDN de General Translation, para que estén listas para ser utilizadas en tu proyecto.
Si deseas desactivar este comportamiento (por ejemplo, si estás cargando traducciones desde una fuente diferente), agrega la bandera --no-publish al comando.
Consulta la referencia de API para obtener más información sobre el comando translate.
Traducción de archivos de idioma (bibliotecas i18n de terceros o proyectos GT independientes)
La herramienta CLI te permite traducir archivos de idioma para bibliotecas i18n de terceros o con una implementación independiente de gt-next o gt-react.
La mayoría de las bibliotecas i18n dependen de archivos JSON para almacenar datos de traducción. La herramienta CLI puede ser utilizada para traducir automáticamente estos archivos JSON a los idiomas que desees.
- Primero, necesitarás inicializar la herramienta CLI en tu proyecto.
Este comando creará un archivo gt.config.json en la raíz de tu proyecto, que contiene algunas configuraciones básicas, como el idioma predeterminado de tu proyecto y los idiomas compatibles.
- A continuación, necesitarás crear un proyecto en el panel de control de General Translation.
Después de crear un proyecto, necesitarás generar una clave API de producción. Navega a la página "API Keys" y haz clic en el botón "Create API Key".
- Luego, agrega tu clave API y el ID del proyecto a tus variables de entorno.
- Finalmente, ejecuta el comando de traducción.
Por defecto, la herramienta CLI buscará en el directorio translationsDir especificado en tu archivo gt.config.json los archivos de idioma para traducir.
Utilizará el defaultLocale especificado en tu archivo gt.config.json como idioma de origen.
También publicará las traducciones en el CDN de General Translation, para que estén listas para ser utilizadas en tu proyecto.
Si deseas desactivar este comportamiento, añade la bandera --no-publish al comando.
Generando archivos de idioma para proyectos GT
La herramienta CLI puede utilizarse para generar archivos de idioma para proyectos que utilizan gt-next o gt-react.
Este caso de uso es útil si deseas utilizar tu propio proveedor de traducción.
A diferencia de otras bibliotecas i18n, gt-next y gt-react admiten traducciones en línea, lo que significa que no hay una estructura de archivo JSON tradicional que contenga claves y valores para cada idioma.
Esto significa que para realizar un seguimiento de los cambios en el texto, las bibliotecas GT almacenan los hashes del texto original en el código fuente.
Esta estructura de datos interna (que contiene hashes) es difícil de trabajar, y por lo tanto la herramienta CLI proporciona un práctico comando para generar archivos de idioma para tu proyecto.
- Primero, necesitarás inicializar la herramienta CLI en tu proyecto.
Cuando se te pregunte "¿Dónde se almacenan tus archivos de idioma?", selecciona la opción "Local".
- Ejecuta:
Este comando generará un archivo fuente para tu idioma predeterminado y todos los demás idiomas que hayas configurado para tu proyecto.
El contenido de cada archivo es el mismo y se fusionará con cualquier traducción previa que tengas en tu proyecto.
Consulta la referencia de la API para obtener más información sobre el comando generate.
Notas
gtx-cli translatese utiliza para generar automáticamente traducciones para tu proyecto.- Si estás utilizando una biblioteca i18n de terceros, puedes actualizar automáticamente todos tus archivos JSON de traducción cada vez que cambie tu proyecto. Solo añade el comando
gtx-cli translatea tu proceso de compilación o CD antes del comando de compilación para añadir automáticamente traducciones a tu proyecto.
Próximos pasos
- Consulta la referencia de la API de CLI para obtener más información.
- Si quieres ver traducciones en vivo durante el desarrollo (piensa en recarga en caliente), consulta el componente
<T>.