Descripción general

gtx-cli puede usarse para traducir automáticamente los archivos de 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 CLI gtx-cli. Puedes obtenerlas desde 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: 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: 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 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 todas tus locales y las guardará en tu proyecto. Si quieres subir estos files a tu repo, puedes ejecutar este comando antes de hacer el commit.

¡Listo! Ahora tu proyecto actualizará automáticamente todos tus files de Markdown 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 files 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.