pinoc 0.3.6

A CLI tool for setting up pinocchio program project
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

use crate::check::contract::{Confidence, Finding, Severity};
use anyhow::Result;
use std::io::IsTerminal;

fn confidence_name(c: Confidence) -> &'static str {
    match c {
        Confidence::Heuristic => "heuristic",
        Confidence::Likely => "likely",
        Confidence::Definite => "definite",
    }
}

fn color(code: &str, on: bool) -> &str {
    if on {
        code
    } else {
        ""
    }
}

pub fn render_human(findings: &[Finding], below_threshold: &[&str], threshold: Confidence) {
    let tty = std::io::stdout().is_terminal();
    let (red, yellow, blue, dim, bold, reset) = (
        color("\x1b[31m", tty),
        color("\x1b[33m", tty),
        color("\x1b[34m", tty),
        color("\x1b[2m", tty),
        color("\x1b[1m", tty),
        color("\x1b[0m", tty),
    );

    if findings.is_empty() {
        println!("✅ No issues found.");
        print_below_threshold(below_threshold, threshold, dim, reset);
        return;
    }

    let mut deny = 0;
    let mut warn = 0;
    for f in findings {
        let (badge, tint) = match f.severity {
            Severity::Deny => {
                deny += 1;
                ("deny", red)
            }
            Severity::Warn => {
                warn += 1;
                ("warn", yellow)
            }
            Severity::Info => ("info", blue),
        };
        println!(
            "{tint}{bold}{badge}{reset} {tint}{}{reset} {dim}{}:{}:{}{reset}",
            f.code, f.span.file, f.span.line, f.span.col
        );
        println!("    {}", f.evidence);
        if let Some(fix) = &f.fix {
            println!("    {dim}fix:{reset} {fix}");
        }
    }
    println!("\n{deny} deny, {warn} warn");
    print_below_threshold(below_threshold, threshold, dim, reset);
}

/// Report how many findings were hidden only for being below the threshold,
/// and which codes, so `--deny <code>` can be used without guessing.
fn print_below_threshold(hidden: &[&str], threshold: Confidence, dim: &str, reset: &str) {
    if hidden.is_empty() {
        return;
    }
    let count = hidden.len();
    let plural = if count == 1 { "finding" } else { "findings" };
    let mut codes: Vec<&str> = hidden.to_vec();
    codes.sort_unstable();
    codes.dedup();
    println!(
        "{dim}{count} lower-confidence {plural} ({}) below the `{}` threshold hidden; lower `confidence_threshold` (or `--deny <code>`) to show them.{reset}",
        codes.join(", "),
        confidence_name(threshold)
    );
}

pub fn render_json(findings: &[Finding]) -> Result<()> {
    println!("{}", serde_json::to_string_pretty(findings)?);
    Ok(())
}