markmv/dist/types/operations.d.ts

TypeScript CLI for markdown file operations with intelligent link refactoring

/**
 * Base configuration options common to all file operations.
 *
 * Provides essential flags for controlling operation behavior including dry run mode, verbosity,
 * and force execution.
 *
 * @category Types
 */
export interface OperationOptions {
    /** Show what would be changed without making changes */
    dryRun?: boolean;
    /** Show detailed output */
    verbose?: boolean;
    /** Force operation even if conflicts exist */
    force?: boolean;
}
/**
 * Configuration options specific to move operations.
 *
 * Extends base operation options with move-specific settings such as directory creation behavior.
 *
 * @category Types
 */
export interface MoveOperationOptions extends OperationOptions {
    /** Create missing directories */
    createDirectories?: boolean;
}
/**
 * Configuration options specific to split operations.
 *
 * Extends base operation options with split-specific settings including strategy selection and
 * output configuration.
 *
 * @category Types
 */
export interface SplitOperationOptions extends OperationOptions {
    /** Strategy for splitting the file */
    strategy: 'headers' | 'size' | 'manual' | 'lines';
    /** Output directory for split files */
    outputDir: string;
    /** Maximum file size in KB (for size strategy) */
    maxSize?: number;
    /** Header level to split on (for headers strategy) */
    headerLevel?: number;
    /** Line numbers to split on (for lines strategy) */
    splitLines: number[] | undefined;
}
/**
 * Configuration options specific to join operations.
 *
 * Extends base operation options with join-specific settings including output path and ordering
 * strategy.
 *
 * @category Types
 */
export interface JoinOperationOptions extends OperationOptions {
    /** Output file path */
    output: string | undefined;
    /** Strategy for ordering joined content */
    orderStrategy?: 'alphabetical' | 'manual' | 'dependency' | 'chronological';
}
/**
 * Configuration options specific to merge operations.
 *
 * Extends base operation options with merge-specific settings including strategy selection and
 * content formatting.
 *
 * @category Types
 */
export interface MergeOperationOptions extends OperationOptions {
    /** Strategy for merging content */
    strategy: 'append' | 'prepend' | 'interactive';
    /** Separator between merged sections */
    separator?: string;
}
/**
 * Configuration options specific to convert operations.
 *
 * Extends base operation options with convert-specific settings for transforming link formats and
 * path resolution styles across markdown files.
 *
 * @category Types
 */
export interface ConvertOperationOptions extends OperationOptions {
    /** Target path resolution type */
    pathResolution?: 'absolute' | 'relative';
    /** Base path for relative path calculations */
    basePath?: string;
    /** Target link style format */
    linkStyle?: 'markdown' | 'claude' | 'combined' | 'wikilink';
    /** Whether to process files recursively */
    recursive?: boolean;
}
/**
 * Configuration options specific to barrel file operations.
 *
 * Extends base operation options with barrel-specific settings for generating themed content
 * aggregation files across multiple directories with pattern matching and metadata filtering.
 *
 * @category Types
 */
export interface BarrelOperationOptions extends OperationOptions {
    /** Output file path for the barrel file */
    output: string;
    /** Glob pattern for file matching */
    pattern: string;
    /** Custom title for the barrel file */
    title?: string;
    /** Custom description for the barrel file */
    description?: string;
    /** Metadata filtering criteria */
    filter?: Record<string, string>;
    /** Grouping strategy for results */
    groupBy?: 'directory' | 'metadata' | 'type' | 'none';
    /** Path to custom template file */
    template?: string;
    /** Maximum depth to traverse subdirectories */
    maxDepth?: number;
    /** Base directory to start scanning from */
    baseDir?: string;
    /** Whether to include file modification dates */
    includeModified?: boolean;
    /** Whether to include file sizes */
    includeSize?: boolean;
    /** Whether to track updates automatically */
    trackUpdates?: boolean;
}
/**
 * Result of any file operation containing comprehensive status information.
 *
 * Provides detailed information about what was changed, created, or deleted during an operation,
 * along with any errors or warnings encountered.
 *
 * @category Types
 *
 * @example
 *   Handling operation results
 *   ```typescript
 *   const result: OperationResult = await fileOps.moveFile('old.md', 'new.md');
 *
 *   if (result.success) {
 *   console.log(`Operation completed successfully`);
 *   console.log(`Modified ${result.modifiedFiles.length} files`);
 *   console.log(`Created ${result.createdFiles.length} files`);
 *   } else {
 *   console.error('Operation failed:');
 *   result.errors.forEach(error => console.error(`  ${error}`));
 *   }
 *   ```
 */
export interface OperationResult {
    /** Whether the operation was successful */
    success: boolean;
    /** Files that were modified */
    modifiedFiles: string[];
    /** Files that were created */
    createdFiles: string[];
    /** Files that were deleted */
    deletedFiles: string[];
    /** Any errors that occurred */
    errors: string[];
    /** Warnings */
    warnings: string[];
    /** Detailed changes made */
    changes: OperationChange[];
}
/**
 * Represents a specific change made during an operation.
 *
 * Provides detailed information about individual modifications including the type of change,
 * location, and before/after values.
 *
 * @category Types
 *
 * @example
 *   Analyzing operation changes
 *   ```typescript
 *   const changes: OperationChange[] = result.changes;
 *
 *   changes.forEach(change => {
 *   console.log(`${change.type} in ${change.filePath}`);
 *   if (change.line) {
 *   console.log(`  Line ${change.line}: ${change.oldValue} → ${change.newValue}`);
 *   }
 *   });
 *   ```
 */
export interface OperationChange {
    /** Type of change */
    type: 'file-moved' | 'file-created' | 'file-deleted' | 'link-updated' | 'content-modified';
    /** File path affected */
    filePath: string;
    /** Old value (for updates) */
    oldValue?: string;
    /** New value (for updates) */
    newValue?: string;
    /** Line number where change occurred */
    line?: number;
}
//# sourceMappingURL=operations.d.ts.map