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

use crate::config::Config;
use crate::linter::diagnostics::{Diagnostic, Location};
use crate::linter::rules::Rule;
use crate::syntax::{SyntaxKind, SyntaxNode};

pub struct EmojiAliasesRule;

impl Rule for EmojiAliasesRule {
    fn name(&self) -> &str {
        "unknown-emoji-alias"
    }

    fn check(
        &self,
        tree: &SyntaxNode,
        input: &str,
        config: &Config,
        _metadata: Option<&crate::metadata::DocumentMetadata>,
    ) -> Vec<Diagnostic> {
        if !config.extensions.emoji {
            return Vec::new();
        }

        let mut diagnostics = Vec::new();

        for node in tree
            .descendants()
            .filter(|node| node.kind() == SyntaxKind::EMOJI)
        {
            let raw = node.to_string();
            let Some(alias) = raw.strip_prefix(':').and_then(|s| s.strip_suffix(':')) else {
                continue;
            };

            if emojis::get_by_shortcode(alias).is_none() {
                diagnostics.push(Diagnostic::warning(
                    Location::from_node(&node, input),
                    "unknown-emoji-alias",
                    format!("Unknown emoji alias '{}'", raw),
                ));
            }
        }

        diagnostics
    }
}

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

    fn parse_and_lint(input: &str, emoji_enabled: bool) -> Vec<Diagnostic> {
        let mut config = Config::default();
        config.extensions.emoji = emoji_enabled;
        let tree = crate::parser::parse(input, Some(config.clone()));
        let rule = EmojiAliasesRule;
        rule.check(&tree, input, &config, None)
    }

    #[test]
    fn accepts_known_alias() {
        let diagnostics = parse_and_lint("Hello :smile:", true);
        assert!(diagnostics.is_empty());
    }

    #[test]
    fn warns_on_unknown_alias() {
        let diagnostics = parse_and_lint("Hello :not-a-real-emoji:", true);
        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].code, "unknown-emoji-alias");
        assert_eq!(diagnostics[0].location.line, 1);
    }

    #[test]
    fn does_not_run_when_emoji_extension_disabled() {
        let diagnostics = parse_and_lint("Hello :not-a-real-emoji:", false);
        assert!(diagnostics.is_empty());
    }
}