Analyse

Utilisation

npx gtx-cli scan

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

Cette commande est similaire à la commande setup, mais elle est plus directe et ne fait qu'envelopper le composant <T> autour du contenu.

Elle n'ajoute pas d'autres composants comme <GTProvider>. Ainsi, nous recommandons d'exécuter cette commande occasionnellement pour s'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ésactive la génération automatique d'IDs pour les composants `<T>`	`flag`	`true`	`false`
`--disable-formatting`	Désactive le formatage automatique	`flag`	`true`	`false`

Comportement

La prop `id`

La commande scan générera automatiquement des identifiants uniques pour vos composants <T>. Ceci est utile pour les projets qui utilisent beaucoup de composants <T> et qui souhaitent éviter d'avoir à attribuer manuellement un identifiant 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

La CLI enveloppera les éléments JSX au niveau le plus élevé possible. Cela signifie qu'elle 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>

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

Auto-formatage

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

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