Schnellstart für AdonisJS - Lingo.dev Compiler

Einführung

Lingo.dev Compiler ist ein KI-gestütztes Tool, das die Lokalisierung von React-basierten Apps ermöglicht, ohne bestehende Komponenten zu verändern. Sie konfigurieren nur einige Einstellungen, umschließen Ihre App mit einem Context-Provider, und das war's – Ihre App ist lokalisiert.

Diese Anleitung erklärt, wie Sie Lingo.dev Compiler mit AdonisJS, einem umfassenden Node.js-Webframework für serverseitige Anwendungen, einrichten.

Voraussetzungen

Ihr AdonisJS-Projekt verwendet Inertia.js.

Was Sie lernen werden

Wie man Lingo.dev Compiler in einem AdonisJS-Projekt initialisiert
Wie man den Compiler für die Kompatibilität mit AdonisJS konfiguriert
Wie man einen Locale-Switcher zum Umschalten zwischen Sprachen einrichtet

Schritt 1. API-Schlüssel einrichten

Lingo.dev Compiler verwendet Large Language Models (LLMs), um Apps mit KI zu lokalisieren. Um eines dieser Modelle zu nutzen, benötigen Sie einen API-Schlüssel von einem unterstützten Anbieter.

Um schnellstmöglich loszulegen, empfehlen wir Lingo.dev Engine – unsere eigene, gehostete Plattform, die 10.000 Tokens kostenlose monatliche Nutzung bietet.

So richten Sie einen API-Schlüssel ein:

Melden Sie sich bei Lingo.dev Engine an.
Navigieren Sie zur Seite Projects.
Klicken Sie auf API key > Copy.
Speichern Sie den API-Schlüssel in einer Umgebungsvariable:
```
export LINGODOTDEV_API_KEY="<your_api_key>"
```

Alternative: Benutzerdefinierte LLM-Anbieter

Sie müssen nicht Lingo.dev Engine verwenden. Sie können den Compiler so konfigurieren, dass er mit verschiedenen benutzerdefinierten LLM-Anbietern integriert wird, darunter:

Groq
Google
Mistral
Ollama
OpenRouter

Schritt 2. Paket installieren

Lingo.dev Compiler wird als Teil des lingo.dev npm-Pakets vertrieben. Zur Installation verwenden Sie Ihren bevorzugten Paketmanager:

npm install lingo.dev

Schritt 3. Initialisieren des Compilers

Der Lingo.dev Compiler integriert sich in Vite und läuft zur Build-Zeit. Um in den Build-Prozess von Vite einzugreifen, nehmen Sie folgende Änderungen an der Datei vite.config.ts vor:

Importieren Sie den Compiler:

import lingoCompiler from "lingo.dev/compiler";

Initialisieren Sie den Compiler mit der vite-Methode:
```
const withLingo = lingoCompiler.vite({
  sourceRoot: "inertia",
  lingoDir: "lingo",
  sourceLocale: "en",
  targetLocales: ["es"],
  rsc: false,
  useDirective: false,
  debug: false,
  models: "lingo.dev",
});
```
Für die Kompatibilität mit AdonisJS stellen Sie sicher, dass:
- sourceRoot auf "inertia" gesetzt ist
- rsc auf false gesetzt ist
Um mehr über die verfügbaren Optionen zu erfahren, siehe Compiler-Optionen.
Führen Sie die Compiler-Konfiguration mit der bestehenden Konfiguration zusammen und exportieren Sie sie:
```
export default withLingo(viteConfig);
```

Mit dieser Konfiguration wird der Lingo.dev Compiler:

Den Abstract Syntax Tree (AST) des Quellcodes durchlaufen
Lokalisierbare Inhalte finden (d.h. Text in JSX-Elementen und bestimmten Attributwerten)
Die konfigurierten KI-Modelle verwenden, um Übersetzungen zu generieren
Die originalen und übersetzten Inhalte in einer dictionary.js-Datei speichern
Lokalisierte Inhalte durch Platzhalter ersetzen

Schritt 4. Laden des lokalisierten Inhalts

Nachdem der Compiler Ihre App verarbeitet und Übersetzungen generiert hat, müssen Sie diesen lokalisierten Inhalt laden und Ihren Benutzern bereitstellen. Dies beinhaltet:

Laden des entsprechenden Wörterbuchs basierend auf der Locale-Präferenz des Benutzers
Bereitstellen der geladenen Übersetzungen für Ihre App durch einen Context-Provider

Client-Seitig

In der Datei inertia/app/app.tsx:

Importiere die Komponente LingoProviderWrapper und die Funktion loadDictionary aus lingo.dev/react/client:
```
import {
  LingoProviderWrapper,
  loadDictionary,
} from "lingo.dev/react/client";
```
Die Komponente LingoProviderWrapper ist ein Context-Provider, der die vom Compiler erstellten Platzhalter durch den lokalisierten Inhalt ersetzt.

Die Funktion loadDictionary:
- Ruft die aktuelle Locale aus dem Cookie lingo-locale ab
- Fällt auf "en" zurück, wenn keine Locale definiert ist
- Lädt den lokalisierten Inhalt aus der Datei dictionary.js

Umschließe die App-Komponente mit der LingoProviderWrapper-Komponente und übergib die Funktion loadDictionary:

<LingoProviderWrapper loadDictionary={(locale) => loadDictionary(locale)}>
  <App {...props} />
</LingoProviderWrapper>

Server-Side

In der Datei inertia/app/ssr.tsx wiederhole die gleichen Schritte, um Hydration-Mismatches zu vermeiden:

import { LingoProviderWrapper, loadDictionary } from "lingo.dev/react/client";

<LingoProviderWrapper loadDictionary={(locale) => loadDictionary(locale)}>
  <App {...props} />
</LingoProviderWrapper>;

Schritt 5. Einrichten eines Locale-Switchers

Um Benutzern das Umschalten zwischen Locales zu ermöglichen, importieren Sie den LocaleSwitcher aus dem lingo.dev-Paket. Dies ist eine unstyled Komponente, die:

Ein Dropdown-Menü der verfügbaren Locales rendert
Dem Benutzer die Auswahl seiner bevorzugten Locale ermöglicht
Die Locale-Präferenz des Benutzers für zukünftige Besuche speichert

Um die Komponente zu verwenden, betten Sie sie an beliebiger Stelle in Ihrer App ein und setzen Sie die locales-Prop auf ein Array, das die konfigurierten Quell- und Ziel-Locales enthält:

import { LocaleSwitcher } from "lingo.dev/react/client";

<LocaleSwitcher locales={["en", "es"]} />;

Alternative: Benutzerdefinierter Locale-Switcher

Sie müssen nicht unbedingt die LocaleSwitcher-Komponente verwenden. Sie können eine benutzerdefinierte Locale-Switching-Logik und UI implementieren. Die einzige Voraussetzung ist, dass die aktive Locale aus dem lingo-locale-Cookie gelesen und in diesen geschrieben wird.

Schritt 6. Ausführen der App

Um zu überprüfen, ob der Lingo.dev Compiler korrekt eingerichtet wurde:

Starten Sie den Entwicklungsserver:
```
npm run dev
```
Navigieren Sie zu localhost:3333.
Verwenden Sie die LocaleSwitcher-Komponente, um zwischen den Locales zu wechseln.

Die Seite sollte neu geladen werden und den lokalisierten Inhalt anzeigen.

Alternative: Manuelles Setzen von Cookies

Wenn Sie die LocaleSwitcher-Komponente nicht verwenden, können Sie alternativ überprüfen, ob die Lokalisierung funktioniert, indem Sie das lingo-locale-Cookie manuell setzen.

Wenn Sie Google Chrome verwenden, folgen Sie diesen Anweisungen:

Navigieren Sie zu Ansicht > Entwickler > Entwicklertools.
Gehen Sie zum Tab Anwendung.
Erweitern Sie in der linken Seitenleiste unter Speicher die Option Cookies und wählen Sie die URL der Website aus.
Klicken Sie in der Cookie-Tabelle mit der rechten Maustaste und wählen Sie Hinzufügen.
Geben Sie in der Spalte Name lingo-locale ein.
Geben Sie in der Spalte Wert die gewünschte Locale ein (z.B. es).
Drücken Sie Enter, um das Cookie zu speichern.
Aktualisieren Sie die Seite, um das Cookie anzuwenden.

Weiterführende Lektüre

Um zu verstehen, wie der Compiler funktioniert, siehe Funktionsweise.
Um zu lernen, wie man den Compiler konfiguriert, siehe Compiler-Optionen.