nu-lint 1.2.0

Linter for Nu shell scripts that helpfully suggests improvements
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

/// Initialize logger for tests. Output is captured and only shown on failure.
/// Only shows debug+ messages from nu-lint code.
pub fn init_test_log() {
    use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};

    // Set up log -> tracing bridge
    tracing_log::LogTracer::init().ok();

    let filter = EnvFilter::new("nu_lint=debug");

    let _ = tracing_subscriber::registry()
        .with(filter)
        .with(fmt::layer().with_test_writer().with_target(false))
        .try_init();
}

#[cfg(feature = "lsp")]
pub use tracing_appender::non_blocking::WorkerGuard as LogGuard;

/// Initialize file-based logger for LSP mode with daily rotation.
/// Logs are written to `~/.cache/nu-lint/lsp.YYYY-MM-DD.log`.
/// Returns a guard that must be kept alive for the duration of logging.
#[cfg(feature = "lsp")]
#[must_use]
pub fn init_lsp_log() -> Option<LogGuard> {
    use tracing::subscriber::set_global_default;
    use tracing_appender::{non_blocking, rolling};
    use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt};

    // Set up log -> tracing bridge
    tracing_log::LogTracer::init().ok();

    let log_dir = dirs::cache_dir().map(|d| d.join("nu-lint"))?;
    let file_appender = rolling::daily(log_dir, "lsp.log");
    let (non_blocking, guard) = non_blocking(file_appender);

    let filter = EnvFilter::new("nu_lint=debug");
    let subscriber = tracing_subscriber::registry().with(filter).with(
        fmt::layer()
            .with_writer(non_blocking)
            .with_ansi(true)
            .with_file(true)
            .with_line_number(true)
            .with_target(false),
    );

    set_global_default(subscriber).ok();
    Some(guard)
}