TypeScript

Descripción general

gtx-cli se puede utilizar 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 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: 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 el defaultLocale y locales para que coincidan con los idiomas de tu proyecto.

Si tus archivos son archivos 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 coincidir con el idioma del archivo.

Consulta la documentación de configuración 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 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 Markdown 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.