rumdl 0.2.78

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

//! Configuration for MD093 (no formatting in headings).

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

fn default_true() -> bool {
    true
}

/// Configuration for MD093. One switch per construct, because the three have
/// different justifications: a code span in a heading is usually deliberate and
/// only breaks generated artifacts, while emphasis is often an accident of a
/// name that contains `_` or `*`. A project that wants only one of them
/// reported turns the other two off.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub(super) struct MD093Config {
    /// Report inline code spans in headings.
    #[serde(default = "default_true")]
    pub(super) code: bool,
    /// Report strong emphasis (`**`/`__`) in headings.
    #[serde(default = "default_true")]
    pub(super) strong: bool,
    /// Report ordinary emphasis (`*`/`_`) in headings.
    #[serde(default = "default_true")]
    pub(super) emphasis: bool,
}

impl Default for MD093Config {
    fn default() -> Self {
        Self {
            code: true,
            strong: true,
            emphasis: true,
        }
    }
}

impl RuleConfig for MD093Config {
    const RULE_NAME: &'static str = "MD093";
}

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

    #[test]
    fn every_construct_is_reported_by_default() {
        let config = MD093Config::default();
        assert!(config.code);
        assert!(config.strong);
        assert!(config.emphasis);
    }

    #[test]
    fn a_single_construct_can_be_turned_off() {
        let config: MD093Config = toml::from_str("code = false\n").unwrap();
        assert!(!config.code);
        assert!(config.strong);
        assert!(config.emphasis);
    }
}