rumdl 0.1.51

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use crate::rule_config_serde::RuleConfig;
use crate::rules::code_fence_utils::CodeFenceStyle;
use serde::ser::Serializer;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MD048Config {
    #[serde(
        default = "default_style",
        serialize_with = "serialize_style",
        deserialize_with = "deserialize_style"
    )]
    pub style: CodeFenceStyle,
}

impl Default for MD048Config {
    fn default() -> Self {
        Self { style: default_style() }
    }
}

fn default_style() -> CodeFenceStyle {
    CodeFenceStyle::Consistent
}

fn serialize_style<S>(style: &CodeFenceStyle, serializer: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    serializer.serialize_str(&style.to_string())
}

fn deserialize_style<'de, D>(deserializer: D) -> Result<CodeFenceStyle, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let s = String::deserialize(deserializer)?;
    match s.trim().to_ascii_lowercase().as_str() {
        "backtick" => Ok(CodeFenceStyle::Backtick),
        "tilde" => Ok(CodeFenceStyle::Tilde),
        "consistent" => Ok(CodeFenceStyle::Consistent),
        _ => Err(serde::de::Error::custom(format!(
            "Invalid code fence style: {s}. Valid options: backtick, tilde, consistent"
        ))),
    }
}

impl RuleConfig for MD048Config {
    const RULE_NAME: &'static str = "MD048";
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_style_is_case_insensitive() {
        let config: MD048Config = toml::from_str(r#"style = "Backtick""#).unwrap();
        assert_eq!(config.style, CodeFenceStyle::Backtick);

        let config: MD048Config = toml::from_str(r#"style = "TILDE""#).unwrap();
        assert_eq!(config.style, CodeFenceStyle::Tilde);

        let config: MD048Config = toml::from_str(r#"style = "Consistent""#).unwrap();
        assert_eq!(config.style, CodeFenceStyle::Consistent);
    }
}