Scan

Utilisation

npx gtx-cli scan

La commande gtx-cli scan analyse votre projet pour trouver le contenu traduisible. Elle le fait en analysant l'arborescence des fichiers de votre projet et en utilisant babel pour envelopper le contenu statique avec le composant <T>. Tout contenu dynamique sera automatiquement enveloppé avec des composants <Var>.

Cette commande est similaire à la commande setup, mais elle est plus directe et enveloppe uniquement le contenu avec le composant <T>.

Elle n'ajoute pas d'autres composants comme <GTProvider>. Nous recommandons donc d'exécuter cette commande occasionnellement pour vous assurer que tout le contenu de votre projet est traduisible.

Vous devriez exécuter setup la première fois que vous intégrez General Translation dans votre projet.

src/app/Home.js

import { T, Var } from 'gt-next'; 
 
export default function Home({ user }) {
  return (
    <div>
      <T id="app.home.0">
        Hello, World! My name is <Var>{ user.name }</Var>
      </T>
    </div>
  );
}

Paramètres

Paramètre	Description	Type	Optionnel	Par défaut
`--src <path>`	Le répertoire source à analyser	`string`	`true`	`./src && ./app && ./pages && ./components`
`--config <path>`	Le chemin vers le fichier de configuration GT	`string`	`true`	`"gt.config.json"`
`--disable-ids`	Désactiver la génération automatique d'IDs pour les composants `<T>`	`flag`	`true`	`false`
`--disable-formatting`	Désactiver le formatage automatique	`flag`	`true`	`false`

Comportement

Fichier de configuration

Lors de la première exécution de l'outil CLI, il tentera de créer un fichier gt.config.json à la racine de votre projet. Ce fichier contient des métadonnées sur votre projet qui sont utilisées pour traduire votre contenu.

En savoir plus sur le fichier gt.config.json ici.

La prop `id`

La commande scan générera automatiquement des IDs uniques pour vos composants <T>. C'est utile pour les projets qui utilisent beaucoup de composants <T> et qui veulent éviter d'avoir à attribuer manuellement un ID unique à chacun.

Cet id est utile pour référencer des traductions spécifiques dans l'éditeur de traduction et dans la console.

Pour désactiver ce comportement, vous pouvez utiliser l'option --disable-ids.

Comportement d'injection de `<T>`

Cas de base

Le CLI enveloppera les éléments JSX au niveau le plus élevé possible. Cela signifie qu'il enveloppera l'ensemble du composant dans un composant <T> s'il n'est pas déjà enveloppé.

<div>Hello, World!</div> -> <T id="SOME_ID"><div>Hello, World!</div></T>

Consultez la référence pour plus de détails sur la façon dont le composant <T> est enveloppé.

Formatage automatique

La commande scan formatera automatiquement les modifications qu'elle apporte à votre base de code avec Prettier, Biome ou ESLint selon la configuration de votre projet.

Pour désactiver ce comportement, vous pouvez utiliser l'option --disable-formatting.