Skip to content

Commit

Permalink
fix(help): Skip [OPTIONS] if help/version action
Browse files Browse the repository at this point in the history
Our code for detecting when to skip this in the usage was never updated
for actions.
  • Loading branch information
epage committed Jul 17, 2023
1 parent 22b545b commit 36afe99
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
15 changes: 15 additions & 0 deletions clap_builder/src/output/usage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#![cfg_attr(not(feature = "usage"), allow(dead_code))]

// Internal
use crate::builder::ArgAction;
use crate::builder::StyledStr;
use crate::builder::Styles;
use crate::builder::{ArgPredicate, Command};
Expand Down Expand Up @@ -210,6 +211,20 @@ impl<'cmd> Usage<'cmd> {
debug!("Usage::needs_options_tag:iter Option is built-in");
continue;
}
match f.get_action() {
ArgAction::Set
| ArgAction::Append
| ArgAction::SetTrue
| ArgAction::SetFalse
| ArgAction::Count => {}
ArgAction::Help
| ArgAction::HelpShort
| ArgAction::HelpLong
| ArgAction::Version => {
debug!("Usage::needs_options_tag:iter Option is built-in");
continue;
}
}

if f.is_hide_set() {
debug!("Usage::needs_options_tag:iter Option is hidden");
Expand Down
6 changes: 3 additions & 3 deletions tests/builder/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1068,7 +1068,7 @@ fn explicit_short_long_help() {
static SHORT_ABOUT: &str = "\
bar
Usage: myapp [OPTIONS] [arg1]
Usage: myapp [arg1]
Arguments:
[arg1] some option
Expand All @@ -1084,7 +1084,7 @@ something really really long, with
multiple lines of text
that should be displayed
Usage: myapp [OPTIONS] [arg1]
Usage: myapp [arg1]
Arguments:
[arg1]
Expand Down Expand Up @@ -1351,7 +1351,7 @@ fn override_help_short() {
}

static OVERRIDE_HELP_LONG: &str = "\
Usage: test [OPTIONS]
Usage: test
Options:
-h, --hell Print help
Expand Down

0 comments on commit 36afe99

Please sign in to comment.