mago 1.25.2

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

//! Language Server Protocol implementation for Mago.
//!
//! Surfaced as the (hidden) `mago language-server` subcommand. The
//! implementation wraps mago's analyzer, linter, and formatter behind a
//! `tower-lsp` dispatch and a long-lived `IncrementalAnalysisService`.
//!
//! # Entry points
//!
//! - [`run`]; speak LSP over `stdin`/`stdout`. Used by the CLI.
//! - [`serve`]; speak LSP over an arbitrary async reader/writer pair.
//!   Used by integration tests via `tokio::io::duplex`.

use std::sync::Arc;

use tokio::io::AsyncRead;
use tokio::io::AsyncWrite;
use tower_lsp::LspService;
use tower_lsp::Server;

mod backend;
mod capabilities;
pub(crate) mod config;
mod diagnostics;
mod document;
mod file_analysis;
mod linter;
mod position;
mod state;
mod workspace;

#[cfg(test)]
mod tests;

pub use backend::Backend;
pub use config::ServerConfig;

/// Run the LSP server on stdin/stdout with the given configuration.
pub async fn run(config: ServerConfig) {
    let stdin = tokio::io::stdin();
    let stdout = tokio::io::stdout();
    serve(stdin, stdout, config).await;
}

/// Run the LSP server on the given async reader/writer.
pub async fn serve<R, W>(reader: R, writer: W, config: ServerConfig)
where
    R: AsyncRead + Unpin,
    W: AsyncWrite + Unpin,
{
    let config = Arc::new(config);
    let (service, socket) = LspService::new(move |client| Backend::new(client, Arc::clone(&config)));
    Server::new(reader, writer, socket).serve(service).await;
}