mago 1.25.0

A comprehensive suite of PHP tooling inspired by Rust’s approach, providing parsing, linting, formatting, and more through a unified CLI and library interface.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Issue → LSP `Diagnostic` conversion and publish helpers.

use foldhash::HashMap;
use tower_lsp::lsp_types::Diagnostic;
use tower_lsp::lsp_types::DiagnosticRelatedInformation;
use tower_lsp::lsp_types::DiagnosticSeverity;
use tower_lsp::lsp_types::Location;
use tower_lsp::lsp_types::NumberOrString;
use tower_lsp::lsp_types::Url;

use mago_analyzer::analysis_result::AnalysisResult;
use mago_database::Database;
use mago_database::DatabaseReader;
use mago_reporting::Annotation;
use mago_reporting::AnnotationKind;
use mago_reporting::Issue;
use mago_reporting::IssueCollection;
use mago_reporting::Level;

use crate::language_server::position::range_at_offsets;

/// Convert an [`AnalysisResult`] (analyzer issues) plus an iterator of
/// linter issues into a per-file diagnostic map keyed by URL.
///
/// Issues without a primary annotation, or whose file has no on-disk path,
/// are dropped; the LSP client cannot navigate to them.
pub fn build_diagnostics<'a, I>(
    database: &Database<'_>,
    result: &AnalysisResult,
    lint_issues: I,
) -> HashMap<Url, Vec<Diagnostic>>
where
    I: IntoIterator<Item = &'a IssueCollection>,
{
    let mut by_url: HashMap<Url, Vec<Diagnostic>> = HashMap::default();

    for issue in result.issues.iter() {
        push_issue(database, &mut by_url, issue);
    }

    for collection in lint_issues {
        for issue in collection.iter() {
            push_issue(database, &mut by_url, issue);
        }
    }

    by_url
}

fn push_issue(database: &Database<'_>, by_url: &mut HashMap<Url, Vec<Diagnostic>>, issue: &Issue) {
    let Some(annotation) = primary_annotation(issue) else {
        return;
    };

    let Ok(file) = database.get(&annotation.span.file_id) else {
        return;
    };

    let Some(path) = &file.path else {
        return;
    };

    let Ok(url) = Url::from_file_path(path) else {
        return;
    };

    let range = range_at_offsets(&file, annotation.span.start.offset, annotation.span.end.offset);

    let related = secondary_related_info(database, issue);
    let message = render_message(issue);

    by_url.entry(url).or_default().push(Diagnostic {
        range,
        severity: Some(level_to_severity(issue.level)),
        code: issue.code.clone().map(NumberOrString::String),
        source: Some("mago".into()),
        message,
        related_information: if related.is_empty() { None } else { Some(related) },
        ..Diagnostic::default()
    });
}

fn render_message(issue: &Issue) -> String {
    let mut out = issue.message.clone();
    for note in &issue.notes {
        out.push_str("\n\nnote: ");
        out.push_str(note);
    }
    if let Some(help) = &issue.help {
        out.push_str("\n\nhelp: ");
        out.push_str(help);
    }
    out
}

fn secondary_related_info(database: &Database<'_>, issue: &Issue) -> Vec<DiagnosticRelatedInformation> {
    let mut related = Vec::new();

    for annotation in &issue.annotations {
        if matches!(annotation.kind, AnnotationKind::Primary) {
            continue;
        }

        let Ok(file) = database.get(&annotation.span.file_id) else {
            continue;
        };
        let Some(path) = &file.path else {
            continue;
        };
        let Ok(url) = Url::from_file_path(path) else {
            continue;
        };

        let range = range_at_offsets(&file, annotation.span.start.offset, annotation.span.end.offset);
        let message = annotation.message.clone().unwrap_or_default().to_string();

        related.push(DiagnosticRelatedInformation { location: Location { uri: url, range }, message });
    }

    related
}

fn primary_annotation(issue: &Issue) -> Option<&Annotation> {
    issue
        .annotations
        .iter()
        .find(|annotation| matches!(annotation.kind, AnnotationKind::Primary))
        .or_else(|| issue.annotations.first())
}

#[must_use]
pub fn level_to_severity(level: Level) -> DiagnosticSeverity {
    match level {
        Level::Error => DiagnosticSeverity::ERROR,
        Level::Warning => DiagnosticSeverity::WARNING,
        Level::Help => DiagnosticSeverity::HINT,
        Level::Note => DiagnosticSeverity::INFORMATION,
    }
}