Function parse_phpcs_message

src/phpcs.rs:290–340

Parse a single PHPCS message object into an LSP `Diagnostic`.

(msg: &serde_json::Value)

/// Parse a single PHPCS message object into an LSP `Diagnostic`.
fn parse_phpcs_message(msg: &serde_json::Value) -> Option<Diagnostic> {
    let message = msg.get("message")?.as_str()?;
    let line = msg.get("line").and_then(|l| l.as_u64()).unwrap_or(1);
    let lsp_line = line.saturating_sub(1) as u32;

    // PHPCS "source" is the sniff name, e.g. "PSR2.Methods.FunctionCallSignature.Indent"
    let source_code = msg
        .get("source")
        .and_then(|s| s.as_str())
        .unwrap_or("phpcs");

    // PHPCS "type" is "ERROR" or "WARNING"
    let severity = match msg.get("type").and_then(|t| t.as_str()) {
        Some("ERROR") => DiagnosticSeverity::ERROR,
        _ => DiagnosticSeverity::WARNING,
    };

    let fixable = msg
        .get("fixable")
        .and_then(|f| f.as_bool())
        .unwrap_or(false);

    let data = Some(serde_json::json!({ "fixable": fixable }));

    // PHPCS reports a single `column` per message, but its meaning
    // varies by sniff: for `LineLength.TooLong` it is the total line
    // length (the *end*), for indentation sniffs it is the offending
    // token start, etc.  Because there is no reliable way to derive a
    // precise range from a single ambiguous position, we underline the
    // full line — the same strategy PHPStan uses.
    Some(Diagnostic {
        range: Range {
            start: Position {
                line: lsp_line,
                character: 0,
            },
            end: Position {
                line: lsp_line,
                character: u32::MAX,
            },
        },
        severity: Some(severity),
        code: Some(NumberOrString::String(source_code.to_string())),
        code_description: None,
        source: Some("phpcs".to_string()),
        message: message.to_string(),
        related_information: None,
        tags: None,
        data,
    })
}

/// Check whether two file paths refer to the same file.
///