Configuración

Repomix puede configurarse mediante un archivo de configuración o opciones de línea de comandos. El archivo de configuración le permite personalizar varios aspectos de cómo se procesa y genera la salida de su base de código.

Formatos de archivos de configuración

Repomix admite múltiples formatos de archivos de configuración para mayor flexibilidad y facilidad de uso.

Repomix buscará automáticamente archivos de configuración en el siguiente orden de prioridad:

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)

Configuración JSON

Cree un archivo de configuración en el directorio de su proyecto:

repomix --init

Esto creará un archivo repomix.config.json con la configuración predeterminada. También puede crear un archivo de configuración global que se utilizará como respaldo cuando no se encuentre una configuración local:

repomix --init --global

Configuración TypeScript

Los archivos de configuración TypeScript ofrecen la mejor experiencia de desarrollo con verificación completa de tipos y soporte IDE.

Instalación:

Para usar la configuración TypeScript o JavaScript con defineConfig, debe instalar Repomix como dependencia de desarrollo:

npm install -D repomix

Ejemplo:

// repomix.config.ts

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

Ventajas:

• ✅ Verificación completa de tipos TypeScript en su IDE
• ✅ Excelente autocompletado e IntelliSense del IDE
• ✅ Uso de valores dinámicos (marcas de tiempo, variables de entorno, etc.)

Ejemplo de valores dinámicos:

// repomix.config.ts

// Generar nombre de archivo basado en marca de tiempo
const timestamp = new Date().toISOString().slice(0, 19).replace(/[:.]/g, '-');

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

Configuración JavaScript

Los archivos de configuración JavaScript funcionan igual que TypeScript, admitiendo defineConfig y valores dinámicos.

Opciones de configuración

El archivo de configuración admite la sintaxis JSON5, que permite:

• Comentarios (tanto de una línea como multilínea)
• Comas finales en objetos y arrays
• Nombres de propiedades sin comillas
• Sintaxis de cadena más flexible

Validación de esquema

Puede habilitar la validación de esquema para su archivo de configuración agregando la propiedad $schema:

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

Esto proporciona autocompletado y validación en editores que admiten esquemas JSON.

Ejemplo de archivo de configuración

Aquí hay un ejemplo de un archivo de configuración completo (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": "Información de encabezado personalizada para el archivo empaquetado.",
    "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,
    // Los patrones también se pueden especificar en .repomixignore
    "customPatterns": [
      "additional-folder",
      "**/*.log"
    ],
  },
  "security": {
    "enableSecurityCheck": true
  },
  "tokenCount": {
    "encoding": "o200k_base"
  }
}

Ubicaciones de los archivos de configuración

Repomix busca los archivos de configuración en el siguiente orden:

1. Archivo de configuración local en el directorio actual (orden de prioridad: 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. Archivo de configuración global (orden de prioridad: 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

Las opciones de línea de comandos tienen prioridad sobre la configuración del archivo.

Patrones de inclusión

Repomix admite especificar archivos para incluir usando patrones glob. Esto permite una selección de archivos más flexible y potente:

• Use **/*.js para incluir todos los archivos JavaScript en cualquier directorio
• Use src/**/* para incluir todos los archivos dentro del directorio src y sus subdirectorios
• Combine múltiples patrones como ["src/**/*.js", "**/*.md"] para incluir archivos JavaScript en src y todos los archivos Markdown

Puede especificar patrones de inclusión en su archivo de configuración:

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

O use la opción de línea de comandos --include para filtrado único.

Patrones de ignorar

Repomix ofrece múltiples métodos para establecer patrones de ignorar para excluir archivos o directorios específicos durante el proceso de empaquetado:

• .gitignore: Por defecto, se utilizan los patrones listados en los archivos .gitignore de su proyecto y .git/info/exclude. Este comportamiento se puede controlar con la configuración ignore.useGitignore o la opción CLI --no-gitignore.
• .ignore: Puede usar un archivo .ignore en la raíz de su proyecto, siguiendo el mismo formato que .gitignore. Este archivo es respetado por herramientas como ripgrep y the silver searcher, reduciendo la necesidad de mantener múltiples archivos de ignorar. Este comportamiento se puede controlar con la configuración ignore.useDotIgnore o la opción CLI --no-dot-ignore.
• Patrones predeterminados: Repomix incluye una lista predeterminada de archivos y directorios comúnmente excluidos (por ejemplo, node_modules, .git, archivos binarios). Esta característica se puede controlar con la configuración ignore.useDefaultPatterns o la opción CLI --no-default-patterns. Consulte defaultIgnore.ts para más detalles.
• .repomixignore: Puede crear un archivo .repomixignore en la raíz de su proyecto para definir patrones de ignorar específicos de Repomix. Este archivo sigue el mismo formato que .gitignore.
• Patrones personalizados: Se pueden especificar patrones de ignorar adicionales usando la opción ignore.customPatterns en el archivo de configuración. Puede sobrescribir esta configuración con la opción de línea de comandos -i, --ignore.

Orden de prioridad (de mayor a menor):

1. Patrones personalizados (ignore.customPatterns)
2. Archivos de ignorar (.repomixignore, .ignore, .gitignore y .git/info/exclude):
   • Cuando están en directorios anidados, los archivos en directorios más profundos tienen mayor prioridad
   • Cuando están en el mismo directorio, estos archivos se fusionan sin un orden particular
3. Patrones predeterminados (si