rumdl 0.2.67

A fast Markdown linter and formatter written in Rust
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

//! Configuration for MD089 (CJK spacing).

use crate::rule_config_serde::RuleConfig;
use serde::{Deserialize, Serialize};

/// Symbols that lead a Latin run and take a space after a CJK letter (`價格$5`).
fn default_symbols_after_cjk() -> String {
    "-+'\"([¥$".to_string()
}

/// Symbols that trail a Latin run and take a space before a CJK letter (`90°的`).
fn default_symbols_before_cjk() -> String {
    "-+;:'\"°%$)]".to_string()
}

/// Configuration for MD089. Each set is written as one string of characters;
/// whitespace in the string is ignored.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub(super) struct MD089Config {
    /// Symbols that lead a Latin run and take a space after a CJK letter.
    #[serde(default = "default_symbols_after_cjk")]
    pub(super) symbols_after_cjk: String,
    /// Symbols that trail a Latin run and take a space before a CJK letter.
    #[serde(default = "default_symbols_before_cjk")]
    pub(super) symbols_before_cjk: String,
}

impl Default for MD089Config {
    fn default() -> Self {
        Self {
            symbols_after_cjk: default_symbols_after_cjk(),
            symbols_before_cjk: default_symbols_before_cjk(),
        }
    }
}

impl RuleConfig for MD089Config {
    const RULE_NAME: &'static str = "MD089";
}

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

    #[test]
    fn defaults_mirror_the_reference_implementation() {
        let config = MD089Config::default();
        assert_eq!(config.symbols_after_cjk, "-+'\"([¥$");
        assert_eq!(config.symbols_before_cjk, "-+;:'\"°%$)]");
    }

    #[test]
    fn kebab_case_keys_deserialize() {
        let config: MD089Config = toml::from_str("symbols-after-cjk = \"$\"\nsymbols-before-cjk = \"\"\n").unwrap();
        assert_eq!(config.symbols_after_cjk, "$");
        assert_eq!(config.symbols_before_cjk, "");
    }

    #[test]
    fn missing_keys_fall_back_to_defaults() {
        let config: MD089Config = toml::from_str("").unwrap();
        assert_eq!(config, MD089Config::default());
    }

    #[test]
    fn rule_name_is_md089() {
        assert_eq!(MD089Config::RULE_NAME, "MD089");
    }
}