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
41
42
43
44

//! MD017: Removed rule
//!
//! This rule was removed from markdownlint and its functionality covered by MD018-MD021.
//! It exists as a placeholder to maintain complete rule numbering.

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

/// Placeholder for removed rule MD017
pub struct MD017;

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

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

    fn description(&self) -> &'static str {
        "Removed rule (functionality covered by MD018-MD021)"
    }

    fn metadata(&self) -> RuleMetadata {
        RuleMetadata::deprecated(
            RuleCategory::Structure,
            "Functionality covered by MD018, MD019, MD020, and MD021",
            Some("MD018"),
        )
        .introduced_in("mdbook-lint v0.1.0")
    }

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