mdbook-lint 0.2.0

A fast markdown linter for mdBook
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! MD016: Gap in rule numbering
//!
//! This rule number never existed in markdownlint - it was a gap in the numbering sequence.
//! It exists as a placeholder to maintain complete rule numbering.

use crate::error::Result;
use crate::rule::{Rule, RuleMetadata};
use crate::{Document, violation::Violation};
use comrak::nodes::AstNode;

/// Placeholder for non-existent rule MD016
pub struct MD016;

impl Rule for MD016 {
    fn id(&self) -> &'static str {
        "MD016"
    }

    fn name(&self) -> &'static str {
        "gap"
    }

    fn description(&self) -> &'static str {
        "Gap in rule numbering (never existed)"
    }

    fn metadata(&self) -> RuleMetadata {
        RuleMetadata::reserved("This rule number never existed in markdownlint numbering")
            .introduced_in("mdbook-lint v0.1.0")
    }

    fn check_with_ast<'a>(
        &self,
        _document: &Document,
        _ast: Option<&'a AstNode<'a>>,
    ) -> Result<Vec<Violation>> {
        // Gap rules never produce violations
        Ok(vec![])
    }
}