Struct LintEngine 

pub struct LintEngine { /* private fields */ }

Markdown linting engine

Implementations

impl LintEngine

pub fn new() -> LintEngine

Create a new lint engine with no rules

pub fn with_registry(registry: RuleRegistry) -> LintEngine

Create a lint engine with an existing rule registry

pub fn registry(&self) -> &RuleRegistry

Get the underlying rule registry

pub fn registry_mut(&mut self) -> &mut RuleRegistry

Get a mutable reference to the rule registry

pub fn lint_document( &self, document: &Document, ) -> Result<Vec<Violation>, MdBookLintError>

Lint a document with all registered rules

pub fn lint_document_with_config( &self, document: &Document, config: &Config, ) -> Result<Vec<Violation>, MdBookLintError>

Lint a document with specific configuration

pub fn lint_content( &self, content: &str, source_label: &str, ) -> Result<Vec<Violation>, MdBookLintError>

Lint content string directly (convenience method)

Arguments

• content - The markdown content to lint
• source_label - A label for error messages (e.g., filename). This is NOT read from disk.

pub fn apply_fix(&self, content: &str, violation: &Violation) -> Option<String>

Apply a single fix to content

Returns Some(fixed_content) if the fix was applied, None if the violation has no fix or the fix couldn’t be applied.

Example

let violations = engine.lint_content("# Test\n\n\n\n", "test.md")?;
if let Some(v) = violations.first() {
    if let Some(fixed) = engine.apply_fix("# Test\n\n\n\n", v) {
        println!("Fixed: {}", fixed);
    }
}

pub fn apply_fixes( &self, content: &str, violations: &[Violation], ) -> (String, Vec<Violation>)

Apply all available fixes to content

Applies fixes from violations that have them, processing in reverse position order to avoid offset issues. Returns the fixed content and a list of violations that could not be fixed.

Example

let violations = engine.lint_content(content, "test.md")?;
let (fixed_content, unfixed) = engine.apply_fixes(content, &violations);
if fixed_content != content {
    println!("Applied {} fixes", violations.len() - unfixed.len());
}

pub fn available_rules(&self) -> Vec<&'static str>

Get all available rule IDs

pub fn enabled_rules(&self, config: &Config) -> Vec<&dyn Rule>

Get enabled rules based on configuration

pub fn lint_collection( &self, documents: &[Document], ) -> Result<Vec<Violation>, MdBookLintError>

Lint a collection of documents with collection rules

Collection rules analyze multiple documents together for cross-document validation. This method runs all registered collection rules against the provided documents.

pub fn lint_collection_with_config( &self, documents: &[Document], config: &Config, ) -> Result<Vec<Violation>, MdBookLintError>

Lint a collection of documents with specific configuration

pub fn available_collection_rules(&self) -> Vec<&'static str>

Get all available collection rule IDs

pub fn has_collection_rules(&self) -> bool

Check if there are any collection rules registered

Trait Implementations

impl Default for LintEngine

fn default() -> LintEngine

Returns the “default value” for a type.