rumdl 0.1.95

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

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

/// Configuration for MD010 (No hard tabs)
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub struct MD010Config {
    /// Number of spaces per tab (default: 4)
    #[serde(default = "default_spaces_per_tab", alias = "spaces_per_tab")]
    pub spaces_per_tab: PositiveUsize,

    /// Check for hard tabs inside code blocks (default: false).
    /// When false, tabs inside fenced and indented code blocks are skipped.
    #[serde(default = "default_code_blocks", alias = "code_blocks")]
    pub code_blocks: bool,
}

fn default_spaces_per_tab() -> PositiveUsize {
    PositiveUsize::from_const(4)
}

fn default_code_blocks() -> bool {
    false
}

impl Default for MD010Config {
    fn default() -> Self {
        Self {
            spaces_per_tab: default_spaces_per_tab(),
            code_blocks: default_code_blocks(),
        }
    }
}

impl RuleConfig for MD010Config {
    const RULE_NAME: &'static str = "MD010";
}

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

    #[test]
    fn test_default_config() {
        let config = MD010Config::default();
        assert_eq!(config.spaces_per_tab.get(), 4);
    }

    #[test]
    fn test_config_deserialization() {
        let toml_str = r#"
            spaces-per-tab = 2
        "#;
        let config: MD010Config = toml::from_str(toml_str).unwrap();
        assert_eq!(config.spaces_per_tab.get(), 2);
    }

    #[test]
    fn test_snake_case_backwards_compatibility() {
        let toml_str = r#"
            spaces_per_tab = 8
        "#;
        let config: MD010Config = toml::from_str(toml_str).unwrap();
        assert_eq!(config.spaces_per_tab.get(), 8);
    }

    #[test]
    fn test_validation_error() {
        // Test that 0 is rejected
        let toml_str = r#"
            spaces-per-tab = 0
        "#;
        let result: Result<MD010Config, _> = toml::from_str(toml_str);
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("must be at least 1") || err.contains("got 0"));
    }

    #[test]
    fn test_code_blocks_defaults_false() {
        let config = MD010Config::default();
        assert!(!config.code_blocks, "MD010 defaults to skipping code blocks");
    }

    #[test]
    fn test_code_blocks_kebab_case() {
        let config: MD010Config = toml::from_str("code-blocks = true\n").unwrap();
        assert!(config.code_blocks);
        assert_eq!(config.spaces_per_tab.get(), 4);
    }

    #[test]
    fn test_code_blocks_snake_case_alias() {
        let config: MD010Config = toml::from_str("code_blocks = true\n").unwrap();
        assert!(config.code_blocks);
    }
}