badness 0.24.0

A language server, formatter, and linter for LaTeX
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

//! Expl3 messages accept four parameters. Higher parameter numbers have no
//! corresponding message argument; the author's intended replacement is unknown.

use crate::ast::command_name;
use crate::linter::diagnostic::Diagnostic;
use crate::linter::expl3::is_message_definition;
use crate::syntax::{SyntaxElement, SyntaxKind};

use super::{Example, Rule, RuleContext};

pub struct Expl3InvalidMessageParameter;

const EXAMPLES: &[Example] = &[Example {
    caption: "A message refers to a fifth parameter:",
    source: "\\ExplSyntaxOn\n\\msg_new:nnn { demo } { bad-value } { Invalid~value:~#5 }\n\\ExplSyntaxOff\n",
}];

impl Rule for Expl3InvalidMessageParameter {
    fn id(&self) -> &'static str {
        "expl3-invalid-message-parameter"
    }

    fn description(&self) -> &'static str {
        "Flag `#5` through `#9` in either text argument of a literal expl3 \
         `msg_new`, `msg_set`, or `msg_gset` definition. Messages accept only \
         `#1` through `#4`. Escaped hashes and parameters belonging to an \
         enclosing function definition are distinguished from message parameters. \
         Checks cover recognized executable calls and unexpanded function bodies; \
         stored token lists, expanded text arguments, and unresolved calls stay \
         silent. Report-only: the intended message argument is unknown."
    }

    fn examples(&self) -> &'static [Example] {
        EXAMPLES
    }
    fn interests(&self) -> &'static [SyntaxKind] {
        &[SyntaxKind::COMMAND]
    }

    fn check(&self, el: &SyntaxElement, ctx: &RuleContext<'_>, sink: &mut Vec<Diagnostic>) {
        let Some(node) = el.as_node() else { return };
        if !command_name(node).is_some_and(|name| is_message_definition(&name)) {
            return;
        }
        let Some(call) = ctx.expl3_call(node) else {
            return;
        };
        for &(range, number) in &call.message_parameters {
            sink.push(Diagnostic {
                rule: self.id(),
                severity: self.default_severity(),
                path: Default::default(),
                start: range.start().into(),
                end: range.end().into(),
                message: format!("invalid expl3 message parameter `#{number}`; messages accept only `#1` through `#4`"),
                fix: None,
                related: Vec::new(),
            });
        }
    }
}