Scan

Verwendung

npx gtx-cli scan

Der gtx-cli scan Befehl durchsucht Ihr Projekt nach übersetzbarem Inhalt. Dies geschieht durch das Parsen des Dateibaums Ihres Projekts und die Verwendung von babel, um die <T> Komponente um statischen Inhalt zu wickeln. Jeder dynamische Inhalt wird automatisch mit <Var> Komponenten umschlossen.

Dieser Befehl ist ähnlich dem setup Befehl, aber er ist direkter und wickelt nur die <T> Komponente um Inhalt.

Er fügt keine anderen Komponenten wie <GTProvider> hinzu. Daher empfehlen wir, diesen Befehl gelegentlich auszuführen, um sicherzustellen, dass der gesamte Inhalt in Ihrem Projekt übersetzbar ist.

Sie sollten setup beim ersten Mal ausführen, wenn Sie General Translation in Ihr Projekt integrieren.

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	Standard
`--src <path>`	Das Quellverzeichnis zum Scannen	`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

Die `id` Eigenschaft

Der scan-Befehl generiert automatisch eindeutige IDs für Ihre <T> Komponenten. Dies ist nützlich für Projekte, die viele <T> Komponenten verwenden und vermeiden möchten, jeder einzelnen manuell eine eindeutige ID zuweisen zu müssen.

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

Um dieses Verhalten zu deaktivieren, können Sie das --disable-ids Flag verwenden.

`<T>` Injektionsverhalten

Grundlegender Fall

Die CLI wird JSX-Elemente auf der höchstmöglichen Ebene umschließen. Das bedeutet, dass sie die gesamte Komponente in eine <T> Komponente einschließt, falls sie nicht bereits umschlossen ist.

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

Siehe die Referenz für weitere Details darüber, wie die <T> Komponente umschlossen wird.

Auto-Formatierung

Der scan-Befehl formatiert automatisch die Änderungen, die er an Ihrer Codebasis vornimmt, mit Prettier, Biome oder ESLint, abhängig von der Konfiguration Ihres Projekts.

Um dieses Verhalten zu deaktivieren, können Sie das --disable-formatting Flag verwenden.