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

use rowan::TextRange;
use serde::Deserialize;

use super::{
    ExternalLinterParser, LinterError, ParseContext, line_col_to_offset,
    map_concatenated_offset_to_original_with_end_boundary,
};
use crate::linter::diagnostics::{Diagnostic, DiagnosticOrigin, Location};

#[derive(Debug, Deserialize)]
struct EslintFileReport {
    messages: Vec<EslintMessage>,
}

#[derive(Debug, Deserialize)]
struct EslintMessage {
    #[serde(default, rename = "ruleId")]
    rule_id: Option<String>,
    severity: i64,
    message: String,
    line: usize,
    column: usize,
    #[serde(default, rename = "endLine")]
    end_line: Option<usize>,
    #[serde(default, rename = "endColumn")]
    end_column: Option<usize>,
    #[serde(default)]
    fix: Option<EslintFix>,
    #[serde(default)]
    suggestions: Vec<EslintSuggestion>,
}

#[derive(Debug, Deserialize)]
struct EslintSuggestion {
    fix: EslintFix,
}

#[derive(Debug, Deserialize)]
struct EslintFix {
    range: [usize; 2],
    text: String,
}

pub(crate) struct EslintParser;

impl ExternalLinterParser for EslintParser {
    const NAME: &'static str = "eslint";

    fn parse(ctx: &ParseContext<'_>) -> Result<Vec<Diagnostic>, LinterError> {
        use crate::linter::diagnostics::{Edit, Fix};

        let reports: Vec<EslintFileReport> = serde_json::from_str(ctx.output)
            .map_err(|e| LinterError::ParseError(format!("invalid eslint JSON: {}", e)))?;

        let mut diagnostics = Vec::new();
        for report in reports {
            for msg in report.messages {
                let line = msg.line;
                let column = msg.column;
                let start_offset = line_col_to_offset(ctx.original_input, line, column)
                    .unwrap_or(ctx.original_input.len());
                let end_line = msg.end_line.unwrap_or(line);
                let end_column = msg.end_column.unwrap_or(column.saturating_add(1));
                let end_offset = line_col_to_offset(ctx.original_input, end_line, end_column)
                    .unwrap_or(ctx.original_input.len());

                let location = Location {
                    line,
                    column,
                    range: TextRange::new((start_offset as u32).into(), (end_offset as u32).into()),
                };

                let code = msg.rule_id.unwrap_or_else(|| "eslint".to_string());
                let diagnostic = match msg.severity {
                    2 => Diagnostic::error(location, code, msg.message),
                    1 => Diagnostic::info(location, code, msg.message),
                    _ => Diagnostic::warning(location, code, msg.message),
                }
                .with_origin(DiagnosticOrigin::External);
                let selected_fix = msg
                    .fix
                    .or_else(|| msg.suggestions.into_iter().next().map(|s| s.fix));
                let mapped_fix =
                    if let (Some(mappings), Some(eslint_fix)) = (ctx.mappings, selected_fix) {
                        let fix_start = map_concatenated_offset_to_original_with_end_boundary(
                            eslint_fix.range[0],
                            mappings,
                        );
                        let fix_end = map_concatenated_offset_to_original_with_end_boundary(
                            eslint_fix.range[1],
                            mappings,
                        );
                        if let (Some(fix_start), Some(fix_end)) = (fix_start, fix_end) {
                            Some(Fix {
                                message: "Apply ESLint fix".to_string(),
                                edits: vec![Edit {
                                    range: TextRange::new(
                                        (fix_start as u32).into(),
                                        (fix_end as u32).into(),
                                    ),
                                    replacement: eslint_fix.text,
                                }],
                            })
                        } else {
                            None
                        }
                    } else {
                        None
                    };

                diagnostics.push(if let Some(fix) = mapped_fix {
                    diagnostic.with_fix(fix)
                } else {
                    diagnostic
                });
            }
        }

        Ok(diagnostics)
    }
}