Panoramica

gtx-cli può essere usato per tradurre automaticamente i file JavaScript (js) e TypeScript (ts) del tuo progetto.

Seguiremo questi 4 passaggi:

Passaggio 1: Aggiungi le variabili d'ambiente

Aggiungi la chiave API di produzione e l'ID progetto alle variabili d'ambiente. Questo è necessario per usare lo strumento gtx-cli. Puoi recuperarli dalla dashboard di General Translation.

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

Fase 2: Installa gtx-cli

Installa lo strumento gtx-cli nel tuo progetto.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Passaggio 3: configura il file gt.config.json del progetto

Crea un file gt.config.json nella radice del progetto con il seguente contenuto:

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

Modifica defaultLocale e locales in modo che corrispondano alle impostazioni locali del tuo progetto.

Se i file sono JavaScript, puoi usare la chiave js invece di ts. L’array di stringhe nella chiave include deve essere un pattern glob che corrisponda a tutti i tuoi file JS.

Deve usare il segnaposto [locale] per far corrispondere la locale del file.

Consulta la documentazione di configuration per ulteriori informazioni sul file gt.config.json.

Passaggio 4: aggiungi il comando gtx-cli translate al processo di build

Aggiungi il comando gtx-cli translate al processo di build o di CI prima del comando di build, per aggiungere automaticamente le traduzioni al progetto.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <il tuo comando di compilazione>"
  }
}

Questo genererà le traduzioni per tutte le tue lingue e le salverà nel progetto. Se vuoi aggiungere questi file al tuo repository, esegui invece questo comando prima di fare il commit.

Tutto fatto! D’ora in poi il progetto aggiornerà automaticamente tutti i file Markdown ogni volta che il progetto cambia.

Note

• Puoi aggiungere automaticamente le traduzioni al tuo progetto con il comando gtx-cli translate.
• Se vuoi includere i file di traduzione nel commit, esegui il comando gtx-cli translate prima di confermare le modifiche.
• Per configurare il percorso di output delle traduzioni, consulta la documentazione di configurazione.

Prossimi passaggi

• Consulta la guida all’uso dello strumento CLI.