Struct MDBOOK007

pub struct MDBOOK007 { /* private fields */ }

MDBOOK007: Validate include file paths and existence

This rule validates that all include directives in markdown files point to existing files with correct syntax. It prevents build failures and broken includes by checking:

The rule:

• Finds all include directive patterns in markdown content
• Resolves include paths relative to the source file
• Validates target files exist and are readable
• Checks line range syntax and bounds where applicable
• Verifies anchor references exist in target files
• Detects circular include dependencies
• Provides clear error messages for debugging

Include Directive Formats Supported:

• Basic file includes: {{#include file.txt}}
• Line ranges: {{#include file.rs:10:20}}
• Named anchors: {{#include file.rs:anchor_name}}
• Relative paths: {{#include ../other/file.md}}
• Rust-specific: {{#rustdoc_include file.rs}}

Trait Implementations

impl AstRule for MDBOOK007

fn id(&self) -> &'static str

Unique identifier for the rule (e.g., “MD001”)

fn name(&self) -> &'static str

Human-readable name for the rule (e.g., “heading-increment”)

fn description(&self) -> &'static str

Description of what the rule checks

fn metadata(&self) -> RuleMetadata

Metadata about this rule’s status and properties

fn check_ast<'a>( &self, document: &Document, _ast: &'a AstNode<'a>, ) -> Result<Vec<Violation>>

Check a document using its AST

fn can_fix(&self) -> bool

Whether this rule can automatically fix violations

fn fix(&self, _content: &str, _violation: &Violation) -> Option<String>

Attempt to fix a violation (if supported)

fn create_violation( &self, message: String, line: usize, column: usize, severity: Severity, ) -> Violation

Create a violation for this rule

impl Default for MDBOOK007

fn default() -> MDBOOK007

Returns the “default value” for a type.