prosesmasher-app-core 0.1.7

Internal core checks crate for the prosesmasher workspace. Published to support the workspace dependency graph.
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

//! Heading hierarchy check — validates heading levels follow a correct structure.

use low_expectations::ExpectationSuite;
use prosesmasher_domain_types::{CheckConfig, Document, Locale};
use serde_json::json;

use crate::check::Check;

/// Checks that headings follow a valid hierarchy: no H1 in body, no H4+, no level skips.
#[derive(Debug)]
pub struct HeadingHierarchyCheck;

impl Check for HeadingHierarchyCheck {
    fn id(&self) -> &'static str {
        "heading-hierarchy"
    }

    fn label(&self) -> &'static str {
        "Heading Hierarchy"
    }

    fn supported_locales(&self) -> Option<&'static [Locale]> {
        None
    }

    fn run(&self, doc: &Document, config: &CheckConfig, suite: &mut ExpectationSuite) {
        if !config.document_policy.heading_hierarchy {
            return;
        }

        let mut last_level: Option<u8> = None;

        for (section_index, section) in doc.sections.iter().enumerate() {
            let Some(heading) = &section.heading else {
                continue;
            };

            let level = heading.level;

            // Flag H1 headings — body shouldn't have H1
            if level == 1 {
                record_h1_violation(suite, heading, section_index);
            }

            // Flag H4+ headings — only H2/H3 allowed
            if level >= 4 {
                record_deep_heading_violation(suite, heading, section_index);
            }

            // Flag level skips (e.g., H2 → H4 skips H3). Going back up is OK.
            if let Some(prev) = last_level
                && level > prev
            {
                let expected_next = prev.saturating_add(1);
                if level > expected_next {
                    record_skip_violation(suite, heading, section_index, prev, expected_next);
                }
            }

            last_level = Some(level);
        }
    }
}

fn record_h1_violation(suite: &mut ExpectationSuite, heading: &prosesmasher_domain_types::Heading, section_index: usize) {
    let col = format!("heading-h1-{}-{section_index}", heading.text);
    let _result = suite
        .record_custom_values(
            &col,
            false,
            json!({ "forbidden_level": 1, "rule": "no H1 headings in body" }),
            json!({ "heading_level": 1, "heading_text": heading.text }),
            &[json!({
                "section_index": section_index,
                "heading_level": 1,
                "heading_text": heading.text,
                "issue": "H1 in body",
            })],
        )
        .label("Heading Hierarchy")
        .checking("H1 in body");
}

fn record_deep_heading_violation(
    suite: &mut ExpectationSuite,
    heading: &prosesmasher_domain_types::Heading,
    section_index: usize,
) {
    let level = heading.level;
    let col = format!("heading-h{level}-{}-{section_index}", heading.text);
    let _result = suite
        .record_custom_values(
            &col,
            false,
            json!({ "allowed_levels": [2, 3], "rule": "only H2/H3 headings allowed" }),
            json!({ "heading_level": level, "heading_text": heading.text }),
            &[json!({
                "section_index": section_index,
                "heading_level": level,
                "heading_text": heading.text,
                "issue": "heading too deep",
            })],
        )
        .label("Heading Hierarchy")
        .checking(&format!("H{level} in body"));
}

fn record_skip_violation(
    suite: &mut ExpectationSuite,
    heading: &prosesmasher_domain_types::Heading,
    section_index: usize,
    previous_level: u8,
    expected_next_level: u8,
) {
    let level = heading.level;
    let col = format!("heading-skip-h{previous_level}-h{level}-{}-{section_index}", heading.text);
    let _result = suite
        .record_custom_values(
            &col,
            false,
            json!({
                "expected_next_level": expected_next_level,
                "previous_level": previous_level,
            }),
            json!({
                "heading_level": level,
                "heading_text": heading.text,
            }),
            &[json!({
                "section_index": section_index,
                "previous_level": previous_level,
                "expected_next_level": expected_next_level,
                "heading_level": level,
                "heading_text": heading.text,
                "issue": "heading level skip",
            })],
        )
        .label("Heading Hierarchy")
        .checking("heading level skip");
}

#[cfg(test)]
#[path = "heading_hierarchy_tests.rs"]
mod tests;