markmv - v1.39.2
    Preparing search index...

    Class FileOperations

    Index
    • Move a file (markdown, or a non-markdown asset such as an image) and update all links that reference it.

      This method performs an intelligent move operation that:

      1. Validates the source and destination paths
      2. Discovers all files that link to the source file
      3. Updates all cross-references to maintain link integrity
      4. If the source is markdown, also updates any links inside the moved file itself
      5. Optionally performs a dry run to preview changes

      A non-markdown source (an image, for example) is moved as-is; only the markdown files that link to it are updated, since it has no markdown links of its own to refactor.

      Parameters

      • sourcePath: string

        The current path of the file to move

      • destinationPath: string

        The target path (can be a directory)

      • options: MoveOperationOptions = {}

        Configuration options for the move operation

      Returns Promise<OperationResult>

      Promise resolving to detailed operation results

        const fileOps = new FileOperations();

      // Simple move
      await fileOps.moveFile('docs/old.md', 'docs/new.md');

      // Move to directory (filename preserved)
      await fileOps.moveFile('guide.md', './docs/');

      // Move a linked image, updating any markdown files that reference it
      await fileOps.moveFile('image.png', 'assets/image.png');

      // Dry run with verbose output
      const result = await fileOps.moveFile('api.md', 'reference/api.md', {
      dryRun: true,
      verbose: true
      });
    • Validate the integrity of links after an operation

      Parameters

      Returns Promise<{ valid: boolean; brokenLinks: number; errors: string[] }>