# gt: General Translation CLI tool: TypeScript
URL: https://generaltranslation.com/fr/docs/cli/formats/ts.mdx
---
title: TypeScript
description: Comment traduire automatiquement des fichiers TypeScript et JavaScript avec General Translation
---

## Vue d’ensemble

`gt` permet de traduire automatiquement les fichiers JavaScript (js) et TypeScript (ts) de votre projet.

<Callout type="info">
  Toute la syntaxe et la mise en forme des fichiers d’origine seront conservées dans
  les fichiers traduits.
</Callout>

Nous allons suivre ces 4 étapes :

<Steps>
  <Step>
    Ajoutez vos variables d’environnement
  </Step>

  <Step>
    Installez [`gt`](/docs/cli)
  </Step>

  <Step>
    Configurez le fichier [`gt.config.json`](/docs/cli/reference/config) de votre projet
  </Step>

  <Step>
    Exécutez [`gt translate`](/docs/cli/translate#translate)
  </Step>
</Steps>

***

## Étape 1 : Ajoutez vos variables d’environnement

Ajoutez votre clé API de production et l’ID de votre projet à vos variables d’environnement.
Cela est nécessaire pour utiliser l’outil `gt`.
Vous pouvez les récupérer depuis le [tableau de bord de General Translation](https://generaltranslation.com/dashboard).

```bash title=".env"
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>
```


## Étape 2 : Installez `gt`

Installez l’outil `gt` dans votre projet.

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm i gt
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

## Étape 3 : Configurez le fichier `gt.config.json` de votre projet

Créez un fichier `gt.config.json` à la racine de votre projet, avec le contenu suivant :

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}
```

Modifiez `defaultLocale` et `locales` pour qu’ils correspondent aux paramètres régionaux de votre projet.

Si vos fichiers sont des fichiers JavaScript, vous pouvez utiliser la clé `js` au lieu de `ts`. Le tableau de chaînes de la clé `include` doit être un motif glob correspondant à tous vos fichiers JS.

Il doit utiliser l’espace réservé `[locale]` pour correspondre au paramètre régional du fichier.

Consultez la documentation de [configuration](/docs/cli/reference/config) pour plus d’informations sur le fichier `gt.config.json`.


## Étape 4 : Ajoutez la commande `gt translate` à votre processus de build

Ajoutez la commande `gt translate` à votre processus de build ou d’intégration continue, avant la commande de build, afin d’ajouter automatiquement les traductions à votre projet.

```json title="package.json"
{
  "scripts": {
    "translate": "npx gt translate",
    "build": "npm run translate && <your build command>"
  }
}
```

Cela générera des traductions pour tous vos paramètres régionaux et les enregistrera dans votre projet.
Si vous souhaitez inclure ces fichiers dans votre dépôt, vous pouvez plutôt exécuter cette commande avant de valider.

Terminé ! Désormais, votre projet mettra automatiquement à jour tous vos fichiers TypeScript à chaque modification du projet.

***


## Remarques

* Vous pouvez ajouter automatiquement des traductions à votre projet avec la commande [`gt translate`](/docs/cli/translate).
* Si vous souhaitez valider vos fichiers de traduction, exécutez la commande `gt translate` avant la validation.
* Pour configurer le chemin de sortie de vos traductions, consultez la documentation de [configuration](/docs/cli/reference/config).

## Étapes suivantes

* Consultez la [commande `gt translate`](/docs/cli/translate) pour plus de détails sur son utilisation en CLI.