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
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

use std::rc::Rc;

use crate::linter::{Context, RuleLinter};

pub mod md001;
pub mod md003;
pub mod md004;
pub mod md005;
pub mod md007;
pub mod md009;
pub mod md010;
pub mod md011;
pub mod md012;
pub mod md013;
pub mod md014;
pub mod md018;
pub mod md019;
pub mod md020;
pub mod md021;
pub mod md022;
pub mod md023;
pub mod md024;
pub mod md025;
pub mod md026;
pub mod md027;
pub mod md028;
pub mod md029;
pub mod md030;
pub mod md031;
pub mod md032;
pub mod md033;
pub mod md034;
pub mod md035;
pub mod md036;
pub mod md037;
pub mod md038;
pub mod md039;
pub mod md040;
pub mod md041;
pub mod md042;
pub mod md043;
pub mod md044;
pub mod md045;
pub mod md046;
pub mod md047;
pub mod md048;
pub mod md049;
pub mod md050;
pub mod md051;
pub mod md052;
pub mod md053;
pub mod md054;
pub mod md055;
pub mod md056;
pub mod md058;
pub mod md059;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RuleType {
    /// Rules that primarily analyze raw text lines (e.g., line length, whitespace)
    Line,
    /// Rules that analyze specific AST node types (e.g., headings, lists, code blocks)
    Token,
    /// Rules that require full document analysis (e.g., duplicate headings, cross-references)
    Document,
    /// Rules that need both AST nodes and line context (blank line spacing around elements)
    Hybrid,
}

#[derive(Debug)]
pub struct Rule {
    pub id: &'static str,
    pub alias: &'static str,
    pub tags: &'static [&'static str],
    pub description: &'static str,
    pub rule_type: RuleType,
    pub required_nodes: &'static [&'static str], // For caching optimization
    pub new_linter: fn(Rc<Context>) -> Box<dyn RuleLinter>,
}

pub const ALL_RULES: &[Rule] = &[
    md001::MD001,
    md003::MD003,
    md004::MD004,
    md005::MD005,
    md007::MD007,
    md009::MD009,
    md010::MD010,
    md011::MD011,
    md012::MD012,
    md013::MD013,
    md014::MD014,
    md018::MD018,
    md019::MD019,
    md020::MD020,
    md021::MD021,
    md022::MD022,
    md023::MD023,
    md024::MD024,
    md025::MD025,
    md026::MD026,
    md027::MD027,
    md028::MD028,
    md029::MD029,
    md030::MD030,
    md031::MD031,
    md032::MD032,
    md033::MD033,
    md034::MD034,
    md035::MD035,
    md036::MD036,
    md037::MD037,
    md038::MD038,
    md039::MD039,
    md040::MD040,
    md041::MD041,
    md042::MD042,
    md043::MD043,
    md044::MD044,
    md045::MD045,
    md046::MD046,
    md047::MD047,
    md048::MD048,
    md049::MD049,
    md050::MD050,
    md051::MD051,
    md052::MD052,
    md053::MD053,
    md054::MD054,
    md055::MD055,
    md056::MD056,
    md058::MD058,
    md059::MD059,
];