bito 1.0.0

Quality gate tooling for building-in-the-open artifacts
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

//! Completeness command — validate document sections against a template.

use anyhow::{Context, bail};
use camino::Utf8PathBuf;
use clap::Args;
use owo_colors::OwoColorize;
use tracing::{debug, instrument};

use bito_core::completeness::{self, SectionStatus};

use super::read_input_file;

/// Arguments for the `completeness` subcommand.
#[derive(Args, Debug)]
pub struct CompletenessArgs {
    /// File to analyze.
    pub file: Utf8PathBuf,

    /// Template to validate against (adr, handoff, design-doc).
    #[arg(long)]
    pub template: String,
}

/// Check that a document has all required sections for a template.
#[instrument(name = "cmd_completeness", skip_all, fields(file = %args.file, template = %args.template))]
pub fn cmd_completeness(
    args: CompletenessArgs,
    global_json: bool,
    custom_templates: Option<&std::collections::HashMap<String, Vec<String>>>,
    max_input_bytes: Option<usize>,
) -> anyhow::Result<()> {
    debug!(file = %args.file, template = %args.template, "executing completeness command");

    let content = read_input_file(&args.file, max_input_bytes)?;

    let report = completeness::check_completeness(&content, &args.template, custom_templates)
        .with_context(|| format!("failed to check completeness of {}", args.file))?;

    if global_json {
        println!("{}", serde_json::to_string_pretty(&report)?);
    } else if report.pass {
        println!(
            "{} {} ({} completeness check)",
            "PASS:".green(),
            args.file,
            args.template,
        );
    } else {
        let mut issues = Vec::new();
        for section in &report.sections {
            match section.status {
                SectionStatus::Missing => {
                    issues.push(format!("  {} ## {}", "MISSING:".red(), section.name));
                }
                SectionStatus::Empty => {
                    issues.push(format!(
                        "  {}   ## {} (contains only placeholders or whitespace)",
                        "EMPTY:".yellow(),
                        section.name,
                    ));
                }
                SectionStatus::Present => {}
            }
        }
        let detail = issues.join("\n");
        bail!(
            "{} ({} completeness check)\n{}",
            args.file,
            args.template,
            detail,
        );
    }

    Ok(())
}