boxology-cli-core 0.1.1

Reusable command-line boundary
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

//! Effectful filesystem inputs for the `boxology` command.
//!
//! The CLI's effectful boundary walks a workspace and executes one validated generation plan, while
//! pure planning selects and describes contract-generation candidates. Generation remains pure;
//! execution delegates its writes to the generator writer. Classification of checked-in versus
//! regenerated schema bytes is also pure, as is the check-step classification seam over supplied
//! base-revision and checked-in schema bytes and regeneration comparison over derived artifacts.
//! Trusted lock/fmt/Clippy/test/quality steps use an injectable runner; tool output is outside determinism claims.
#![deny(missing_docs)]
#![forbid(unsafe_code)]

use std::{path::Path, process::Command};

/// The exact argv passed to the one Cargo metadata invocation owned by the CLI.
pub const CARGO_METADATA_ARGS: [&str; 5] =
    ["metadata", "--format-version", "1", "--locked", "--no-deps"];

/// Builds the captured Cargo metadata command for `root`.
pub fn cargo_metadata_command(root: &Path) -> Command {
    let mut command = Command::new("cargo");
    command.args(CARGO_METADATA_ARGS).current_dir(root);
    command
}

mod base;
mod check;
mod classify;
mod compare;
mod execute;
mod generate;
mod runner;
mod walk;
pub use base::{
    BaseDiffInputs, BaseError, BaseInputsError, BaseSchemasError, DefaultBase, GitToolError,
    ResolvedBase, base_diff_inputs, base_diff_inputs_with_candidate, base_package_schemas,
    resolve_base, resolve_default_base,
};
pub use check::{
    CheckClassificationError, ClassifyStepError, DuplicatePackages, PackageSchemas, classify_step,
};
pub use classify::{ClassifyError, classify};
pub use compare::{
    CompareDifference, CompareStepError, DifferenceKind, compare_plans, compare_step,
    composition_step,
};
pub use execute::{ExecuteError, ExecutePlans, Outcome, execute, execute_plans};
pub use generate::{GenerationPlan, PlanError, ResolvedImport, plan};
pub use runner::{
    CapturedOutput, CommandRunner, CommandSpec, QualityCommand, SpawnError, ToolStep, clippy_spec,
    fmt_packages, fmt_spec, lock_spec, quality_specs, run_clippy_step, run_command, run_fmt_step,
    run_lock_step, run_quality_step, run_test_step, test_spec,
};
pub use walk::{WalkError, WalkedWorkspace, walk};