Skip to main content

Crate voom

Crate voom 

Source
Expand description

voom — fast, safe, parallel build-artifact pruning.

The library half of the voom binary. Everything testable lives here; main.rs is a thin shell that parses arguments, dispatches, and maps errors to exit codes.

The pipeline is scan -> classify -> policy -> delete -> report; see adrs/0001-mission-and-scope.md for scope and the ADRs it references for each stage.

Two invariants carry the whole design and are covered by regression tests:

  • The directory walker runs with all ignore handling disabled — build artifacts are precisely what .gitignore lists (adrs/0005-traversal-and-parallelism.md).
  • Nothing is deleted without a marker file proving its ecosystem (adrs/0002-marker-anchored-classification.md).

Modules§

caches
Machine-global tool caches and installed toolchains, which voom leaves alone.
catalog
The built-in ecosystem catalog: the table that says which directories are build output, and what proves it.
classify
Marker anchoring: candidate + markers -> verdict.
cli
Argument parsing and command dispatch.
config
Hierarchical TOML configuration (ADR 0004).
delete
The safety rails, and the actual removal.
error
Typed library errors.
git
Git housekeeping — the maintenance git itself already considers safe.
names
Allocation-free file-name pattern matching.
policy
Keep policies: the rules that hold an artifact back after it has been proven.
report
The result set, and the two renderers over it.
run
The pipeline: scan -> classify -> policy -> size -> delete -> report.
scan
The ignore-blind parallel walker.
size
Recursive size accounting.
watch
Watch mode: keep a tree pruned as work moves on.

Constants§

VERSION
The version of the voom crate, as published.