Skip to main content

voom/
lib.rs

1//! voom — fast, safe, parallel build-artifact pruning.
2//!
3//! The library half of the `voom` binary. Everything testable lives here; `main.rs` is a
4//! thin shell that parses arguments, dispatches, and maps errors to exit codes.
5//!
6//! The pipeline is `scan -> classify -> policy -> delete -> report`; see
7//! `adrs/0001-mission-and-scope.md` for scope and the ADRs it references for each stage.
8//!
9//! Two invariants carry the whole design and are covered by regression tests:
10//!
11//! - The directory walker runs with **all** ignore handling disabled — build artifacts are
12//!   precisely what `.gitignore` lists (`adrs/0005-traversal-and-parallelism.md`).
13//! - Nothing is deleted without a marker file proving its ecosystem
14//!   (`adrs/0002-marker-anchored-classification.md`).
15
16/// The version of the `voom` crate, as published.
17pub const VERSION: &str = env!("CARGO_PKG_VERSION");
18
19pub mod caches;
20pub mod catalog;
21pub mod classify;
22pub mod error;
23pub mod names;
24pub mod scan;
25
26mod io;
27mod limits;
28
29pub mod bazel;
30pub mod claude;
31pub mod cli;
32pub mod config;
33pub mod delete;
34pub mod docker;
35pub mod git;
36pub mod policy;
37pub mod report;
38pub mod run;
39pub mod size;
40pub mod suggest;
41pub mod tagged;
42#[cfg(unix)]
43mod tree;
44// The integration suites cannot see a `#[cfg(test)]` module of the library they link
45// against, and two copies of a fixture helper drift — a snapshot that handled symlinks or
46// separators differently in one suite would have it trusting output the other could not
47// produce. The `test-support` feature exposes the one copy; `cargo test` turns it on through
48// the self dev-dependency.
49#[cfg(any(test, feature = "test-support"))]
50pub mod testing;
51pub mod watch;
52pub mod worktrees;