2 unstable releases

0.2.0 Feb 16, 2024
0.1.0 Jan 5, 2024

#542 in Testing

Download history 1860/week @ 2024-08-27 1853/week @ 2024-09-03 1487/week @ 2024-09-10 1796/week @ 2024-09-17 1186/week @ 2024-09-24 1604/week @ 2024-10-01 1183/week @ 2024-10-08 1583/week @ 2024-10-15 2098/week @ 2024-10-22 2224/week @ 2024-10-29 2052/week @ 2024-11-05 1519/week @ 2024-11-12 1346/week @ 2024-11-19 1029/week @ 2024-11-26 1554/week @ 2024-12-03 2688/week @ 2024-12-10

6,845 downloads per month
Used in 12 crates (4 directly)

MIT/Apache

17KB
253 lines

axoprocess

crates.io docs Rust CI

Nicer defaults for invoking CLI Commands.

License

Licensed under either of

at your option.


lib.rs:

Nicer defaults for invoking CLI Commands.

[Cmd][] is a wrapper around std::process::Command with largely the same API except we want to be able to:

  • Produce nicer errors that explain what was being run (using thiserror/miette)
  • Log every time the command is executed (defaults tracing::info!)
  • Automatically check the return status's success() (can be opted-out per Cmd)

If you like the defaults then mostly all you need to know is that Cmd::new takes a second argument for "what should I tell the user this Command was trying to do at a high level".

This lets us turn the following logic:

#
let mut cmd = Command::new("cargo");
cmd.arg("-V");

info!("exec {:?}", cmd);

let output = cmd.output()
  .map_err(|cause| MyCmdError {
      desc: "failed to get your cargo toolchain's version",
      cause
  })?;

if !output.status.success() {
    Err(MyStatusError {
        desc: "failed to get your cargo toolchain's version",
        status: output.status
    })?;
}

println!("version was {}", String::from_utf8_lossy(&output.stdout));

Into this:

let output = Cmd::new("cargo", "get your cargo toolchain's version")
  .arg("-V")
  .output()?;

println!("version was {}", String::from_utf8_lossy(&output.stdout));

Which is, a lot nicer!

Dependencies

~2–2.7MB
~46K SLoC