ecoppens/colmena
1
0
Fork 0
forked from DGNum/colmena
Code Pull requests Activity

cli: Re-order arguments in help message

Browse source
This commit is contained in:
Zhaofeng Li 2021-12-04 01:03:26 -08:00
parent f253e6eb18
commit 9cd2af9438
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/cli.rs
View file

@ -50,6 +50,14 @@ For a sample configuration, check the manual at <{}>.
}; };
} }
/// Display order in `--help` for arguments that should be shown first.
///
/// Currently reserved for -f/--config.
const HELP_ORDER_FIRST: usize = 100;
/// Display order in `--help` for arguments that are not very important.
const HELP_ORDER_LOW: usize = 2000;
macro_rules! register_command { macro_rules! register_command {
($module:ident, $app:ident) => { ($module:ident, $app:ident) => {
$app = $app.subcommand(command::$module::subcommand()); $app = $app.subcommand(command::$module::subcommand());
@ -92,6 +100,8 @@ pub fn build_cli(include_internal: bool) -> App<'static, 'static> {
.long("config") .long("config")
.value_name("CONFIG") .value_name("CONFIG")
.help("Path to a Hive expression, a flake.nix, or a Nix Flake URI") .help("Path to a Hive expression, a flake.nix, or a Nix Flake URI")
.long_help(&CONFIG_HELP)
.display_order(HELP_ORDER_FIRST)
// The default value is a lie (sort of)! // The default value is a lie (sort of)!
// //
@ -100,7 +110,6 @@ pub fn build_cli(include_internal: bool) -> App<'static, 'static> {
// or "hive.nix". This behavior is disabled if --config/-f // or "hive.nix". This behavior is disabled if --config/-f
// is explicitly supplied by the user (occurrences_of > 0). // is explicitly supplied by the user (occurrences_of > 0).
.default_value("hive.nix") .default_value("hive.nix")
.long_help(&CONFIG_HELP)
.global(true)) .global(true))
.arg(Arg::with_name("show-trace") .arg(Arg::with_name("show-trace")
.long("show-trace") .long("show-trace")
@ -115,6 +124,7 @@ pub fn build_cli(include_internal: bool) -> App<'static, 'static> {
It's also possible to specify the preference using environment variables. See <https://bixense.com/clicolors>. It's also possible to specify the preference using environment variables. See <https://bixense.com/clicolors>.
"#) "#)
.display_order(HELP_ORDER_LOW)
.value_name("WHEN") .value_name("WHEN")
.possible_values(&["auto", "always", "never"]) .possible_values(&["auto", "always", "never"])
.default_value("auto") .default_value("auto")