Descripción general

gtx-cli se puede usar para traducir automáticamente los archivos JSON de tu proyecto, sin importar qué biblioteca de i18n uses.

Seguiremos estos 4 pasos:

Paso 1: Agrega tus variables de entorno

Agrega tu clave de API de producción y el id del proyecto a tus variables de entorno. Esto es necesario para usar la CLI gtx-cli. Puedes obtenerlos en el dashboard de General Translation.

GT_API_KEY=<tu-clave-de-api>
GT_PROJECT_ID=<tu-id-de-proyecto>

Paso 2: Instalar gtx-cli

Instala la herramienta gtx-cli en tu proyecto.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Paso 3: Crea un archivo gt.config.json

Crea un archivo gt.config.json en la raíz de tu proyecto.

{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["i18n/[locale]/*.json"]
    },
  },
}

No dudes en personalizar el archivo gt.config.json según tus necesidades. Consulta la documentación de configuración para obtener más información.

Actualiza el formato del archivo json para que la ruta include coincida con la estructura de tu proyecto.

Paso 4: Añade el comando gtx-cli translate a tu proceso de compilación

Añade el comando gtx-cli translate a tu proceso de compilación o de CI antes del comando de compilación para incorporar automáticamente las traducciones a tu proyecto.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <tu comando de compilación>"
  }
}

Esto generará traducciones para todas tus locales y las guardará en tu proyecto. Si quieres confirmar estos files en tu repositorio, puedes ejecutar este comando antes de hacer el commit.

¡Listo! Ahora tu proyecto actualizará automáticamente todos tus files JSON de traducción cada vez que tu proyecto cambie.

Notas

• Puedes añadir traducciones a tu proyecto automáticamente con el comando gtx-cli translate.
• Si quieres confirmar tus cambios de archivos de traducción, deberías ejecutar el comando gtx-cli translate antes de confirmar.
• Para configurar la ruta de salida de tus traducciones, consulta la documentación de configuración.

Próximos pasos

• Consulta la guía de uso de la herramienta CLI.