Scan

Verwendung

npx gtx-cli scan

Der Befehl gtx-cli scan durchsucht dein Projekt nach übersetzbaren Inhalten. Dies geschieht durch Analyse des Dateibaums deines Projekts und die Verwendung von Babel, um statische Inhalte mit der <T>-Komponente zu umschließen. Alle dynamischen Inhalte werden automatisch mit <Var>-Komponenten umschlossen.

Dieser Befehl ähnelt dem Befehl setup, ist jedoch unkomplizierter und umschließt nur Inhalte mit der <T>-Komponente.

Er fügt keine anderen Komponenten wie <GTProvider> hinzu. Daher empfehlen wir, diesen Befehl gelegentlich auszuführen, um sicherzustellen, dass alle Inhalte in deinem Projekt übersetzbar sind.

Du solltest setup ausführen, wenn du General Translation zum ersten Mal in dein Projekt integrierst.

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>
  );
}

Parameter

Parameter	Beschreibung	Typ	Optional	Standardwert
`--src <path>`	Das zu scannende Quellverzeichnis	`string`	`true`	`./src && ./app && ./pages && ./components`
`--config <path>`	Der Pfad zur GT-Konfigurationsdatei	`string`	`true`	`"gt.config.json"`
`--disable-ids`	Deaktiviert die automatische Generierung von IDs für `<T>`-Komponenten	`flag`	`true`	`false`
`--disable-formatting`	Deaktiviert die automatische Formatierung	`flag`	`true`	`false`

Verhalten

Konfigurationsdatei

Wenn du das CLI-Tool zum ersten Mal ausführst, wird es versuchen, eine gt.config.json-Datei im Stammverzeichnis deines Projekts zu erstellen. Diese Datei enthält Metadaten über dein Projekt, die für die Übersetzung deiner Inhalte verwendet werden.

Mehr über die gt.config.json-Datei erfährst du hier.

Die `id`-Eigenschaft

Der Scan-Befehl generiert automatisch eindeutige IDs für deine <T>-Komponenten. Dies ist nützlich für Projekte, die viele <T>-Komponenten verwenden und vermeiden möchten, jeder manuell eine eindeutige ID zuzuweisen.

Diese id ist nützlich, um bestimmte Übersetzungen im Übersetzungseditor und in der Konsole zu referenzieren.

Um dieses Verhalten zu deaktivieren, kannst du das Flag --disable-ids verwenden.

`<T>`-Injektionsverhalten

Grundlegender Fall

Das CLI wird JSX-Elemente auf der höchstmöglichen Ebene umschließen. Das bedeutet, dass es die gesamte Komponente in eine <T>-Komponente einwickelt, wenn sie noch nicht umschlossen ist.

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

Weitere Details darüber, wie die <T>-Komponente umschlossen wird, findest du in der Referenz.

Automatische Formatierung

Der Scan-Befehl formatiert die Änderungen, die er an deinem Codebase vornimmt, automatisch mit Prettier, Biome oder ESLint, je nach der Konfiguration deines Projekts.

Um dieses Verhalten zu deaktivieren, kannst du das Flag --disable-formatting verwenden.