mago-analyzer 1.47.1

A PHP static analyzer that can detect type errors in PHP code, and provide suggestions for fixing them.
Documentation 
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

use mago_extension::PayloadError;
use mago_extension::WorkerError;

#[derive(Debug)]
pub enum ExternalAnalyzerError {
    InitializationUnavailable,
    InitializationPanicked,
    Worker(WorkerError),
    Protocol(String),
    InconsistentRegistration,
    InconsistentInitialization,
    DuplicateExtension(String),
    DuplicatePluginSelector { selector: String, first: String, second: String },
}

impl ExternalAnalyzerError {
    #[must_use]
    pub fn protocol(message: impl Into<String>) -> Self {
        Self::Protocol(message.into())
    }
}

impl std::fmt::Display for ExternalAnalyzerError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::InitializationUnavailable => {
                formatter.write_str("external analyzer initialization thread is unavailable")
            }
            Self::InitializationPanicked => formatter.write_str("external analyzer initialization thread panicked"),
            Self::Worker(error) => write!(formatter, "external analyzer worker failed: {error}"),
            Self::Protocol(message) => write!(formatter, "external analyzer protocol error: {message}"),
            Self::InconsistentRegistration => {
                formatter.write_str("workers in an extension pool advertised different analyzer registrations")
            }
            Self::InconsistentInitialization => {
                formatter.write_str("workers in an extension pool produced different analyzer initialization stubs")
            }
            Self::DuplicateExtension(identifier) => {
                write!(formatter, "external extension `{identifier}` is registered by more than one host")
            }
            Self::DuplicatePluginSelector { selector, first, second } => {
                write!(formatter, "analyzer plugin selector `{selector}` is shared by plugins `{first}` and `{second}`")
            }
        }
    }
}

impl std::error::Error for ExternalAnalyzerError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Worker(error) => Some(error),
            _ => None,
        }
    }
}

impl From<WorkerError> for ExternalAnalyzerError {
    fn from(error: WorkerError) -> Self {
        Self::Worker(error)
    }
}

impl From<PayloadError> for ExternalAnalyzerError {
    fn from(error: PayloadError) -> Self {
        Self::Protocol(error.to_string())
    }
}

pub(super) fn protocol(message: impl Into<String>) -> ExternalAnalyzerError {
    ExternalAnalyzerError::Protocol(message.into())
}