Traducir
Cómo traducir tu proyecto
Uso
Ejecuta esto en tu pipeline de CI antes de compilar tu aplicación Next.js para producción.
Nota: ¡Este comando requiere una clave API de producción! Obtén una en la plataforma.
Descripción general
El comando gtx-cli translate traduce tu proyecto. Recorre el árbol de archivos de tu proyecto y traduce cualquier contenido envuelto en un componente <T>.
Además, incluye contenido del archivo de diccionario (si se proporciona uno).
Este comando es la forma principal de usar la API de General Translation y los servicios relacionados.
¡Solo para uso en producción!
Este comando está destinado 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 (GT_API_KEY) y el ID del Proyecto (GT_PROJECT_ID) en tus variables de entorno.
Uso
Hay cuatro formas de usar el comando translate. Los métodos 2, 3 y 4 requieren una clave API de producción:
Recomendamos ejecutar npx gtx-cli init para configurar primero tu proyecto antes de ejecutar el comando translate.
Dependiendo de cómo esté configurado tu proyecto, el comportamiento del comando translate puede cambiar.
Método 1: Traducir los archivos JSON de tu proyecto.
Si estás utilizando otras bibliotecas i18n como next-intl, react-i18next o next-i18next, puedes usar este método para traducir los archivos JSON de tu proyecto.
Las traducciones se guardarán automáticamente en tu base de código, así como opcionalmente se publicarán en el CDN de GT.
Al ejecutar npx gtx-cli init, especifica que estás utilizando una biblioteca i18n de terceros antes de ejecutar el comando translate.
Consulta la documentación de configuración de CLI para más detalles.
La herramienta CLI detectará automáticamente tu biblioteca i18n leyendo tu archivo package.json, y traducirá tu contenido respetando la sintaxis de tu biblioteca i18n.
Método 2: Traducir tu proyecto y guardar las traducciones en el CDN de GT.
Si estás utilizando gt-next o gt-react, puedes usar este método para traducir tu proyecto.
Al ejecutar npx gtx-cli init, si seleccionas la opción para guardar traducciones remotamente, el comando translate guardará las traducciones en el CDN de GT.
Método 3: Traducir tu proyecto y guardar las traducciones en tu base de código.
Al ejecutar npx gtx-cli init, si seleccionas la opción para guardar traducciones localmente, el comando translate guardará las traducciones en tu base de código.
gt-next y gt-react pueden entonces servir estas traducciones locales a tus usuarios, en lugar de usar el CDN público de General Translation.
Este método es útil si estás utilizando un sistema de gestión de contenido personalizado, o no quieres usar el CDN de GT.
Método 4: Validar los componentes <T> y el archivo de diccionario de tu proyecto.
Este método es útil para validar los componentes <T> y el archivo de diccionario de tu proyecto.
Esto asegura que tu proyecto esté configurado correctamente y que las traducciones sean válidas y precisas.
No se generarán traducciones si se proporciona la bandera --dry-run.
Banderas
| Parámetro | Descripción | Tipo | Opcional | Predeterminado |
|---|---|---|---|---|
--api-key | Especificar una clave API de producción | string | true | |
--project-id | Especificar el ID del proyecto | string | true | |
--version-id | Especificar un ID de versión (por defecto, un hash del contenido) | string | true | |
--config <path> | Especificar una ruta al archivo de configuración GT | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Especificar una ruta al archivo de configuración TS o JS | string | true | |
--src <paths> | Especificar el/los directorio(s) fuente para escanear | [string] | true | ./src && ./app && ./pages && ./components |
--dictionary <path> | Especificar una ruta al archivo de diccionario | string | true | |
--inline | Incluir etiquetas <T> en línea además del diccionario | boolean | true | true |
--timeout | El tiempo de espera para la solicitud de traducción en segundos | number | true | 600 |
--new, --locales <locales> | Idiomas a los que traducir tu proyecto | [string] | true | |
--default-locale <locale> | El idioma de origen para el proyecto | string | true | en |
--ignore-errors | Ignorar errores y forzar la traducción para contenido válido | flag | true | false |
--dry-run | Ejecutar el comando en modo de prueba | flag | true | false |
--no-wait | No esperar a que se completen las traducciones antes de salir | flag | true | false |
--publish | Publicar las traducciones en el CDN | flag | true | false |
Todos estos parámetros son opcionales y pueden proporcionarse alternativamente en el archivo gt.config.json.
¡No añadas tu clave API al archivo gt.config.json!
Deberías establecerla como una variable de entorno en su lugar. El CLI leerá automáticamente GT_API_KEY si está configurada.
Hay algunos parámetros clave:
| Parámetro | Descripción |
|---|---|
--dry-run | Esta bandera hará que el CLI analice y valide tu proyecto, pero no se comunicará con la API de GT. Esto es útil para validar tu base de código. |
--api-key | A menos que estés usando --dry-run, debes proporcionar una clave API de producción. |
--project-id | De manera similar, a menos que estés usando --dry-run, debes proporcionar un ID de proyecto. |
--publish | Si estás usando traducciones locales y quieres hacer tus traducciones disponibles públicamente en el CDN de GT, puedes usar esta bandera. |
--new, --locales <locales> | Idiomas a los que traducir tu proyecto. Estos se añadirán a los idiomas especificados en tu archivo gt.config.json. |
Archivo de configuración
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.
Lee más sobre el archivo gt.config.json aquí.