UNPKG

markmv

Version:

TypeScript CLI for markdown file operations with intelligent link refactoring

46 lines 1.65 kB
/** * Configuration options for convert command operations. * * Controls the behavior of the convert command including target formats and processing options. * * @category Commands */ export interface ConvertOptions { /** Target path resolution type */ pathResolution?: 'absolute' | 'relative'; /** Base path for relative path calculations */ basePath?: string; /** Target link style format */ linkStyle?: 'markdown' | 'claude' | 'combined' | 'wikilink'; /** Perform a dry run without making actual changes */ dryRun?: boolean; /** Enable verbose output with detailed progress information */ verbose?: boolean; /** Process directories recursively */ recursive?: boolean; } /** * CLI command handler for convert operations. * * Processes markdown files to convert link formats and path resolution according to specified * options. Supports dry run mode, verbose output, and various conversion strategies. * * @example * ```bash * # Convert all links to relative paths * markmv convert docs/star.md --path-resolution relative * * # Convert to wikilink style with absolute paths * markmv convert starstar/star.md --link-style wikilink --path-resolution absolute * * # Dry run with verbose output * markmv convert README.md --link-style claude --dry-run --verbose * ```; * * @param patterns - File patterns to process (supports globs) * @param options - Command options specifying conversion parameters * * @group Commands */ export declare function convertCommand(patterns: string[], options: ConvertOptions): Promise<void>; //# sourceMappingURL=convert.d.ts.map