Archivos JSON

Cómo usar General Translation para configurar la traducción automática de los archivos JSON de tu proyecto

Descripción general

gtx-cli puede utilizarse para traducir automáticamente los archivos JSON de tu proyecto, independientemente de la biblioteca i18n que estés utilizando.

Nota: Actualmente soportamos sintaxis de cadenas personalizadas y formato para las siguientes bibliotecas i18n: next-intl, i18next, gt-next, gt-react.

Si estás utilizando una biblioteca i18n diferente, los resultados de traducción pueden no ser precisos para cadenas con sintaxis y formato personalizados (por ejemplo, mensajes ICU). ¿No ves tu biblioteca favorita? Por favor, háganoslo saber, ¡y la añadiremos tan pronto como podamos!

Seguiremos estos 4 pasos:

Añadir tus variables de entorno

Instalar gtx-cli

Crear un archivo gt.config.json

Consejo: Evita la molestia de usar archivos de traducción con el componente <T>.


Paso 1: Añadir tus variables de entorno

Añade tu clave API de producción y el ID del proyecto a tus variables de entorno. Esto es necesario para usar la herramienta gtx-cli. Puedes obtener estos datos desde el panel de control de General Translation.

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

Paso 2: Instalar gtx-cli

Instala la herramienta gtx-cli en tu proyecto.

npm i --save-dev gtx-cli

Paso 3: Crear un archivo gt.config.json

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

gt.config.json
{
  "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 obtener más información.

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

Las traducciones preservarán la sintaxis original de las cadenas.

Paso 4: Añadir 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 compilación para agregar automáticamente traducciones a tu proyecto.

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

Esto generará traducciones para todos tus idiomas y las guardará en tu proyecto. Si quieres confirmar estos archivos en tu repositorio, puedes ejecutar este comando antes de confirmar.

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


Notas

  • Puedes añadir traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
  • Si quieres confirmar tus 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 para la herramienta cli.
  • Si quieres ver traducciones en vivo durante el desarrollo (piensa en recarga en caliente), consulta el componente <T>.

En esta página