Created
May 3, 2022 21:05
-
-
Save suluke/e0c672492126be0a4f3b4f0e1115d77c to your computer and use it in GitHub Desktop.
Auto-add --version flag in argh based on cargo's PKG_VERSION
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
//! Extend `argh` to be better integrated with the `cargo` ecosystem | |
//! | |
//! For now, this only adds a --version/-V option which causes early-exit. | |
use argh::{FromArgs, TopLevelCommand}; | |
struct ArgsOrVersion<T: FromArgs>(T); | |
impl<T> argh::TopLevelCommand for ArgsOrVersion<T> where T: FromArgs {} | |
impl<T> FromArgs for ArgsOrVersion<T> | |
where | |
T: FromArgs, | |
{ | |
fn from_args(command_name: &[&str], args: &[&str]) -> Result<Self, argh::EarlyExit> { | |
/// Also use argh for catching `--version`-only invocations | |
#[derive(FromArgs)] | |
struct Version { | |
/// print version information and exit | |
#[argh(switch, short = 'V')] | |
pub version: bool, | |
} | |
match Version::from_args(command_name, args) { | |
Ok(v) => { | |
if v.version { | |
Err(argh::EarlyExit { | |
output: format!( | |
"{} {}", | |
command_name.first().unwrap_or(&""), | |
env!("CARGO_PKG_VERSION") | |
), | |
status: Ok(()), | |
}) | |
} else { | |
// seems args are empty | |
T::from_args(command_name, args).map(Self) | |
} | |
} | |
Err(exit) => match exit.status { | |
Ok(()) => { | |
// must have been --help | |
let help = match T::from_args(command_name, &["--help"]) { | |
Ok(_) => unreachable!(), | |
Err(exit) => exit.output, | |
}; | |
Err(argh::EarlyExit { | |
output: format!( | |
"{} -V, --version print version information and exit", | |
help | |
), | |
status: Ok(()), | |
}) | |
} | |
Err(()) => T::from_args(command_name, args).map(Self), | |
}, | |
} | |
} | |
} | |
/// Create a `FromArgs` type from the current process’s `env::args`. | |
/// | |
/// This function will exit early from the current process if argument parsing was unsuccessful or if information like `--help` was requested. | |
/// Error messages will be printed to stderr, and `--help` output to stdout. | |
pub fn from_env<T>() -> T | |
where | |
T: TopLevelCommand, | |
{ | |
argh::from_env::<ArgsOrVersion<T>>().0 | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment