JSON5 - Lingo.dev CLI

Was ist JSON5?

JSON5 ist eine Erweiterung von JSON, die es für Menschen einfacher macht, manuell zu schreiben und zu pflegen. Es unterstützt Kommentare, Schlüssel ohne Anführungszeichen, nachgestellte Kommas und eine flexiblere Syntax, während es mit JavaScript kompatibel bleibt.

Zum Beispiel:

{
  // JSON5 allows comments!
  title: "Hello, world!",
  description: "A simple demo app with JSON5 features",

  // Unquoted keys are allowed
  author: {
    name: "John Doe",
  },

  messages: ["Welcome to MyApp", "Hello, world!"],

  // Trailing commas are allowed
  locked_key_1: "This value is locked and should not be changed",
}

Was ist Lingo.dev CLI?

Lingo.dev CLI ist ein kostenloses Open-Source-CLI-Tool zur Übersetzung von Apps und Inhalten mit KI. Es wurde entwickelt, um herkömmliche Translation-Management-Software zu ersetzen und sich gleichzeitig in bestehende Pipelines zu integrieren.

Weitere Informationen finden Sie unter Übersicht.

Über diesen Leitfaden

Dieser Leitfaden erklärt, wie Sie JSON5-Dateien mit Lingo.dev CLI übersetzen.

Sie lernen, wie Sie:

Ein Projekt von Grund auf erstellen
Eine Übersetzungs-Pipeline konfigurieren
Übersetzungen mit KI generieren

Voraussetzungen

Um Lingo.dev CLI zu verwenden, stellen Sie sicher, dass Node.js v18+ installiert ist:

❯ node -v
v22.17.0

Schritt 1. Projekt einrichten

Erstellen Sie im Verzeichnis Ihres Projekts eine Datei i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Diese Datei definiert das Verhalten der Übersetzungs-Pipeline, einschließlich der Sprachen, zwischen denen übersetzt werden soll, und wo sich die lokalisierbaren Inhalte im Dateisystem befinden.

Weitere Informationen zu den verfügbaren Eigenschaften finden Sie unter i18n.json.

Schritt 2. Quellsprache konfigurieren

Die Quellsprache ist die ursprüngliche Sprache und Region, in der Ihre Inhalte verfasst wurden. Um die Quellsprache zu konfigurieren, setzen Sie die Eigenschaft locale.source in der Datei i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Die Quellsprache muss als BCP 47 Language Tag angegeben werden.

Eine vollständige Liste der von der Lingo.dev CLI unterstützten Locale-Codes finden Sie unter Unterstützte Locale-Codes.

Schritt 3. Konfigurieren der Ziel-Locales

Die Ziel-Locales sind die Sprachen und Regionen, in die Sie Ihre Inhalte übersetzen möchten. Um die Ziel-Locales zu konfigurieren, setzen Sie die Eigenschaft locale.targets in der Datei i18n.json:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Schritt 4. Erstellen des Quellinhalts

Falls noch nicht geschehen, erstellen Sie eine oder mehrere JSON5-Dateien, die den zu übersetzenden Inhalt enthalten. Diese Dateien müssen sich an einem Pfad befinden, der die Quell-Locale irgendwo im Pfad enthält (z. B. als Verzeichnisname wie en/ oder als Teil des Dateinamens wie messages.en.json5).

Schritt 5. Erstellen eines Buckets

Fügen Sie in der Datei i18n.json ein "json5"Objekt zum bucketsObjekt hinzu:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json5": {}
  }
}

Definieren Sie im "json5"Objekt ein Array aus einem oder mehreren includeMustern:
```
{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json5": {
      "include": ["./[locale]/example.json5"]
    }
  }
}
```
Diese Muster definieren, welche Dateien übersetzt werden sollen.

