Expand description
Workspace-wide index for cross-file analysis
This module provides infrastructure for rules that need to validate references across multiple files, such as MD051 which validates that cross-file link fragments point to valid headings.
The index is built in parallel and designed for minimal memory overhead.
§Cache Format
The workspace index can be persisted to disk for faster startup on repeated runs. The cache format includes a version header to detect incompatible format changes:
[4 bytes: magic "RWSI" - Rumdl Workspace Index]
[4 bytes: format version (u32 little-endian)]
[N bytes: postcard-serialized WorkspaceIndex]Structs§
- Cross
File Link Index - Information about a cross-file link for validation
- Extracted
Cross File Links - Markdown file links extracted from a document, split by how they resolve.
- File
Index - Index data extracted from a single file
- Heading
Index - Information about a heading for cross-file lookup
- Reference
Link Index - Information about a reference link for cross-file analysis
- Vulnerable
Anchor - Information about a vulnerable anchor (heading without custom ID)
- Workspace
Index - Workspace-wide index for cross-file analysis
Functions§
- extract_
cross_ file_ links - Extract cross-file links from content using correct regex-based position tracking.