rrubocop 0.8.14

10x faster RuboCop drop-in. Same output format and configs, without maintaining RuboCop gems.
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

//! LSP-shaped offense JSON (matches RuboCop MCP / LSP diagnostics).

use serde_json::{json, Value};

use crate::diagnostic::{Diagnostic, Severity};

/// Map rrubocop severity to LSP DiagnosticSeverity.
fn lsp_severity(s: Severity) -> u8 {
    match s {
        Severity::Fatal | Severity::Error => 1,
        Severity::Warning => 2,
        Severity::Convention => 3,
    }
}

/// RuboCop docs href when the department is on docs.rubocop.org.
fn docs_href(cop_name: &str) -> Option<String> {
    let (dept, rest) = cop_name.split_once('/')?;
    let dept_l = dept.to_lowercase();
    let name_l = rest.replace('_', "").to_lowercase();
    // Core + common plugin pages live under rubocop.org cops_<dept>.
    Some(format!(
        "https://docs.rubocop.org/rubocop/cops_{dept_l}.html#{dept_l}{name_l}"
    ))
}

fn offense_message(d: &Diagnostic) -> String {
    if d.correctable {
        d.message.clone()
    } else {
        format!("{}\n\nThis offense is not autocorrectable.\n", d.message)
    }
}

/// One offense as returned by RuboCop `LSP::Runtime#offenses` JSON.
pub(crate) fn to_lsp_offense(d: &Diagnostic) -> Value {
    let line = d.location.line.saturating_sub(1);
    let start = d.location.column;
    let end = start + d.highlight_length.max(1);
    let mut obj = json!({
        "range": {
            "start": { "line": line, "character": start },
            "end": { "line": line, "character": end }
        },
        "severity": lsp_severity(d.severity),
        "source": "RuboCop",
        "code": d.cop_name,
        "message": offense_message(d),
        "data": { "correctable": d.correctable }
    });
    if let Some(href) = docs_href(&d.cop_name) {
        obj.as_object_mut()
            .unwrap()
            .insert("codeDescription".into(), json!({ "href": href }));
    }
    obj
}

pub(crate) fn offenses_json(diags: &[Diagnostic]) -> String {
    serde_json::to_string(&diags.iter().map(to_lsp_offense).collect::<Vec<_>>())
        .unwrap_or_else(|_| "[]".into())
}