Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(help): Don't accidentally show long help with --help when it isn't intended. #4710

Merged
merged 1 commit into from Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/builder/command.rs
Expand Up @@ -4593,12 +4593,13 @@ impl Command {
// specified by the user is sent through. If hide_short_help is not included,
// then items specified with hidden_short_help will also be hidden.
let should_long = |v: &Arg| {
v.get_long_help().is_some()
|| v.is_hide_long_help_set()
|| v.is_hide_short_help_set()
|| v.get_possible_values()
.iter()
.any(PossibleValue::should_show_help)
!v.is_hide_set()
&& (v.get_long_help().is_some()
|| v.is_hide_long_help_set()
|| v.is_hide_short_help_set()
|| v.get_possible_values()
.iter()
.any(PossibleValue::should_show_help))
};

// Subcommands aren't checked because we prefer short help for them, deferring to
Expand Down
26 changes: 25 additions & 1 deletion tests/builder/hidden_args.rs
@@ -1,6 +1,6 @@
use super::utils;

use clap::{arg, Arg, ArgAction, Command};
use clap::{arg, builder::PossibleValue, Arg, ArgAction, Command};

static HIDDEN_ARGS: &str = "\
tests stuff
Expand Down Expand Up @@ -278,3 +278,27 @@ fn hide_subcmds_only() {

utils::assert_output(cmd, "test --help", HIDDEN_SUBCMDS_ONLY, false);
}

#[test]
fn hidden_arg_with_possible_value_with_help() {
// Normally the presence of a possible value with a help text triggers a
// change of the --help help text by appending `(see more with '--help')`
// or `(see a summary with '-h')`. When the argument is completely hidden
// we however do not want it to trigger that change.
static POS_VALS_HELP: &str = "\
Usage: ctest

Options:
-h, --help Print help
";
let app = Command::new("ctest").arg(
Arg::new("pos")
.hide(true)
.value_parser([
PossibleValue::new("fast"),
PossibleValue::new("slow").help("not as fast"),
])
.action(ArgAction::Set),
);
utils::assert_output(app, "ctest --help", POS_VALS_HELP, false);
}