rumdl 0.1.84

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284

use rumdl_lib::config::{ConfigError, create_default_config, create_preset_config};
use std::fs;
use std::path::Path;
use tempfile::tempdir;

#[test]
fn test_create_default_config_new_file() {
    // Create a temporary directory that will be automatically cleaned up
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    // Create a new config file
    let result = create_default_config(config_path_str);
    assert!(result.is_ok());

    // Verify the file exists and contains the default configuration
    assert!(Path::new(config_path_str).exists());
    let content = fs::read_to_string(config_path_str).unwrap();
    assert!(content.contains("[global]"));
    assert!(content.contains("# rumdl configuration file"));
    assert!(content.contains("exclude ="));
    assert!(content.contains("respect-gitignore = true"));
    assert!(content.contains("# [MD007]"));

    // Cleanup is handled automatically by tempdir
}

#[test]
fn test_create_default_config_existing_file() {
    // Create a temporary directory
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    // Create a dummy file first
    fs::write(config_path_str, "dummy content").unwrap();

    // Try to create config file (should error because file exists)
    let result = create_default_config(config_path_str);
    assert!(result.is_err());

    // Verify the error is FileExists
    match result {
        Err(ConfigError::FileExists { .. }) => {}
        _ => panic!("Expected FileExists error"),
    }

    // Verify the file still contains the original content
    let content = fs::read_to_string(config_path_str).unwrap();
    assert_eq!(content, "dummy content");
}

#[test]
fn test_create_default_config_permission_error() {
    if cfg!(unix) {
        // Skip this test on Windows as permission model is different
        // Create a temporary directory with no write permissions
        let temp_dir = tempdir().unwrap();
        let unwritable_dir = temp_dir.path().join("unwritable");
        fs::create_dir(&unwritable_dir).unwrap();

        // On Unix, set directory permissions to read-only (no write access)
        use std::os::unix::fs::PermissionsExt;
        let read_only = fs::Permissions::from_mode(0o555);
        fs::set_permissions(&unwritable_dir, read_only).unwrap();

        // Try to create config file in read-only directory
        let config_path = unwritable_dir.join("rumdl.toml");
        let config_path_str = config_path.to_str().unwrap();

        let result = create_default_config(config_path_str);
        assert!(result.is_err());
        match result {
            Err(ConfigError::IoError { path, .. }) => {
                assert_eq!(path, config_path_str);
            }
            _ => panic!("Expected IoError variant"),
        }
    }
}

#[test]
fn test_create_default_config_content_validation() {
    // Create a temporary directory
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    // Create the config file
    let result = create_default_config(config_path_str);
    assert!(result.is_ok());

    // Read the content and verify all expected sections are present
    let content = fs::read_to_string(config_path_str).unwrap();

    // Verify global section
    assert!(content.contains("[global]"));
    assert!(content.contains("# rumdl configuration file"));
    assert!(content.contains("exclude ="));
    assert!(content.contains("respect-gitignore = true"));

    // Verify some example rule configurations are present (commented out)
    assert!(content.contains("# [MD003]"));
    assert!(content.contains("# [MD004]"));
    assert!(content.contains("# [MD007]"));
    assert!(content.contains("# [MD013]"));
    assert!(content.contains("# [MD044]"));

    // Verify the config is valid TOML
    let parsed_toml: Result<toml::Value, _> = toml::from_str(&content);
    assert!(parsed_toml.is_ok());
}

#[test]
fn test_create_google_preset_config() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    let result = create_preset_config("google", config_path_str);
    assert!(result.is_ok());

    let content = fs::read_to_string(config_path_str).unwrap();

    // Verify Google-specific settings
    assert!(content.contains("[MD003]"));
    assert!(content.contains("style = \"atx\""));
    assert!(content.contains("[MD004]"));
    assert!(content.contains("style = \"dash\""));
    assert!(content.contains("[MD007]"));
    assert!(content.contains("indent = 4"));
    assert!(content.contains("[MD009]"));
    assert!(content.contains("strict = true"));
    assert!(content.contains("[MD013]"));
    assert!(content.contains("line-length = 80"));
    assert!(content.contains("[MD046]"));
    assert!(content.contains("style = \"fenced\""));
    assert!(content.contains("[MD049]"));
    assert!(content.contains("style = \"underscore\""));
    assert!(content.contains("[MD050]"));
    assert!(content.contains("style = \"asterisk\""));

    // Verify Google-specific header comment
    assert!(content.contains("Google"));

    // Verify the config is valid TOML
    let parsed: Result<toml::Value, _> = toml::from_str(&content);
    assert!(parsed.is_ok(), "Google preset config must be valid TOML");
}

