lspf 1.0.1

A Rust framework for building extensible LSP language servers
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
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

//! The log format every example server installs.
//!
//! An example is launched by an editor as often as by a shell, so it honours
//! `LSPF_LOG_FORMAT`: `json` writes one machine-readable event per line, and
//! any other value writes the compact text below.

use std::fmt;
use std::time::Instant;

use tracing::{Event, Subscriber};
use tracing_subscriber::EnvFilter;
use tracing_subscriber::fmt::format::Writer;
use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields};
use tracing_subscriber::registry::LookupSpan;

/// Install the process-wide subscriber.
///
/// Logs go to stderr on every example: the stdio ones carry the LSP wire
/// protocol on stdout, and a socket example is observed through stderr by a
/// client that did not spawn it.
pub(crate) fn init() {
    let filter = EnvFilter::from_default_env();
    if std::env::var("LSPF_LOG_FORMAT").as_deref() == Ok("json") {
        tracing_subscriber::fmt()
            .with_writer(std::io::stderr)
            .with_env_filter(filter)
            .json()
            .flatten_event(true)
            .with_current_span(true)
            .with_span_list(false)
            .init();
        return;
    }
    tracing_subscriber::fmt()
        .with_writer(std::io::stderr)
        .with_env_filter(filter)
        // Editor output channels display ANSI bytes as visible symbols.
        .with_ansi(false)
        .event_format(Text::new())
        .init();
}

/// One line per event, sized for an editor output channel.
///
/// The framework records `connection_id`, `direction`, `kind`, `method`, and
/// `request_id` on the event itself and again on the enclosing span, so the
/// default format prints each of them twice. This one keeps the span names,
/// which place a handler's own event in the call that produced it, and drops
/// the span fields the event already carries. It drops the target for the same
/// reason — `lspf::telemetry` on every framework line — and measures time from
/// process start, so the gap between two lines reads as a latency instead of
/// as a difference between two UTC dates.
struct Text {
    start: Instant,
}

impl Text {
    fn new() -> Self {
        Self {
            start: Instant::now(),
        }
    }
}

impl<S, N> FormatEvent<S, N> for Text
where
    S: Subscriber + for<'a> LookupSpan<'a>,
    N: for<'a> FormatFields<'a> + 'static,
{
    fn format_event(
        &self,
        ctx: &FmtContext<'_, S, N>,
        mut writer: Writer<'_>,
        event: &Event<'_>,
    ) -> fmt::Result {
        // Seconds with a fixed width and unit: `Duration`'s own `Debug` picks
        // between µs, ms, and s per line, which unaligns the column that a
        // reader scans down.
        write!(
            writer,
            "{:>8.3}s {:<5} ",
            self.start.elapsed().as_secs_f64(),
            event.metadata().level(),
        )?;
        if let Some(scope) = ctx.event_scope() {
            let mut seen = false;
            for span in scope.from_root() {
                write!(writer, "{}:", span.metadata().name())?;
                seen = true;
            }
            if seen {
                writer.write_char(' ')?;
            }
        }
        ctx.format_fields(writer.by_ref(), event)?;
        writeln!(writer)
    }
}