rumdl 0.2.60

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use crate::{rule_config_serde::RuleConfig, utils::unicode};
use serde::{Deserialize, Deserializer, Serialize};
use std::collections::HashSet;

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub(super) struct MD084Config {
    /// When enabled, report any invisible character anywhere in the document.
    #[serde(default)]
    pub(super) strict: bool,

    /// Codepoint allow-list in `U+XXXX` / `U+XXXXX` / `U+XXXXXX` format.
    ///
    /// Any matched invisible character with a codepoint present in this list
    /// is ignored.
    #[serde(default, deserialize_with = "deserialize_allow")]
    pub(super) allow: HashSet<char>,
}

fn deserialize_allow<'de, D>(deserializer: D) -> Result<HashSet<char>, D::Error>
where
    D: Deserializer<'de>,
{
    let values = Vec::<String>::deserialize(deserializer)?;
    let mut out = HashSet::with_capacity(values.len());

    for raw in values {
        out.insert(unicode::parse_codepoint(&raw).ok_or_else(|| {
            serde::de::Error::custom(format!(
                "Invalid codepoint '{raw}': expected format U+XXXX or a single character"
            ))
        })?);
    }

    Ok(out)
}

impl RuleConfig for MD084Config {
    const RULE_NAME: &'static str = "MD084";
}

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

    #[test]
    fn test_default_values() {
        let config = MD084Config::default();
        assert!(!config.strict);
        assert!(config.allow.is_empty());
    }

    #[test]
    fn test_allow_deserialize_and_normalize() {
        let config: MD084Config = toml::from_str(
            r#"
            allow = ["u+200b", "U+1f3fb"]
            strict = true
            "#,
        )
        .unwrap();

        assert!(config.strict);
        assert_eq!(
            config.allow,
            vec!['\u{200B}', '\u{1F3FB}'].into_iter().collect::<HashSet<char>>()
        );
    }

    #[test]
    fn test_invalid_allow_codepoint_rejected() {
        let err = toml::from_str::<MD084Config>(
            r#"
            allow = ["200B"]
            "#,
        )
        .unwrap_err()
        .to_string();

        assert!(err.contains("expected format U+XXXX"));
    }
}