shipper-cli 0.4.0

CLI adapter for Shipper; install the user-facing `shipper` package unless embedding the adapter.
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

//! Diagnostic finding records and rendering for `shipper doctor`.

use serde::Serialize;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub(super) enum FindingLevel {
    Blocked,
    Warning,
}

impl FindingLevel {
    pub(super) fn as_str(self) -> &'static str {
        match self {
            FindingLevel::Blocked => "blocked",
            FindingLevel::Warning => "warning",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub(super) struct Finding {
    pub id: &'static str,
    pub severity: FindingLevel,
    pub status: FindingLevel,
    pub title: &'static str,
    pub why_it_matters: &'static str,
    pub evidence: String,
    pub try_next: Vec<&'static str>,
    pub docs: Option<&'static str>,
}

pub(super) fn print_findings(findings: &[Finding]) {
    println!();
    println!("Findings:");
    println!("---------");
    if findings.is_empty() {
        println!("  none");
        return;
    }

    for finding in findings {
        println!(
            "  [{}] {} ({})",
            finding.status.as_str(),
            finding.title,
            finding.id
        );
        println!("    status: {}", finding.status.as_str());
        println!("    severity: {}", finding.severity.as_str());
        println!("    why: {}", finding.why_it_matters);
        println!("    evidence: {}", finding.evidence);
        println!("    try next:");
        for step in &finding.try_next {
            println!("      - {step}");
        }
        if let Some(docs) = finding.docs {
            println!("    docs: {docs}");
        }
    }
}