panache 2.36.0

An LSP, formatter, and linter for Pandoc markdown, Quarto, and RMarkdown
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

use crate::config::Config;
use crate::linter::diagnostics::{Diagnostic, Location};
use crate::linter::rules::Rule;
use crate::syntax::{AstNode, ChunkInfoItem, ChunkLabel, ChunkLabelSource, CodeBlock, SyntaxNode};

pub struct ChunkLabelSpacesRule;

impl Rule for ChunkLabelSpacesRule {
    fn name(&self) -> &str {
        "chunk-label-spaces"
    }

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

        for block in tree.descendants().filter_map(CodeBlock::cast) {
            diagnostics.extend(check_chunk_label_spaces(&block, input));
        }

        diagnostics
    }
}

fn check_chunk_label_spaces(block: &CodeBlock, input: &str) -> Vec<Diagnostic> {
    let mut diagnostics = Vec::new();

    diagnostics.extend(check_implicit_label_spaces(block, input));

    for label in block.chunk_label_entries() {
        if label.source() == ChunkLabelSource::InlineLabel {
            continue;
        }
        let value = label.value();
        if !value.chars().any(char::is_whitespace) {
            continue;
        }

        diagnostics.push(Diagnostic::warning(
            Location::from_range(label.value_range(), input),
            "chunk-label-spaces",
            format!(
                "Chunk label '{}' contains spaces and may break Quarto cross-references; use hyphens or underscores",
                value
            ),
        ));
    }

    diagnostics
}

fn check_implicit_label_spaces(block: &CodeBlock, input: &str) -> Vec<Diagnostic> {
    let Some(info) = block.info() else {
        return Vec::new();
    };

    let mut leading_labels: Vec<ChunkLabel> = Vec::new();
    for item in info.chunk_items() {
        match item {
            ChunkInfoItem::Label(label) => leading_labels.push(label),
            ChunkInfoItem::Option(_) => break,
        }
    }

    if leading_labels.len() <= 1 {
        return Vec::new();
    }

    let first = leading_labels
        .first()
        .expect("non-empty labels")
        .range()
        .start();
    let last = leading_labels
        .last()
        .expect("non-empty labels")
        .range()
        .end();
    let value = leading_labels
        .iter()
        .map(|label| label.text())
        .collect::<Vec<_>>()
        .join(" ");

    vec![Diagnostic::warning(
        Location::from_range(rowan::TextRange::new(first, last), input),
        "chunk-label-spaces",
        format!(
            "Chunk label '{}' contains spaces and may break Quarto cross-references; use hyphens or underscores",
            value
        ),
    )]
}

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

    fn parse_and_lint(input: &str) -> Vec<Diagnostic> {
        let config = Config {
            flavor: Flavor::Quarto,
            extensions: crate::config::Extensions::for_flavor(Flavor::Quarto),
            ..Default::default()
        };
        let tree = crate::parser::parse(input, Some(config.clone()));
        let rule = ChunkLabelSpacesRule;
        rule.check(&tree, input, &config, None)
    }

    #[test]
    fn reports_implicit_label_with_spaces() {
        let diagnostics = parse_and_lint("```{r several words}\n1 + 1\n```\n");
        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].code, "chunk-label-spaces");
        assert!(diagnostics[0].message.contains("several words"));
    }

    #[test]
    fn reports_explicit_label_with_spaces() {
        let diagnostics = parse_and_lint("```{r, label=\"several words\"}\n1 + 1\n```\n");
        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].code, "chunk-label-spaces");
        assert!(diagnostics[0].message.contains("several words"));
    }

    #[test]
    fn accepts_label_without_spaces() {
        let diagnostics = parse_and_lint("```{r several-words}\n1 + 1\n```\n");
        assert!(diagnostics.is_empty());
    }
}