Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-10 14:54:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix compatibility with help2man output (see #1432)

Browse source 
Change default help template:
- The new template introduce new lines before and after
author/about sections.
- Add help template placeholders:
    - about-section
    - author-section
- Documentation of new placeholders in clap::App::help_template
- Update all unit tests by incorporating new lines
This commit is contained in:
Logan SQUIREL 2021-02-27 16:20:52 +01:00
parent 96f1fce087
commit 3c049b4e22
No known key found for this signature in database
GPG key ID: E8BDBE1DA96E9B2B
11 changed files with 88 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
clap_derive/tests/doc-comments-help.rs
View file

@ -60,7 +60,7 @@ fn empty_line_in_doc_comment_is_double_linefeed() {
struct LoremIpsum {}
let help = get_long_help::<LoremIpsum>();
assert!(help.starts_with("lorem-ipsum \nFoo.\n\nBar\n\nUSAGE:"));
assert!(help.starts_with("lorem-ipsum \n\nFoo.\n\nBar\n\nUSAGE:"));
}
#[test]

2
src/build/app/mod.rs
View file

@ -847,9 +847,11 @@ impl<'help> App<'help> {
/// * `{version}` - Version number.
/// * `{author}` - Author information.
/// * `{author-with-newline}` - Author followed by `\n`.
/// * `{author-section}` - Author preceded and followed by `\n`.
/// * `{about}` - General description (from [`App::about`] or
/// [`App::long_about`]).
/// * `{about-with-newline}` - About followed by `\n`.
/// * `{about-section}` - About preceded and followed by '\n'.
/// * `{usage-heading}` - Automatically generated usage heading.
/// * `{usage}` - Automatically generated or given usage string.
/// * `{all-args}` - Help for all arguments (options, flags, positional

52
src/output/help.rs
View file

@ -51,7 +51,8 @@ pub(crate) struct Help<'help, 'app, 'parser, 'writer> {
impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
const DEFAULT_TEMPLATE: &'static str = "\
{before-help}{bin} {version}\n\
{author-with-newline}{about-with-newline}\n\
{author-section}\
{about-section}\n\
{usage-heading}\n {usage}\n\
\n\
{all-args}{after-help}\
@ -59,7 +60,8 @@ impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
const DEFAULT_NO_ARGS_TEMPLATE: &'static str = "\
{before-help}{bin} {version}\n\
{author-with-newline}{about-with-newline}\n\
{author-section}\
{about-section}\n\
{usage-heading}\n {usage}{after-help}\
";
@ -642,27 +644,45 @@ impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
prefix.to_string() + &spec_vals.join(" ")
}
fn write_about(&mut self, new_line: bool) -> io::Result<()> {
fn write_about(&mut self, before_new_line: bool, after_new_line: bool) -> io::Result<()> {
let about = if self.use_long {
self.parser.app.long_about.or(self.parser.app.about)
} else {
self.parser.app.about
};
if let Some(output) = about {
if before_new_line {
self.none("\n")?;
}
self.none(text_wrapper(output, self.term_w))?;
if new_line {
if after_new_line {
self.none("\n")?;
}
}
Ok(())
}
fn write_author(&mut self, new_line: bool) -> io::Result<()> {
fn write_author(&mut self, before_new_line: bool, after_new_line: bool) -> io::Result<()> {
if let Some(author) = self.parser.app.author {
self.none(text_wrapper(author, self.term_w))?;
if new_line {
if before_new_line {
self.none("\n")?;
}
self.none(text_wrapper(author, self.term_w))?;
if after_new_line {
self.none("\n")?;
}
}
Ok(())
}
fn write_version(&mut self) -> io::Result<()> {
let version = if self.use_long {
self.parser.app.long_version.or(self.parser.app.version)
} else {
self.parser.app.version
};
if let Some(output) = version {
self.none(text_wrapper(output, self.term_w))?;
}
Ok(())
}
@ -988,21 +1008,25 @@ impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
self.write_bin_name()?;
}
"version" => {
if let Some(s) = self.parser.app.version {
self.none(s)?;
}
self.write_version()?;
}
"author" => {
self.write_author(false)?;
self.write_author(false, false)?;
}
"author-with-newline" => {
self.write_author(true)?;
self.write_author(false, true)?;
}
"author-section" => {
self.write_author(true, true)?;
}
"about" => {
self.write_about(false)?;
self.write_about(false, false)?;
}
"about-with-newline" => {
self.write_about(true)?;
self.write_about(false, true)?;
}
"about-section" => {
self.write_about(true, true)?;
}
"usage-heading" => {
self.warning("USAGE:")?;

2
tests/app_from_crate.rs
View file

@ -1,7 +1,9 @@
use clap::{app_from_crate, ErrorKind};
static EVERYTHING: &str = "clap {{version}}
Kevin K. <kbknapp@gmail.com>:Clap Maintainers
A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE:

4
tests/app_settings.rs
View file

@ -38,7 +38,9 @@ OPTIONS:
-o, --opt=<FILE> some";
static UNIFIED_HELP: &str = "test 1.3
Kevin K.
tests stuff
USAGE:
@ -54,7 +56,9 @@ OPTIONS:
-V, --version Prints version information";
static SKIP_POS_VALS: &str = "test 1.3
Kevin K.
tests stuff
USAGE:

2
tests/arg_aliases.rs
View file

@ -3,6 +3,7 @@ mod utils;
use clap::{App, Arg};
static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help
USAGE:
@ -17,6 +18,7 @@ OPTIONS:
-o, --opt <opt> [aliases: visible]";
static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help
USAGE:

2
tests/arg_aliases_short.rs
View file

@ -3,6 +3,7 @@ mod utils;
use clap::{App, Arg};
static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help
USAGE:
@ -17,6 +18,7 @@ OPTIONS:
-o, --opt <opt> [short aliases: v]";
static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help
USAGE:

2
tests/cargo.rs
View file

@ -1,6 +1,7 @@
use clap::{crate_authors, crate_description, crate_name, crate_version, App, ErrorKind};
static DESCRIPTION_ONLY: &str = "prog 1
A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE:
@ -12,6 +13,7 @@ FLAGS:
";
static AUTHORS_ONLY: &str = "prog 1
Kevin K. <kbknapp@gmail.com>:Clap Maintainers
USAGE:

3
tests/flag_subcommands.rs
View file

@ -408,6 +408,7 @@ fn flag_subcommand_long_infer_exact_match() {
}
static FLAG_SUBCOMMAND_HELP: &str = "pacman-query
Query the package database.
USAGE:
@ -462,6 +463,7 @@ fn flag_subcommand_long_short_normal_usage_string() {
}
static FLAG_SUBCOMMAND_NO_SHORT_HELP: &str = "pacman-query
Query the package database.
USAGE:
@ -515,6 +517,7 @@ fn flag_subcommand_long_normal_usage_string() {
}
static FLAG_SUBCOMMAND_NO_LONG_HELP: &str = "pacman-query
Query the package database.
USAGE:

22
tests/help.rs
View file

@ -3,7 +3,9 @@ mod utils;
use clap::{clap_app, App, AppSettings, Arg, ArgGroup, ArgSettings, ErrorKind};
static REQUIRE_DELIM_HELP: &str = "test 1.3
Kevin K.
tests stuff
USAGE:
@ -17,7 +19,9 @@ OPTIONS:
-f, --fake <some>:<val> some help";
static HELP: &str = "clap-test v1.4.8
Kevin K. <kbknapp@gmail.com>
tests clap library
USAGE:
@ -91,6 +95,7 @@ SUBCOMMANDS:
static AFTER_HELP: &str = "some text that comes before the help
clap-test v1.4.8
tests clap library
USAGE:
@ -105,6 +110,7 @@ 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:
@ -133,7 +139,9 @@ OPTIONS:
-o, --opt <FILE> tests options";
static SC_HELP: &str = "clap-test-subcmd 0.1
Kevin K. <kbknapp@gmail.com>
tests subcommands
USAGE:
@ -194,7 +202,9 @@ FLAGS:
-V, --version Prints version information";
static MULTI_SC_HELP: &str = "ctest-subcmd-multi 0.1
Kevin K. <kbknapp@gmail.com>
tests subcommands
USAGE:
@ -317,7 +327,9 @@ OPTIONS:
Gaussian, Lanczos3]";
static ISSUE_702: &str = "myapp 1.0
foo
bar
USAGE:
@ -338,8 +350,10 @@ OPTIONS:
static ISSUE_777: &str = "A app with a crazy very long long
long name hahaha 1.0
Some Very Long Name and crazy long
email <email@server.com>
Show how the about text is not
wrapped
@ -514,7 +528,9 @@ FLAGS:
-V, --version Prints version information";
static LONG_ABOUT: &str = "myapp 1.0
foo
something really really long, with
multiple lines of text
that should be displayed
@ -584,7 +600,9 @@ OPTIONS:
-p, --pos <VAL> Some vals [possible values: fast, slow]";
static CUSTOM_HELP_SECTION: &str = "blorp 1.4
Will M.
does stuff
USAGE:
@ -1806,7 +1824,9 @@ fn custom_headers_headers() {
}
static MULTIPLE_CUSTOM_HELP_SECTIONS: &str = "blorp 1.4
Will M.
does stuff
USAGE:
@ -1884,6 +1904,7 @@ fn multiple_custom_help_headers() {
}
static ISSUE_897: &str = "ctest-foo 0.1
Long about foo
USAGE:
@ -1913,6 +1934,7 @@ fn show_long_about_issue_897() {
}
static ISSUE_897_SHORT: &str = "ctest-foo 0.1
About foo
USAGE:

10
tests/hidden_args.rs
View file

@ -3,7 +3,9 @@ mod utils;
use clap::{App, AppSettings, Arg};
static HIDDEN_ARGS: &str = "test 1.4
Kevin K.
tests stuff
USAGE:
@ -38,7 +40,9 @@ fn hidden_args() {
}
static HIDDEN_SHORT_ARGS: &str = "test 2.31.2
Steve P.
hides short args
USAGE:
@ -50,7 +54,9 @@ FLAGS:
-V, --version Prints version information";
static HIDDEN_SHORT_ARGS_LONG_HELP: &str = "test 2.31.2
Steve P.
hides short args
USAGE:
@ -124,7 +130,9 @@ fn hidden_short_args_long_help() {
}
static HIDDEN_LONG_ARGS: &str = "test 2.31.2
Steve P.
hides long args
USAGE:
@ -167,7 +175,9 @@ fn hidden_long_args() {
}
static HIDDEN_LONG_ARGS_SHORT_HELP: &str = "test 2.31.2
Steve P.
hides long args
USAGE: