zenith-tool 0.0.2

The Zenith command-line interface (the `zenith` binary) for the design-document toolchain.
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

//! Logic for `zenith workspace finalize`.

use std::path::Path;

use zenith_session::adapter::OsFs;
use zenith_session::{FinalizeReport, StorePaths, finalize_candidates};

use crate::commands::serialize_pretty;
use crate::commands::workspace::scratch::open_store;
use crate::history::read_doc_id;

// ── View type for JSON output ─────────────────────────────────────────────────

// FinalizeReport derives Serialize in zenith-session, so we use it directly.

// ── finalize ──────────────────────────────────────────────────────────────────

/// Apply each rejected candidate's cleanup-policy to the scratch store and
/// return a human-readable or JSON report.
pub fn finalize(doc_path: &Path, json: bool) -> Result<String, String> {
    let paths = open_store()?;
    finalize_in(&paths, doc_path, json)
}

/// Testable variant with an explicit store root.
pub fn finalize_in(paths: &StorePaths, doc_path: &Path, json: bool) -> Result<String, String> {
    let doc_id = read_doc_id(doc_path)?;
    let fs = OsFs;
    let report = finalize_candidates(&fs, paths, &doc_id).map_err(|e| e.message)?;

    if json {
        Ok(serialize_pretty(&report))
    } else {
        Ok(format_report(&report))
    }
}

// ── formatting ────────────────────────────────────────────────────────────────

fn format_report(report: &FinalizeReport) -> String {
    if report.deleted.is_empty() {
        format!(
            "finalized: nothing to delete, {} candidate(s) kept",
            report.kept
        )
    } else {
        format!(
            "finalized: deleted {} candidate(s) [{}], {} kept",
            report.deleted.len(),
            report.deleted.join(", "),
            report.kept,
        )
    }
}