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
impl RuleProvider for MdBookRuleProvider
Source§fn provider_id(&self) -> &'static str
fn provider_id(&self) -> &'static str
Unique identifier for this rule provider
Source§fn description(&self) -> &'static str
fn description(&self) -> &'static str
Human-readable description of this rule provider
Source§fn register_rules(&self, registry: &mut RuleRegistry)
fn register_rules(&self, registry: &mut RuleRegistry)
Register all rules from this provider with the registry
Source§fn config_schema(&self) -> Option<Value>
fn config_schema(&self) -> Option<Value>
Provider-specific configuration schema
Source§fn initialize(&self) -> Result<()>
fn initialize(&self) -> Result<()>
Provider initialization hook
Auto Trait Implementations§
impl Freeze for MdBookRuleProvider
impl RefUnwindSafe for MdBookRuleProvider
impl Send for MdBookRuleProvider
impl Sync for MdBookRuleProvider
impl Unpin for MdBookRuleProvider
impl UnwindSafe for MdBookRuleProvider
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more