panache 2.47.0

An LSP, formatter, and linter for Markdown, Quarto, and R Markdown
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

use crate::config::Config;
use crate::linter::diagnostics::{Diagnostic, DiagnosticNoteKind, Location};
use crate::linter::rules::Rule;
use crate::syntax::{AttributeNode, Heading, InlineHtml, SyntaxNode};
use rowan::ast::AstNode;

pub struct HeadingStripCommentsResidueRule;

impl Rule for HeadingStripCommentsResidueRule {
    fn name(&self) -> &str {
        "heading-strip-comments-residue"
    }

    fn check(
        &self,
        tree: &SyntaxNode,
        input: &str,
        _config: &Config,
        _metadata: Option<&crate::metadata::DocumentMetadata>,
    ) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        for heading in tree.descendants().filter_map(Heading::cast) {
            // The companion rule `heading-eaten-attrs` already covers headings
            // where pandoc treated `{...}` as literal text. Here we only care
            // about headings with a *real* AttributeNode — i.e. attrs that
            // parse, but where `pandoc --strip-comments` would leave stray
            // whitespace adjacent to the brace block.
            let has_attr = heading
                .syntax()
                .children()
                .any(|child| AttributeNode::cast(child).is_some());
            if !has_attr {
                continue;
            }

            let content = match heading.content() {
                Some(c) => c,
                None => continue,
            };

            for comment in content
                .syntax()
                .descendants()
                .filter_map(InlineHtml::cast)
                .filter(InlineHtml::is_comment)
            {
                let range = comment.syntax().text_range();
                let location = Location::from_range(range, input);

                diagnostics.push(
                    Diagnostic::warning(
                        location,
                        "heading-strip-comments-residue",
                        "Comment on a heading line adjacent to `{...}` attributes; `pandoc --strip-comments` will leave stray whitespace on the heading.",
                    )
                    .with_note(
                        DiagnosticNoteKind::Help,
                        "Move the comment to its own line before or after the heading.",
                    ),
                );
            }
        }

        diagnostics
    }
}

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

    fn lint(input: &str) -> Vec<Diagnostic> {
        let config = Config::default();
        let tree = crate::parser::parse(input, Some(config.clone()));
        HeadingStripCommentsResidueRule.check(&tree, input, &config, None)
    }

    #[test]
    fn comment_before_attrs_warns() {
        let input = "# Title <!-- x --> {.unnumbered}\n";
        let diags = lint(input);
        assert_eq!(diags.len(), 1);
        assert_eq!(diags[0].code, "heading-strip-comments-residue");
        assert!(
            diags[0].message.contains("--strip-comments"),
            "got: {}",
            diags[0].message
        );
    }

    #[test]
    fn trailing_comment_does_not_fire_here() {
        // Attrs are eaten — covered by the sibling rule, not this one.
        let input = "# Title {.unnumbered} <!-- x -->\n";
        let diags = lint(input);
        assert_eq!(diags.len(), 0);
    }

    #[test]
    fn heading_without_comment_is_ignored() {
        let input = "# Title {.unnumbered}\n";
        let diags = lint(input);
        assert_eq!(diags.len(), 0);
    }

    #[test]
    fn heading_without_attrs_is_ignored() {
        let input = "# Title <!-- TODO -->\n";
        let diags = lint(input);
        assert_eq!(diags.len(), 0);
    }

    #[test]
    fn comment_elsewhere_is_ignored() {
        let input = "A paragraph with <!-- comment --> in it.\n\n# Title {.x}\n";
        let diags = lint(input);
        assert_eq!(diags.len(), 0);
    }
}