Konfiguration

Repomix kann über eine Konfigurationsdatei oder Kommandozeilenoptionen konfiguriert werden. Die Konfigurationsdatei ermöglicht es Ihnen, die Verarbeitung und Ausgabe Ihres Codes anzupassen.

Konfigurationsdateiformate

Repomix unterstützt mehrere Konfigurationsdateiformate für Flexibilität und Benutzerfreundlichkeit.

Repomix sucht automatisch nach Konfigurationsdateien in der folgenden Prioritätsreihenfolge:

1. TypeScript (repomix.config.ts, repomix.config.mts, repomix.config.cts)
2. JavaScript/ES Module (repomix.config.js, repomix.config.mjs, repomix.config.cjs)
3. JSON (repomix.config.json5, repomix.config.jsonc, repomix.config.json)

JSON-Konfiguration

Erstellen Sie eine Konfigurationsdatei in Ihrem Projektverzeichnis:

repomix --init

Dies erstellt eine repomix.config.json-Datei mit Standardeinstellungen. Sie können auch eine globale Konfigurationsdatei erstellen, die als Fallback verwendet wird, wenn keine lokale Konfiguration gefunden wird:

repomix --init --global

TypeScript-Konfiguration

TypeScript-Konfigurationsdateien bieten die beste Entwicklererfahrung mit vollständiger Typüberprüfung und IDE-Unterstützung.

Installation:

Um TypeScript- oder JavaScript-Konfiguration mit defineConfig zu verwenden, müssen Sie Repomix als Entwicklungsabhängigkeit installieren:

npm install -D repomix

Beispiel:

// repomix.config.ts

  output: {
    filePath: 'output.xml',
    style: 'xml',
    removeComments: true,
  },
  ignore: {
    customPatterns: ['**/node_modules/**', '**/dist/**'],
  },
});

Vorteile:

• ✅ Vollständige TypeScript-Typüberprüfung in Ihrer IDE
• ✅ Hervorragende IDE-Autovervollständigung und IntelliSense
• ✅ Verwendung dynamischer Werte (Zeitstempel, Umgebungsvariablen usw.)

Beispiel für dynamische Werte:

// repomix.config.ts

// Zeitstempel-basierten Dateinamen generieren
const timestamp = new Date().toISOString().slice(0, 19).replace(/[:.]/g, '-');

  output: {
    filePath: `output-${timestamp}.xml`,
    style: 'xml',
  },
});

JavaScript-Konfiguration

JavaScript-Konfigurationsdateien funktionieren genauso wie TypeScript und unterstützen defineConfig und dynamische Werte.

Konfigurationsoptionen

Die Konfigurationsdatei unterstützt JSON5-Syntax, die Folgendes erlaubt:

• Kommentare (einzeilig und mehrzeilig)
• Nachfolgende Kommas in Objekten und Arrays
• Unquotierte Eigenschaftsnamen
• Flexiblere String-Syntax

Schema-Validierung

Sie können die Schema-Validierung für Ihre Konfigurationsdatei aktivieren, indem Sie die Eigenschaft $schema hinzufügen:

{
  "$schema": "https://repomix.com/schemas/latest/schema.json",
  "output": {
    "filePath": "repomix-output.md",
    "style": "markdown"
  }
}

Dies bietet Autovervollständigung und Validierung in Editoren, die JSON-Schema unterstützen.

Beispiel-Konfigurationsdatei

Hier ist ein Beispiel einer vollständigen Konfigurationsdatei (repomix.config.json):

{
  "$schema": "https://repomix.com/schemas/latest/schema.json",
  "input": {
    "maxFileSize": 50000000
  },
  "output": {
    "filePath": "repomix-output.xml",
    "style": "xml",
    "parsableStyle": false,
    "compress": false,
    "headerText": "Benutzerdefinierte Header-Informationen für die gepackte Datei",
    "fileSummary": true,
    "directoryStructure": true,
    "files": true,
    "removeComments": false,
    "removeEmptyLines": false,
    "topFilesLength": 5,
    "showLineNumbers": false,
    "truncateBase64": false,
    "copyToClipboard": false,
    "includeEmptyDirectories": false,
    "git": {
      "sortByChanges": true,
      "sortByChangesMaxCommits": 100,
      "includeDiffs": false,
      "includeLogs": false,
      "includeLogsCount": 50
    }
  },
  "include": ["**/*"],
  "ignore": {
    "useGitignore": true,
    "useDefaultPatterns": true,
    // Muster können auch in .repomixignore angegeben werden
    "customPatterns": [
      "additional-folder",
      "**/*.log"
    ],
  },
  "security": {
    "enableSecurityCheck": true
  },
  "tokenCount": {
    "encoding": "o200k_base"
  }
}