Die Muster selbst:
- müssen [locale] als Platzhalter für die konfigurierte Locale enthalten
- können auf Dateipfade verweisen (z. B. "[locale]/config.json5")
- können Sternchen als Wildcard-Platzhalter verwenden (z. B. "[locale]/*.json5")
Rekursive Glob-Muster (z. B. **/*.json5) werden nicht unterstützt.

Schritt 6. Konfigurieren eines LLM

Die Lingo.dev CLI verwendet Large Language Models (LLMs), um Inhalte mit KI zu übersetzen. Um eines dieser Modelle zu verwenden, benötigen Sie einen API-Schlüssel von einem unterstützten Anbieter.

Um so schnell wie möglich loszulegen, empfehlen wir die Verwendung der Lingo.dev Engine – unserer eigenen, gehosteten Plattform, die 10.000 Tokens kostenlose monatliche Nutzung bietet:

Registrieren Sie sich für ein Lingo.dev-Konto.
Führen Sie den folgenden Befehl aus:
```
npx lingo.dev@latest login
```
Dies öffnet Ihren Standardbrowser und fordert Sie zur Authentifizierung auf.
Folgen Sie den Anweisungen.

Schritt 7. Übersetzungen generieren

Führen Sie im Verzeichnis, das die i18n.jsonDatei enthält, folgenden Befehl aus:

npx lingo.dev@latest run

Dieser Befehl:

Liest die i18n.jsonDatei.
Findet die Dateien, die übersetzt werden müssen.
Extrahiert den übersetzbaren Inhalt aus den Dateien.
Verwendet das konfigurierte LLM, um den extrahierten Inhalt zu übersetzen.
Schreibt den übersetzten Inhalt zurück in das Dateisystem.

Beim ersten Generieren von Übersetzungen wird eine i18n.lockDatei erstellt. Diese Datei verfolgt, welcher Inhalt übersetzt wurde, und verhindert unnötige erneute Übersetzungen bei nachfolgenden Durchläufen.

Beispiel

en/example.json5

{
  // JSON5 allows comments!
  title: "Hello, world!",
  description: "A simple demo app with JSON5 features",
  version: "1.0.0",
  support_email: "[email protected]",
  homepage: "https://lingo.dev",
  deprecated: null,
  empty: "",
  emoji: "🚀",

  // Unquoted keys are allowed
  author: {
    name: "John Doe",
  },

  contributors: [{ name: "Alice" }, { name: "Bob" }],

  messages: ["Welcome to MyApp", "Hello, world!"],

  config: {
    theme: {
      primary: "Blue theme",
    },
  },

  mixed_array: [
    "Mixed content here",
    42,
    true,
    {
      nested_message: "Nested text",
    },
  ],

  // Hexadecimal numbers work in JSON5
  hex_value: 0xdeadbeef,

  // Trailing commas are allowed
  locked_key_1: "This value is locked and should not be changed",
}

es/example.json5

{
  // JSON5 allows comments!
  title: "¡Hola, mundo!",
  description: "Una aplicación de demostración simple con características JSON5",
  version: "1.0.0",
  support_email: "[email protected]",
  homepage: "https://lingo.dev",
  deprecated: null,
  empty: "",
  emoji: "🚀",

  // Unquoted keys are allowed
  author: {
    name: "Juan Pérez",
  },

  contributors: [{ name: "Alicia" }, { name: "Roberto" }],

  messages: ["Bienvenido a MyApp", "¡Hola, mundo!"],

  config: {
    theme: {
      primary: "Tema azul",
    },
  },

  mixed_array: [
    "Contenido mixto aquí",
    42,
    true,
    {
      nested_message: "Texto anidado",
    },
  ],

  // Hexadecimal numbers work in JSON5
  hex_value: 0xdeadbeef,

  // Trailing commas are allowed
  locked_key_1: "This value is locked and should not be changed",
}

i18n.json

{
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json5": {
      "include": ["./[locale]/example.json5"],
      "lockedKeys": ["locked_key_1"]
    }
  },
  "$schema": "https://lingo.dev/schema/i18n.json"
}

i18n.lock

version: 1
checksums:
  455da9346f4e772000927cd2ff5bb898:
    title: 0468579ef2fbc83c9d520c2f2f1c5059
    description: 6f4922f45568161a8cdf4ad2299f6d23
    version: 54a9e730e88fb16291b852274d433923
    support_email: 10627fcc465897af0f5e1bba042685f9
    emoji: b328c432cee108a87a92f05258b6a651
    author/name: febee8e9ab40b2fe5106d72675228d00
    contributors/0/name: e80d4063a32adaad7b0a82b0bcc10551
    contributors/1/name: b2bca2fa3c890618e56d07473f26ead3
    messages/0: d1c3a9f35e377554a4ccaa467ca26614
    messages/1: 0468579ef2fbc83c9d520c2f2f1c5059
    config/theme/primary: 7535a3779d6934ea8ecf18f5cb5b93fd
    mixed_array/0: 001b5b003d96c133534f5907abffdf77
    mixed_array/3/nested_message: 5f0782dfc5993e99890c0475bc295a30
    hex_value: a1b2c3d4e5f6789012345678abcdef01