Descripción general

gtx-cli puede usarse para traducir automáticamente los archivos JavaScript (js) y TypeScript (ts) de tu proyecto.

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 herramienta gtx-cli. Puedes obtenerlas en el panel de General Translation.

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 gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Paso 3: Configura el archivo gt.config.json de tu proyecto

Crea un archivo gt.config.json en la raíz de tu proyecto con el siguiente contenido:

{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}

Cambia defaultLocale y locales para que coincidan con los locales de tu proyecto.

Si tus archivos son de JavaScript, puedes usar la clave js en lugar de ts. El arreglo de cadenas en la clave include debe ser un patrón glob que coincida con todos tus archivos JS.

Debe usar el marcador [locale] para hacer coincidir el locale del archivo.

Consulta la documentación de configuration para obtener más información sobre el archivo gt.config.json.

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

Añade el comando gtx-cli translate a tu proceso de build o de CI antes del comando de build para agregar traducciones automáticamente 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 agregar estos files a tu repositorio, puedes ejecutar este comando antes de confirmar los cambios.

¡Listo! Ahora tu proyecto actualizará automáticamente todos tus archivos Markdown cada vez que haya cambios en el proyecto.

Notas

• Puedes añadir traducciones automáticamente a tu proyecto con el comando gtx-cli translate.
• Si quieres hacer commit de tus archivos de traducción, deberías 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 herramienta CLI.