mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 22:32:33 +00:00
Merge #2008
2008: feat: Added {before/after}_help_long to App struct, closed #1903 r=pksunkara a=Blaxar Co-authored-by: Blaxar Waldarax <blaxar.waldarax@gmail.com>
This commit is contained in:
commit
dc363d0b91
4 changed files with 135 additions and 2 deletions
|
@ -81,7 +81,9 @@ pub struct App<'b> {
|
|||
pub(crate) about: Option<&'b str>,
|
||||
pub(crate) long_about: Option<&'b str>,
|
||||
pub(crate) before_help: Option<&'b str>,
|
||||
pub(crate) before_long_help: Option<&'b str>,
|
||||
pub(crate) after_help: Option<&'b str>,
|
||||
pub(crate) after_long_help: Option<&'b str>,
|
||||
pub(crate) aliases: Vec<(&'b str, bool)>, // (name, visible)
|
||||
pub(crate) short_flag_aliases: Vec<(char, bool)>, // (name, visible)
|
||||
pub(crate) long_flag_aliases: Vec<(&'b str, bool)>, // (name, visible)
|
||||
|
@ -404,6 +406,9 @@ impl<'b> App<'b> {
|
|||
/// information is displayed **after** the auto-generated help information. This is often used
|
||||
/// to describe how to use the arguments, or caveats to be noted.
|
||||
///
|
||||
/// **NOTE:** If only `after_long_help` is provided, and not [`App::after_help`] but the user requests
|
||||
/// `-h` clap will still display the contents of `after_help` appropriately
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
|
@ -417,10 +422,35 @@ impl<'b> App<'b> {
|
|||
self
|
||||
}
|
||||
|
||||
/// Adds additional help information to be displayed in addition to auto-generated help. This
|
||||
/// information is displayed **after** the auto-generated help information and is meant to be
|
||||
/// more verbose than `after_help`. This is often used for man pages.. This is often used
|
||||
/// to describe how to use the arguments, or caveats to be noted in man pages.
|
||||
///
|
||||
/// **NOTE:** If only `after_help` is provided, and not [`App::after_long_help`] but the user requests
|
||||
/// `--help`, clap will still display the contents of `after_help` appropriately
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use clap::App;
|
||||
/// App::new("myprog")
|
||||
/// .after_long_help("Does really amazing things to great people... but be careful with -R, \
|
||||
/// like, for real, be careful with this!")
|
||||
/// # ;
|
||||
/// ```
|
||||
pub fn after_long_help<S: Into<&'b str>>(mut self, help: S) -> Self {
|
||||
self.after_long_help = Some(help.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Adds additional help information to be displayed in addition to auto-generated help. This
|
||||
/// information is displayed **before** the auto-generated help information. This is often used
|
||||
/// for header information.
|
||||
///
|
||||
/// **NOTE:** If only `before_long_help` is provided, and not [`App::before_help`] but the user requests
|
||||
/// `-h` clap will still display the contents of `before_long_help` appropriately
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
|
@ -434,6 +464,26 @@ impl<'b> App<'b> {
|
|||
self
|
||||
}
|
||||
|
||||
/// Adds additional help information to be displayed in addition to auto-generated help. This
|
||||
/// information is displayed **before** the auto-generated help information and is meant to be more
|
||||
/// verbose than `before_help`. This is often used for header information in man pages.
|
||||
///
|
||||
/// **NOTE:** If only `before_help` is provided, and not [`App::before_long_help`] but the user requests
|
||||
/// `--help`, clap will still display the contents of `before_help` appropriately
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use clap::App;
|
||||
/// App::new("myprog")
|
||||
/// .before_long_help("Some verbose and long info I'd like to appear before the help info")
|
||||
/// # ;
|
||||
/// ```
|
||||
pub fn before_long_help<S: Into<&'b str>>(mut self, help: S) -> Self {
|
||||
self.before_long_help = Some(help.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Allows the subcommand to be used as if it were an [`Arg::short`]
|
||||
///
|
||||
/// Sets the short version of the subcommand flag without the preceding `-`.
|
||||
|
@ -2691,7 +2741,9 @@ impl<'a> From<&'a Yaml> for App<'a> {
|
|||
yaml_str!(a, yaml, bin_name);
|
||||
yaml_str!(a, yaml, about);
|
||||
yaml_str!(a, yaml, before_help);
|
||||
yaml_str!(a, yaml, before_long_help);
|
||||
yaml_str!(a, yaml, after_help);
|
||||
yaml_str!(a, yaml, after_long_help);
|
||||
yaml_str!(a, yaml, alias);
|
||||
yaml_str!(a, yaml, visible_alias);
|
||||
|
||||
|
|
|
@ -839,7 +839,22 @@ impl<'b, 'c, 'd, 'w> Help<'b, 'c, 'd, 'w> {
|
|||
/// Writes default help for a Parser Object to the wrapped stream.
|
||||
pub(crate) fn write_default_help(&mut self) -> ClapResult<()> {
|
||||
debug!("Help::write_default_help");
|
||||
if let Some(h) = self.parser.app.before_help {
|
||||
if self.use_long {
|
||||
if let Some(h) = self
|
||||
.parser
|
||||
.app
|
||||
.before_long_help
|
||||
.or_else(|| self.parser.app.before_help)
|
||||
{
|
||||
self.write_before_after_help(h)?;
|
||||
self.none("\n\n")?;
|
||||
}
|
||||
} else if let Some(h) = self
|
||||
.parser
|
||||
.app
|
||||
.before_help
|
||||
.or_else(|| self.parser.app.before_long_help)
|
||||
{
|
||||
self.write_before_after_help(h)?;
|
||||
self.none("\n\n")?;
|
||||
}
|
||||
|
@ -886,7 +901,24 @@ impl<'b, 'c, 'd, 'w> Help<'b, 'c, 'd, 'w> {
|
|||
self.write_all_args()?;
|
||||
}
|
||||
|
||||
if let Some(h) = self.parser.app.after_help {
|
||||
if self.use_long {
|
||||
if let Some(h) = self
|
||||
.parser
|
||||
.app
|
||||
.after_long_help
|
||||
.or_else(|| self.parser.app.after_help)
|
||||
{
|
||||
if flags || opts || pos || subcmds {
|
||||
self.none("\n\n")?;
|
||||
}
|
||||
self.write_before_after_help(h)?;
|
||||
}
|
||||
} else if let Some(h) = self
|
||||
.parser
|
||||
.app
|
||||
.after_help
|
||||
.or_else(|| self.parser.app.after_long_help)
|
||||
{
|
||||
if flags || opts || pos || subcmds {
|
||||
self.none("\n\n")?;
|
||||
}
|
||||
|
|
|
@ -1195,6 +1195,8 @@ where
|
|||
};
|
||||
|
||||
self.app.long_about.is_some()
|
||||
|| self.app.before_long_help.is_some()
|
||||
|| self.app.after_long_help.is_some()
|
||||
|| self.app.args.args.iter().any(should_long)
|
||||
|| self.app.subcommands.iter().any(|s| s.long_about.is_some())
|
||||
}
|
||||
|
|
|
@ -102,6 +102,24 @@ FLAGS:
|
|||
|
||||
some text that comes after the help";
|
||||
|
||||
static AFTER_LONG_HELP: &str = "some longer text that comes before the help
|
||||
|
||||
clap-test v1.4.8
|
||||
tests clap library
|
||||
|
||||
USAGE:
|
||||
clap-test
|
||||
|
||||
FLAGS:
|
||||
-h, --help
|
||||
Prints help information
|
||||
|
||||
-V, --version
|
||||
Prints version information
|
||||
|
||||
|
||||
some longer text that comes after the help";
|
||||
|
||||
static HIDDEN_ARGS: &str = "prog 1.0
|
||||
|
||||
USAGE:
|
||||
|
@ -714,6 +732,12 @@ fn after_and_before_help_output() {
|
|||
.about("tests clap library")
|
||||
.before_help("some text that comes before the help")
|
||||
.after_help("some text that comes after the help");
|
||||
assert!(utils::compare_output(
|
||||
app.clone(),
|
||||
"clap-test -h",
|
||||
AFTER_HELP,
|
||||
false
|
||||
));
|
||||
assert!(utils::compare_output(
|
||||
app,
|
||||
"clap-test --help",
|
||||
|
@ -722,6 +746,29 @@ fn after_and_before_help_output() {
|
|||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn after_and_before_long_help_output() {
|
||||
let app = App::new("clap-test")
|
||||
.version("v1.4.8")
|
||||
.about("tests clap library")
|
||||
.before_help("some text that comes before the help")
|
||||
.after_help("some text that comes after the help")
|
||||
.before_long_help("some longer text that comes before the help")
|
||||
.after_long_help("some longer text that comes after the help");
|
||||
assert!(utils::compare_output(
|
||||
app.clone(),
|
||||
"clap-test --help",
|
||||
AFTER_LONG_HELP,
|
||||
false
|
||||
));
|
||||
assert!(utils::compare_output(
|
||||
app,
|
||||
"clap-test -h",
|
||||
AFTER_HELP,
|
||||
false
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn multi_level_sc_help() {
|
||||
let app = App::new("ctest").subcommand(
|
||||
|
|
Loading…
Reference in a new issue