Descripción general

gtx-cli puede usarse para traducir automáticamente los archivos JSON de tu proyecto, sin importar qué biblioteca de i18n estés utilizando.

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 gtx-cli. Obtén estos datos en el dashboard de General Translation.

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

Paso 2: Instala 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"]
    },
  },
}

Puedes 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 CI, antes del comando de build, para incorporar automáticamente las traducciones a tu proyecto.

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

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

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

Notas

• Puedes agregar traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
• Si quieres hacer commit de tus archivos de traducción, debes ejecutar el comando gtx-cli translate antes de hacer el commit.
• 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 CLI.