quickmark-core 1.1.0

Lightning-fast Markdown/CommonMark linter core library with tree-sitter based parsing
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

//! Testing utilities for QuickMark linter rules.
//!
//! This module provides shared functions to create test configurations,
//! avoiding code duplication across individual rule tests.

#[cfg(any(test, feature = "testing"))]
pub mod test_helpers {
    use crate::config::{LintersSettingsTable, LintersTable, QuickmarkConfig, RuleSeverity};
    use std::collections::HashMap;

    /// Creates a basic test configuration with only the specified rules enabled.
    ///
    /// # Arguments
    /// * `enabled_rules` - Vector of (rule_name, severity) tuples to enable
    ///
    /// # Example
    /// ```
    /// use quickmark_core::test_utils::test_helpers::test_config_with_rules;
    /// use quickmark_core::config::RuleSeverity;
    ///
    /// let config = test_config_with_rules(vec![
    ///     ("heading-increment", RuleSeverity::Error),
    ///     ("heading-style", RuleSeverity::Warning),
    /// ]);
    /// ```
    pub fn test_config_with_rules(enabled_rules: Vec<(&str, RuleSeverity)>) -> QuickmarkConfig {
        let severity: HashMap<String, RuleSeverity> = enabled_rules
            .into_iter()
            .map(|(rule, sev)| (rule.to_string(), sev))
            .collect();

        QuickmarkConfig {
            linters: LintersTable {
                severity,
                settings: LintersSettingsTable::default(),
            },
        }
    }

    /// Creates a test configuration with custom settings.
    ///
    /// # Arguments
    /// * `enabled_rules` - Vector of (rule_name, severity) tuples to enable
    /// * `settings` - Custom linter settings
    ///
    /// # Example
    /// ```
    /// use quickmark_core::test_utils::test_helpers::test_config_with_settings;
    /// use quickmark_core::config::{RuleSeverity, LintersSettingsTable, MD003HeadingStyleTable, HeadingStyle};
    ///
    /// let config = test_config_with_settings(
    ///     vec![("heading-style", RuleSeverity::Error)],
    ///     LintersSettingsTable {
    ///         heading_style: MD003HeadingStyleTable { style: HeadingStyle::ATX },
    ///         ..Default::default()
    ///     }
    /// );
    /// ```
    pub fn test_config_with_settings(
        enabled_rules: Vec<(&str, RuleSeverity)>,
        settings: LintersSettingsTable,
    ) -> QuickmarkConfig {
        let severity: HashMap<String, RuleSeverity> = enabled_rules
            .into_iter()
            .map(|(rule, sev)| (rule.to_string(), sev))
            .collect();

        QuickmarkConfig {
            linters: LintersTable { severity, settings },
        }
    }
}