JSON

Descripción general

gtx-cli se puede usar 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 API de producción y el ID de tu proyecto a tus variables de entorno. Esto es necesario para usar la herramienta gtx-cli. Obtienes estos datos desde el panel de control de General Translation.

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

Paso 2: Instala gtx-cli

Instala la herramienta gtx-cli en tu proyecto.

npm i --save-dev 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"]
    },
  },
}

Siéntete libre de personalizar el archivo gt.config.json según tus necesidades. Consulta la documentación de configuración para más información.

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

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

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

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

Esto generará traducciones para todos tus locales y las guardará en tu proyecto. Si deseas agregar estos archivos a tu repositorio, puedes ejecutar este comando antes de hacer commit.

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

Notas

• Puedes agregar traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
• Si deseas confirmar tus archivos de traducción, debes 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 para la herramienta cli.