Etapa
Cómo preparar tus traducciones para revisión
Descripción general
gtx-cli stage es un comando que genera traducciones para tu proyecto y las prepara para revisión.
Este comando solo es útil si has habilitado la revisión humana en tu proyecto.
Actualmente, este comando solo es compatible con aplicaciones que usan gt-next o gt-react.
Uso
Ejecuta esto en tu pipeline de CI antes de compilar tu aplicación para producción.
npx gtx-cli stageNota: ¡Este comando requiere una clave API de producción! Consíguela en la plataforma.
El comando gtx-cli stage funciona de la misma manera que el comando translate, pero en lugar de descargar las traducciones completadas o publicarlas en el CDN, simplemente las deja preparadas para revisión.
Después de ejecutar gtx-cli stage, deberías ejecutar gtx-cli translate para completar el proceso y descargar las traducciones (si está configurado para hacerlo).
¡Solo para uso en producción!
Este comando está destinado a compilaciones de producción y no debe usarse en desarrollo.
Antes de ejecutar este comando, por favor asegúrate de estar en la rama que se usará 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.
Flags
| Parámetro | Descripción | Tipo | Opcional | Por defecto |
|---|---|---|---|---|
--api-key | Especificar una clave de 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> | Lista separada por espacios de patrones glob para coincidir con archivos fuente. Debe ser relativa al directorio raíz. | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--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 fuente 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 |
Todos estos parámetros son opcionales.
¡No agregues tu clave de API al archivo gt.config.json!
Deberías configurarla como una variable de entorno en su lugar. La 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 la 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 de API de producción. |
--project-id | De manera similar, a menos que estés usando --dry-run, debes proporcionar un ID de proyecto. |
--new, --locales <locales> | Idiomas a los que traducir tu proyecto. Estos se agregarán a los idiomas especificados en tu archivo gt.config.json. |
Archivo de configuración
Al ejecutar gtx-cli stage, la CLI agregará automáticamente la propiedad stageTranslations : true a tu archivo gt.config.json.
Esta propiedad asegura que si translate se ejecuta sin ejecutar primero stage para una versión de despliegue específica,
la herramienta CLI mostrará un error y saldrá.
Además, esta propiedad asegura que el comando translate no duplicará las traducciones realizadas por el comando stage.
¿Qué te parece esta guía?