sitevet-cli 0.1.0

Command-line website audits built on the sitevet library.
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

//! Terminal output on stderr. Colour follows NO_COLOR, CLICOLOR and whether stderr is a terminal
//! (anstream decides), `--plain` turns it off, and every colour sits next to a status word.

use anstream::eprintln;
use anstyle::{AnsiColor, Style};

use crate::args::Cli;

pub fn init(cli: &Cli) {
    if cli.plain {
        anstream::ColorChoice::Never.write_global();
    }
    let filter = std::env::var("SITEVET_LOG").ok().or_else(|| cli.verbose.then(|| "sitevet=debug".to_string()));
    if let Some(filter) = filter {
        tracing_subscriber::fmt()
            .with_env_filter(tracing_subscriber::EnvFilter::new(filter))
            .with_writer(std::io::stderr)
            .with_ansi(!cli.plain && std::env::var_os("NO_COLOR").is_none())
            .init();
    }
}

pub const GREEN: Style = AnsiColor::Green.on_default();
pub const YELLOW: Style = AnsiColor::Yellow.on_default();
pub const RED: Style = AnsiColor::Red.on_default();
pub const BOLD: Style = Style::new().bold();
pub const DIM: Style = Style::new().dimmed();

/// Status word and colour for a score: 90 and up PASS, 50 and up WARN, below FAIL.
pub fn score_word(score: u8) -> (&'static str, Style) {
    match score {
        90..=100 => ("PASS", GREEN),
        50..=89 => ("WARN", YELLOW),
        _ => ("FAIL", RED),
    }
}

/// `error: <cause>` and a hint for the errors a user can fix.
pub fn error(e: &anyhow::Error) {
    let causes: Vec<String> = e.chain().map(ToString::to_string).collect();
    eprintln!("{RED}{BOLD}error:{BOLD:#}{RED:#} {}", causes.join(": "));
    let hint = match e.chain().find_map(|c| c.downcast_ref::<sitevet::Error>()) {
        Some(sitevet::Error::InvalidUrl { .. }) => Some("use a full URL such as https://example.com"),
        Some(sitevet::Error::StartPageUnreachable { .. }) => {
            Some("check the URL, your connection, and that the site is up")
        }
        Some(sitevet::Error::NotHtml { .. }) => Some("start from an HTML page, such as the home page"),
        Some(sitevet::Error::InvalidOptions { .. }) => {
            Some("check the flag or the key in sitevet.toml (sitevet init writes every key)")
        }
        _ => None,
    };
    if let Some(hint) = hint {
        eprintln!("{DIM}hint: {hint}{DIM:#}");
    }
}