Struct MdBookRuleProvider

Source
pub struct MdBookRuleProvider;
Expand description

Provider for mdBook-specific linting rules

This provider includes mdBook-specific rules (MDBOOK001-007) that check for mdBook conventions and best practices:

  • Code block language tags for proper syntax highlighting
  • Internal link validation within the book structure
  • SUMMARY.md format validation
  • Unique chapter title enforcement
  • Orphaned file detection
  • Cross-reference anchor validation
  • Include directive validation

§Rule Coverage

  • MDBOOK001: code-block-language - Code blocks should have language tags
  • MDBOOK002: internal-link-validation - Internal links must resolve
  • MDBOOK003: summary-structure - SUMMARY.md format validation
  • MDBOOK004: no-duplicate-chapter-titles - Unique chapter titles
  • MDBOOK005: orphaned-files - Detect files not referenced in SUMMARY.md
  • MDBOOK006: internal-cross-references - Validate anchor links between chapters
  • MDBOOK007: include-validation - Validate include directive paths and syntax

Trait Implementations§

Source§

impl RuleProvider for MdBookRuleProvider

Source§

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

Unique identifier for this rule provider
Source§

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

Human-readable description of this rule provider
Source§

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

Version of this rule provider
Source§

fn register_rules(&self, registry: &mut RuleRegistry)

Register all rules from this provider with the registry
Source§

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

List of rule IDs that this provider registers
Source§

fn config_schema(&self) -> Option<Value>

Provider-specific configuration schema
Source§

fn initialize(&self) -> Result<()>

Provider initialization hook

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.