clap/tests/builder/cargo.rs
Ed Page 36bc641648 fix(help): Remove extraneous text from built-ins
This is an intermediate solution for #4408.  As there were no agreeed
upon goals, I went with what I felt read well and that I saw commonly
used on non-clap commands.

- "information" isn't really a necessary word.
- I originally favored `Print this help` but realied that doesn't read
  correctly in completions.
- Besides being shorter, the reason for the flipped short/long hint is
  it gives people the context they need for scanning, emphasizing
  "summary" and "more".

Fixes #4409
2023-01-03 11:02:26 -06:00

98 lines
2.4 KiB
Rust

#![cfg(feature = "cargo")]
use clap::{
crate_authors, crate_description, crate_name, crate_version, error::ErrorKind, Command,
};
use crate::utils;
static DESCRIPTION_ONLY: &str = "prog 1
A simple to use, efficient, and full-featured Command Line Argument Parser
Usage: prog
Options:
-h, --help Print help
-V, --version Print version
";
static AUTHORS_ONLY: &str = "prog 1
Usage: prog
Options:
-h, --help Print help
-V, --version Print version
";
#[test]
fn crate_version() {
let res = Command::new("prog")
.version(crate_version!())
.help_template(utils::FULL_TEMPLATE)
.try_get_matches_from(vec!["prog", "--version"]);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), ErrorKind::DisplayVersion);
assert_eq!(
err.to_string(),
format!("prog {}\n", env!("CARGO_PKG_VERSION"))
);
}
#[test]
fn crate_description() {
let res = Command::new("prog")
.version("1")
.about(crate_description!())
.help_template(utils::FULL_TEMPLATE)
.try_get_matches_from(vec!["prog", "--help"]);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), ErrorKind::DisplayHelp);
assert_eq!(err.to_string(), DESCRIPTION_ONLY);
}
#[test]
fn crate_authors() {
let res = Command::new("prog")
.version("1")
.author(crate_authors!())
.help_template(utils::FULL_TEMPLATE)
.try_get_matches_from(vec!["prog", "--help"]);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), ErrorKind::DisplayHelp);
assert_eq!(err.to_string(), AUTHORS_ONLY);
}
#[test]
fn crate_authors_with_sep() {
let res = Command::new("prog")
.version("1")
.author(crate_authors!(", "))
.help_template(utils::FULL_TEMPLATE)
.try_get_matches_from(vec!["prog", "--help"]);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), ErrorKind::DisplayHelp);
assert_eq!(err.to_string(), AUTHORS_ONLY);
}
#[test]
fn crate_name() {
let res = Command::new(crate_name!())
.help_template(utils::FULL_TEMPLATE)
.version("3.0")
.try_get_matches_from(vec!["clap", "--version"]);
assert!(res.is_err());
let err = res.unwrap_err();
assert_eq!(err.kind(), ErrorKind::DisplayVersion);
assert_eq!(err.to_string(), "clap 3.0\n");
}