#[test]
fn test_create_google_preset_deserializes_into_config() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    create_preset_config("google", config_path_str).unwrap();
    let content = fs::read_to_string(config_path_str).unwrap();

    // Verify the Google config can be deserialized into our Config struct
    let config: Result<rumdl_lib::config::Config, _> = toml::from_str(&content);
    assert!(
        config.is_ok(),
        "Google preset must deserialize into Config: {:?}",
        config.err()
    );
}

#[test]
fn test_create_default_preset_config() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    let result = create_preset_config("default", config_path_str);
    assert!(result.is_ok());

    let content = fs::read_to_string(config_path_str).unwrap();
    assert!(content.contains("[global]"));
    assert!(content.contains("# rumdl configuration file"));

    // Verify the config is valid TOML
    let parsed: Result<toml::Value, _> = toml::from_str(&content);
    assert!(parsed.is_ok());
}

#[test]
fn test_create_preset_config_unknown_preset() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    let result = create_preset_config("nonexistent", config_path_str);
    assert!(result.is_err());
    match result {
        Err(ConfigError::UnknownPreset { name }) => {
            assert_eq!(name, "nonexistent");
        }
        _ => panic!("Expected UnknownPreset error"),
    }
}

#[test]
fn test_create_preset_config_file_exists() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    fs::write(config_path_str, "existing").unwrap();

    let result = create_preset_config("google", config_path_str);
    assert!(result.is_err());
    match result {
        Err(ConfigError::FileExists { .. }) => {}
        _ => panic!("Expected FileExists error"),
    }
}

#[test]
fn test_default_preset_matches_create_default_config() {
    let temp_dir = tempdir().unwrap();

    // Create with create_default_config
    let default_path = temp_dir.path().join("default.toml");
    create_default_config(default_path.to_str().unwrap()).unwrap();
    let default_content = fs::read_to_string(&default_path).unwrap();

    // Create with create_preset_config("default", ...)
    let preset_path = temp_dir.path().join("preset.toml");
    create_preset_config("default", preset_path.to_str().unwrap()).unwrap();
    let preset_content = fs::read_to_string(&preset_path).unwrap();

    assert_eq!(
        default_content, preset_content,
        "create_default_config and create_preset_config(\"default\") must produce identical output"
    );
}

#[test]
fn test_create_relaxed_preset_config() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    let result = create_preset_config("relaxed", config_path_str);
    assert!(result.is_ok());

    let content = fs::read_to_string(config_path_str).unwrap();

    // Verify relaxed-specific settings
    assert!(content.contains("Relaxed"));
    assert!(content.contains("[global]"));

    // Key relaxed features: disable noisy rules
    assert!(content.contains("MD013"));
    assert!(content.contains("MD033"));
    assert!(content.contains("MD041"));
    assert!(content.contains("disable ="));

    // Uses consistent styles rather than enforcing specific ones
    assert!(content.contains("style = \"consistent\""));

    // Verify the config is valid TOML
    let parsed: Result<toml::Value, _> = toml::from_str(&content);
    assert!(parsed.is_ok(), "Relaxed preset config must be valid TOML");
}

#[test]
fn test_create_relaxed_preset_deserializes_into_config() {
    let temp_dir = tempdir().unwrap();
    let config_path = temp_dir.path().join("rumdl.toml");
    let config_path_str = config_path.to_str().unwrap();

    create_preset_config("relaxed", config_path_str).unwrap();
    let content = fs::read_to_string(config_path_str).unwrap();

    let config: Result<rumdl_lib::config::Config, _> = toml::from_str(&content);
    assert!(
        config.is_ok(),
        "Relaxed preset must deserialize into Config: {:?}",
        config.err()
    );
}