Speicherorte der Konfigurationsdatei

Repomix sucht in folgender Reihenfolge nach Konfigurationsdateien:

1. Lokale Konfigurationsdatei im aktuellen Verzeichnis (Priorität: TS > JS > JSON)
   • TypeScript: repomix.config.ts, repomix.config.mts, repomix.config.cts
   • JavaScript: repomix.config.js, repomix.config.mjs, repomix.config.cjs
   • JSON: repomix.config.json5, repomix.config.jsonc, repomix.config.json
2. Globale Konfigurationsdatei (Priorität: TS > JS > JSON)
   • Windows:
     • TypeScript: %LOCALAPPDATA%\\Repomix\\repomix.config.ts, .mts, .cts
     • JavaScript: %LOCALAPPDATA%\\Repomix\\repomix.config.js, .mjs, .cjs
     • JSON: %LOCALAPPDATA%\\Repomix\\repomix.config.json5, .jsonc, .json
   • macOS/Linux:
     • TypeScript: ~/.config/repomix/repomix.config.ts, .mts, .cts
     • JavaScript: ~/.config/repomix/repomix.config.js, .mjs, .cjs
     • JSON: ~/.config/repomix/repomix.config.json5, .jsonc, .json

Kommandozeilenoptionen haben Vorrang vor Einstellungen in der Konfigurationsdatei.

Include-Muster

Repomix unterstützt die Angabe einzuschließender Dateien mittels Glob-Mustern. Dies ermöglicht eine flexiblere und leistungsfähigere Dateiauswahl:

• Verwenden Sie **/*.js, um alle JavaScript-Dateien in jedem Verzeichnis einzuschließen
• Verwenden Sie src/**/*, um alle Dateien innerhalb des src-Verzeichnisses und seiner Unterverzeichnisse einzuschließen
• Kombinieren Sie mehrere Muster wie ["src/**/*.js", "**/*.md"], um JavaScript-Dateien in src und alle Markdown-Dateien einzuschließen

Sie können Include-Muster in Ihrer Konfigurationsdatei angeben:

{
  "include": ["src/**/*", "tests/**/*.test.js"]
}

Oder verwenden Sie die Kommandozeilenoption --include für einmaliges Filtern.

Ignorier-Muster

Repomix bietet mehrere Methoden zum Festlegen von Ignorier-Mustern, um bestimmte Dateien oder Verzeichnisse während des Packprozesses auszuschließen:

• .gitignore: Standardmäßig werden die in den .gitignore-Dateien und .git/info/exclude Ihres Projekts aufgelisteten Muster verwendet. Dieses Verhalten kann über die Einstellung ignore.useGitignore oder die CLI-Option --no-gitignore gesteuert werden.
• .ignore: Sie können eine .ignore-Datei im Stammverzeichnis Ihres Projekts verwenden, die dem gleichen Format wie .gitignore folgt. Diese Datei wird von Tools wie ripgrep und the silver searcher respektiert und reduziert die Notwendigkeit, mehrere Ignorier-Dateien zu pflegen. Dieses Verhalten kann über die Einstellung ignore.useDotIgnore oder die CLI-Option --no-dot-ignore gesteuert werden.
• Standardmuster: Repomix enthält eine Standardliste häufig ausgeschlossener Dateien und Verzeichnisse (z.B. node_modules, .git, Binärdateien). Diese Funktion kann über die Einstellung ignore.useDefaultPatterns oder die CLI-Option --no-default-patterns gesteuert werden. Weitere Details finden Sie in defaultIgnore.ts.
• .repomixignore: Sie können eine .repomixignore-Datei in Ihrem Projektstamm erstellen, um Repomix-spezifische Ignorier-Muster zu definieren. Diese Datei folgt dem gleichen Format wie .gitignore.
• Benutzerdefinierte Muster: Zusätzliche Ignorier-Muster können über die Option ignore.customPatterns in der Konfigurationsdatei angegeben werden. Sie können diese Einstellung mit der Kommandozeilenoption -i, --ignore überschreiben.

Prioritätsreihenfolge (von höchster zu niedrigster):

1. Benutzerdefinierte Muster (ignore.customPatterns)
2. Ignorier-Dateien (.repomixignore, .ignore, .gitignore und .git/info/exclude):
   • Bei verschachtelten Verzeichnissen haben Dateien in tieferen Verzeichnissen höhere Priorität
   • Bei Dateien im selben Verzeichnis werden diese ohne bestimmte Reihenfolge zusammengeführt
3. Standardmuster (wenn ignore.useDefaultPatterns true ist und --no-default-patterns nicht verwendet wird)

Dieser Ansatz ermöglicht eine flexible Konfi