ZipOptions Type — mcp Architecture

Source Code

src/utils/zip-repository.ts lines 101–154

export interface ZipOptions {
  /** Maximum ZIP size in bytes (default: 500MB) */
  maxSizeBytes?: number;

  /** Custom patterns to exclude (in addition to standard exclusions) */
  additionalExclusions?: string[];

  /**
   * Whether to include .gitignore files in the ZIP archive (default: true)
   *
   * Set to false to exclude all .gitignore files from the archive.
   * This can be useful for:
   * - Reducing archive size when .gitignore files are not needed for analysis
   * - Security: preventing exposure of ignore patterns that might reveal project structure
   *
   * Note: This only controls whether .gitignore files themselves are included.
   * The patterns defined in .gitignore files are always respected regardless of this setting.
   *
   * Default: true (maintains backward compatibility)
   */
  includeGitignore?: boolean;

  /**
   * Optional callback to track progress during ZIP creation.
   * Called approximately every 100 files (configurable via progressInterval).
   *
   * @param stats - Progress statistics
   * @param stats.filesProcessed - Number of files added to archive so far
   * @param stats.currentFile - Path of the current file being processed (relative to repository root)
   * @param stats.bytesProcessed - Total bytes processed across all files
   *
   * @example
   * ```typescript
   * await zipRepository('/path/to/repo', {
   *   onProgress: (stats) => {
   *     console.log(`Processed ${stats.filesProcessed} files (${formatBytes(stats.bytesProcessed)})`);
   *     console.log(`Current file: ${stats.currentFile}`);
   *   }
   * });
   * ```
   */
  onProgress?: (stats: {
    filesProcessed: number;
    currentFile: string;
    bytesProcessed: number;
  }) => void;

  /**
   * Number of files to process between progress callbacks (default: 100).
   * Lower values provide more frequent updates but with slight overhead.
   * Only used when onProgress is provided.
   */
  progressInterval?: number;
}