Intlayer Konfigurationsdokumentation

import { Locales, type IntlayerConfig } from "intlayer";import { nextjsRewrite } from "intlayer/routing";import { z } from "zod";/** * Beispiel für eine Intlayer-Konfigurationsdatei, die alle verfügbaren Optionen zeigt. */const config: IntlayerConfig = {  /**   * Konfiguration für Internationalisierungseinstellungen.   */  internationalization: {    /**     * Liste der unterstützten Sprachen in der Anwendung.     * Standard: [Locales.ENGLISH]     */    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    /**     * Liste der erforderlichen Sprachen, die in jedem Wörterbuch definiert sein müssen.     * Wenn leer, sind im `strict` Modus alle Sprachen erforderlich.     * Standard: []     */    requiredLocales: [Locales.ENGLISH],    /**     * Strengegrad für internationalisierte Inhalte.     * - "strict": Fehler, wenn eine deklarierte Sprache fehlt oder nicht deklariert ist.     * - "inclusive": Warnungen, wenn eine deklarierte Sprache fehlt.     * - "loose": Akzeptiert jede vorhandene Sprache.     * Standard: "inclusive"     */    strictMode: "inclusive",    /**     * Standardsprache, die als Fallback verwendet wird, wenn die angeforderte Sprache nicht gefunden wird.     * Standard: Locales.ENGLISH     */    defaultLocale: Locales.ENGLISH,  },  /**   * Einstellungen, die Wörterbuchoperationen und Fallback-Verhalten steuern.   */  dictionary: {    /**     * Steuert, wie Wörterbücher importiert werden.     * - "static": Statisch zur Build-Zeit importiert.     * - "dynamic": Dynamisch mit Suspense importiert.     * - "fetch": Dynamisch über die Live Sync API abgerufen.     * Standard: "static"     */    importMode: "static",    /**     * Strategie für das automatische Ausfüllen fehlender Übersetzungen mittels KI.     * Kann ein boolescher Wert oder ein Pfadmuster zum Speichern der ausgefüllten Inhalte sein.     * Standard: true     */    fill: true,    /**     * Physischer Speicherort der Wörterbuchdateien.     * - "local": Im lokalen Dateisystem gespeichert.     * - "remote": Im Intlayer CMS gespeichert.     * - "hybrid": Im lokalen Dateisystem und im Intlayer CMS gespeichert.     * - "plugin" (oder ein beliebiger benutzerdefinierter String): Von einem Plugin oder einer benutzerdefinierten Quelle bereitgestellt.     * Standard: "local"     */    location: "local",    /**     * Ob Inhalte automatisch transformiert werden sollen (z. B. Markdown zu HTML).     * Standard: false     */    contentAutoTransformation: false,  },  /**   * Routing- und Middleware-Konfiguration.   */  routing: {    /**     * Strategie für das Sprachrouting.     * - "prefix-no-default": Präfix für alle außer der Standardsprache (z. B. /dashboard, /fr/dashboard).     * - "prefix-all": Präfix für alle Sprachen (z. B. /en/dashboard, /fr/dashboard).     * - "no-prefix": Keine Sprache in der URL.     * - "search-params": Verwendung von ?locale=...     * Standard: "prefix-no-default"     */    mode: "prefix-no-default",    /**     * Wo die vom Benutzer gewählte Sprache gespeichert werden soll.     * Optionen: 'cookie', 'localStorage', 'sessionStorage', 'header' oder ein Array davon.     * Standard: ['cookie', 'header']     */    storage: ["cookie", "header"],    /**     * Basispfad für die Anwendungs-URLs.     * Standard: ""     */    basePath: "",    /**     * Benutzerdefinierte URL-Rewrite-Regeln für sprachspezifische Pfade.     */    rewrite: nextjsRewrite({      "/[locale]/about": {        en: "/[locale]/about",        fr: "/[locale]/a-propos",      },    }),    /**     * Verknüpft Sprachen mit Domain-Hostnamen für domainbasiertes Routing.     * URLs für diese Sprachen sind absolut (z. B. https://intlayer.cn/).     * Die Domain impliziert die Sprache, daher wird dem Pfad kein Sprachpräfix hinzugefügt.     * Standard: undefined     */    domains: {      en: "intlayer.org",      zh: "intlayer.cn",    },  },  /**   * Einstellungen zum Finden und Verarbeiten von Inhaltsdateien.   */  content: {    /**     * Dateierweiterungen, nach denen nach Wörterbüchern gesucht wird.     * Standard: ['.content.ts', '.content.js', '.content.json', etc.]     */    fileExtensions: [".content.ts", ".content.js", ".content.json"],    /**     * Verzeichnisse, in denen sich .content-Dateien befinden.     * Standard: ["."]     */    contentDir: ["src"],    /**     * Verzeichnisse, in denen sich der Quellcode befindet.     * Wird für Build-Optimierung und Codetransformation verwendet.     * Standard: ["."]     */    codeDir: ["src"],    /**     * Muster, die vom Scannen ausgeschlossen werden sollen.     * Standard: ['node_modules', '.intlayer', etc.]     */    excludedPath: ["node_modules"],    /**     * Ob Änderungen überwacht und Wörterbücher während der Entwicklung neu erstellt werden sollen.     * Standard: true in der Entwicklung     */    watch: true,    /**     * Befehl zum Formatieren neu erstellter / aktualisierter .content-Dateien.     */    formatCommand: 'npx prettier --write "{{file}}"',  },  /**   * Konfiguration des visuellen Editors.   */  editor: {    /**     * Ob der visuelle Editor aktiviert ist.     * Standard: false     */    enabled: true,    /**     * URL Ihrer Anwendung zur Validierung der Herkunft.     * Standard: ""     */    applicationURL: "http://localhost:3000",    /**     * Port für den lokalen Editor-Server.     * Standard: 8000     */    port: 8000,    /**     * Öffentliche URL für den Editor.     * Standard: "http://localhost:8000"     */    editorURL: "http://localhost:8000",    /**     * Intlayer CMS URL.     * Standard: "https://app.intlayer.org"     */    cmsURL: "https://app.intlayer.org",    /**     * Backend API URL.     * Standard: "https://back.intlayer.org"     */    backendURL: "https://back.intlayer.org",    /**     * Ob Echtzeit-Inhaltssynchronisierung aktiviert werden soll.     * Standard: false     */    liveSync: true,  },  /**   * KI-gestützte Übersetzungs- und Generierungseinstellungen.   */  ai: {    /**     * Zu verwendender KI-Anbieter.     * Optionen: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio'     * Standard: 'openai'     */    provider: "openai",    /**     * Zu verwendendes Modell des ausgewählten Anbieters.     */    model: "gpt-4o",    /**     * API-Schlüssel des Anbieters.     */    apiKey: process.env.OPENAI_API_KEY,    /**     * Globaler Kontext, um die KI beim Generieren von Übersetzungen zu unterstützen.     */    applicationContext: "Dies ist eine Reisebuchungsanwendung.",    /**     * Basis-URL für die KI-API.     */    baseURL: "http://localhost:3000",    /**     * Datenserialisierung     *     * Optionen:     * - "json": Standard, zuverlässig; verbraucht mehr Tokens.     * - "toon": Weniger Tokens, weniger konsistent als JSON.     *     * Standard: "json"     */    dataSerialization: "json",  },  /**   * Build- und Optimierungseinstellungen.   */  build: {    /**     * Modus der Build-Ausführung.     * - "auto": Automatischer Build während des App-Builds.     * - "manual": Erfordert einen expliziten Build-Befehl.     * Standard: "auto"     */    mode: "auto",    /**     * Ob das finale Bundle durch Entfernen ungenutzter Wörterbücher optimiert werden soll.     * Standard: true in der Produktion     */    optimize: true,    /**     * Dictionarien minimieren, um die Bundle-Größe zu reduzieren.     * Standard: false     *     * Note:     * - Diese Option wird ignoriert, wenn `optimize` deaktiviert ist.     * - Diese Option wird ignoriert, wenn `editor.enabled` auf true gesetzt ist.     */    minify: true,    /**     * Nicht verwendete Schlüssel in Dictionarien entfernen.     * Standard: false     *     * Note:     * - Diese Option wird ignoriert, wenn `optimize` deaktiviert ist.     */    purge: true,    /**     * Ausgabeformat für generierte Wörterbuchdateien.     * Standard: ['cjs', 'esm']     */    outputFormat: ["cjs", "esm"],    /**     * Gibt an, ob der Build TypeScript-Typen prüfen soll.     * Standard: false     */    checkTypes: false,  },  /**   * Logger-Konfiguration.   */  log: {    /**     * Logging-Level.     * - "default": Standard-Logging.     * - "verbose": Detailliertes Debug-Logging.     * - "disabled": Kein Logging.     * Standard: "default"     */    mode: "default",    /**     * Präfix für alle Log-Nachrichten.     * Standard: "[intlayer]"     */    prefix: "[intlayer]",  },  /**   * Systemkonfiguration (Erweiterte Anwendungsfälle)   */  system: {    /**     * Verzeichnis zum Speichern lokalisierter Wörterbücher.     */    dictionariesDir: ".intlayer/dictionary",    /**     * Verzeichnis für die Modul-Augmentierung.     */    moduleAugmentationDir: ".intlayer/types",    /**     * Verzeichnis zum Speichern nicht zusammengeführter Wörterbücher.     */    unmergedDictionariesDir: ".intlayer/unmerged_dictionary",    /**     * Verzeichnis zum Speichern von Wörterbuchtypen.     */    typesDir: ".intlayer/types",    /**     * Verzeichnis, in dem die Hauptanwendungsdateien gespeichert sind.     */    mainDir: ".intlayer/main",    /**     * Verzeichnis, in dem die Konfigurationsdateien gespeichert sind.     */    configDir: ".intlayer/config",    /**     * Verzeichnis, in dem die Cache-Dateien gespeichert sind.     */    cacheDir: ".intlayer/cache",  },  /**   * Compiler-Konfiguration (Erweiterte Anwendungsfälle)   */  compiler: {    /**     * Gibt an, ob der Compiler aktiviert sein soll.     *     * - false: Compiler deaktivieren.     * - true: Compiler aktivieren.     * - "build-only": Compiler während der Entwicklung überspringen, um Startzeiten zu beschleunigen.     *     * Standard: false     */    enabled: true,    /**     * Definiert den Pfad für die Ausgabedateien. Ersetzt `outputDir`.     *     * - `./` Pfade werden relativ zum Komponentenverzeichnis aufgelöst.     * - `/` Pfade werden relativ zum Projektstamm (`baseDir`) aufgelöst.     *     * - Wenn die Variable `{{locale}}` im Pfad enthalten ist, wird die Generierung separater Wörterbücher pro Sprache ausgelöst.     *     * Beispiel:     * ```ts     * {     *   // Mehrsprachige .content.ts Dateien in der Nähe der Komponente erstellen     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,     *     *   // output: './{{fileName}}{{extension}}', // Äquivalent mit Template-String     * }     * ```     *     * ```ts     * {     *   // Zentralisierte pro-Sprache JSON-Dateien im Stammverzeichnis des Projekts erstellen     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,     *     *   // output: '/locales/{{locale}}/{{key}}.content.json', // Äquivalent mit Template-String     * }     * ```     *     * Liste der Variablen:     *   - `fileName`: Name der Datei.     *   - `key`: Schlüssel des Inhalts.     *   - `locale`: Sprache des Inhalts.     *   - `extension`: Erweiterung der Datei.     *   - `componentFileName`: Name der Komponentendatei.     *   - `componentExtension`: Erweiterung der Komponentendatei.     *   - `format`: Format des Wörterbuchs.     *   - `componentFormat`: Format des Komponentenwörterbuchs.     *   - `componentDirPath`: Verzeichnispfad der Komponente.     */    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,    /**     * Gibt an, ob die Komponenten nach der Transformation gespeichert werden sollen.     *     * - Wenn `true`, schreibt der Compiler die Komponentendatei auf die Festplatte um. Die Transformation ist also dauerhaft und der Compiler überspringt die Transformation für den nächsten Prozess. Auf diese Weise kann der Compiler die App transformieren und anschließend entfernt werden.     *     * - Wenn `false`, fügt der Compiler den `useIntlayer()` Funktionsaufruf nur in den Code der Build-Ausgabe ein und lässt die Basis-Code-Basis intakt. Die Transformation erfolgt nur im Speicher.     */    saveComponents: false,    /**     * Nur Inhalte in die generierte Datei einfügen. Nützlich für pro-Sprache i18next oder ICU MessageFormat JSON-Ausgaben.     */    noMetadata: false,    /**     * Wörterbuch-Schlüsselpräfix     */    dictionaryKeyPrefix: "", // Optionales Präfix für die extrahierten Wörterbuchschlüssel hinzufügen  },  /**   * Benutzerdefinierte Schemata zum Validieren des Inhalts der Wörterbücher.   */  schemas: {    "my-schema": z.object({      title: z.string(),    }),  },  /**   * Plugin-Konfiguration.   */  plugins: [],};export default config;

routing: {  mode: "prefix-no-default", // Fallback-Strategie  rewrite: nextjsRewrite({    "/about": {      en: "/about",      fr: "/a-propos",    },    "/product/[slug]": {      en: "/product/[slug]",      fr: "/produit/[slug]",    },    "/blog/[category]/[id]": {      en: "/blog/[category]/[id]",      fr: "/journal/[category]/[id]",    },  }),}

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: [      {        type: "localStorage",        name: "user-locale",      },      {        type: "cookie",        name: "user-locale",        secure: true,        sameSite: "strict",        httpOnly: false,      },    ],    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "search-params",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "no-prefix",    storage: {      type: "sessionStorage",      name: "app-locale",    },    basePath: "/my-app",  },};export default config;

// intlayer.config.tsimport { nextjsRewrite } from "intlayer/routing";const config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default", // Fallback für nicht umgeschriebene Pfade    storage: "cookie",    rewrite: nextjsRewrite({      "/about": {        en: "/about",        fr: "/a-propos",      },      "/product/[slug]": {        en: "/product/[slug]",        fr: "/produit/[slug]",      },      "/blog/[category]/[id]": {        en: "/blog/[category]/[id]",        fr: "/journal/[category]/[id]",      },    }),  },};export default config;

dictionary: {  fill: {    en: "/locales/en/{{key}}.content.json",    fr: ({ key }) => `/locales/fr/${key}.content.json`,    es: false,  },};