skif-cli 0.4.0

Command-line interface for skif, a dependency and package-manager linter for JS/TS monorepos.
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
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

//! knip's run diagnostics on stderr: `--debug` (what was loaded), `--performance` (the phase timings), `--duration`
//! (the wall time of the run) and `--memory` (the peak resident set size, Linux only).

use std::path::Path;
use std::time::Instant;

use skif::{Target, slash};
use skif_report::escape_controls;

use crate::args::LintArgs;
use crate::output::stderr_line;

/// What the diagnostic flags measure over one run.
pub struct Trace {
    start: Instant,
    duration: bool,
    memory: bool,
}

impl Trace {
    /// Starts measuring; `--performance` (or `--debug`) switches the phase timings on, to stderr.
    pub fn start(args: &LintArgs) -> Self {
        if args.performance || args.debug {
            let _ = skif_core::timing::enable_stderr();
        }
        Self {
            start: Instant::now(),
            duration: args.duration,
            memory: args.memory,
        }
    }

    /// Prints the duration and the peak memory the flags asked for.
    pub fn finish(&self) {
        if self.duration {
            stderr_line(&format!(
                "skif: finished in {:.1} ms",
                self.start.elapsed().as_secs_f64() * 1000.0
            ));
        }
        if self.memory {
            stderr_line(&peak_memory().map_or_else(
                || "skif: peak memory is only measured on Linux".to_owned(),
                |kib| format!("skif: peak memory (RSS) {}.{} MiB", kib / 1024, kib % 1024 * 10 / 1024),
            ));
        }
    }
}

/// The peak resident set size of this process in KiB, from `VmHWM` in `/proc/self/status`.
#[cfg(target_os = "linux")]
fn peak_memory() -> Option<u64> {
    let status = std::fs::read_to_string("/proc/self/status").ok()?;
    parse_vm_hwm(&status)
}

#[cfg(not(target_os = "linux"))]
const fn peak_memory() -> Option<u64> {
    None
}

#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
fn parse_vm_hwm(status: &str) -> Option<u64> {
    status
        .lines()
        .find_map(|line| line.strip_prefix("VmHWM:"))
        .and_then(|rest| rest.trim().trim_end_matches("kB").trim().parse().ok())
}

/// `--debug`: every root of the run with the configuration files it is built from and its packages.
pub fn debug_targets(base: &Path, targets: &[Target]) {
    for target in targets {
        let root = target.root.strip_prefix(base).unwrap_or(&target.root);
        let root = if root.as_os_str().is_empty() {
            ".".to_owned()
        } else {
            slash(root)
        };
        stderr_line(&format!("skif debug: root {}", escape_controls(&root)));
        if target.sources.is_empty() {
            stderr_line("skif debug:   configuration: defaults (no file)");
        }
        for source in &target.sources {
            stderr_line(&format!(
                "skif debug:   configuration: {}",
                escape_controls(&slash(&source.path))
            ));
        }
        let manager = target
            .workspace
            .package_manager
            .and_then(|manager| serde_json::to_value(manager).ok())
            .and_then(|value| value.as_str().map(str::to_owned))
            .unwrap_or_else(|| "none detected".to_owned());
        stderr_line(&format!("skif debug:   package manager: {manager}"));
        for package in target.workspace.all_packages() {
            let dir = if package.dir.as_os_str().is_empty() {
                ".".to_owned()
            } else {
                slash(&package.dir)
            };
            stderr_line(&format!(
                "skif debug:   package {} ({})",
                escape_controls(package.name.as_deref().unwrap_or("<unnamed>")),
                escape_controls(&dir)
            ));
        }
    }
}

#[cfg(test)]
mod tests {
    use super::parse_vm_hwm;

    #[test]
    fn the_peak_is_read_from_vm_hwm() {
        assert_eq!(
            parse_vm_hwm("Name:\tskif\nVmHWM:\t   12345 kB\nVmRSS:\t 1 kB\n"),
            Some(12345)
        );
        assert_eq!(parse_vm_hwm("Name:\tskif\n"), None);
    }
}