mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-03 22:13:51 +00:00
Code Issues Releases Wiki Activity

Allow to customize help flag.

Browse Source
This commit is contained in:
Marcus Brinkmann 2017-11-20 02:33:10 +01:00 committed by Henry Schreiner
parent 90dd3278b4
commit 077ba40417
2 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/CLI/App.hpp
View File

@ -331,6 +331,13 @@ class App {
return opt; return opt;
} }
Option *add_help_flag(std::string name, std::string description = "") {
if(help_ptr_)
throw IncorrectConstruction("Help flag already initialized");
help_ptr_ = add_flag(name, description);
return help_ptr_;
}
/// Add option for flag /// Add option for flag
Option *add_flag(std::string name, std::string description = "") { Option *add_flag(std::string name, std::string description = "") {
CLI::callback_t fun = [](CLI::results_t) { return true; }; CLI::callback_t fun = [](CLI::results_t) { return true; };

48
tests/HelpTest.cpp
View File

@ -283,6 +283,54 @@ TEST(THelp, SetLower) {
EXPECT_THAT(help, HasSubstr("THREE")); EXPECT_THAT(help, HasSubstr("THREE"));
} }
TEST(THelp, OnlyOneHelp) {
CLI::App app{"My prog"};
/* It is not supported to add more than one help flag. */
EXPECT_THROW(app.add_help_flag("--yelp", "Alias for help"), CLI::IncorrectConstruction);
}
TEST(THelp, NoHelp) {
CLI::App app{"My prog", false};
std::string help = app.help();
EXPECT_THAT(help, HasSubstr("My prog"));
EXPECT_THAT(help, Not(HasSubstr("-h,--help")));
EXPECT_THAT(help, Not(HasSubstr("Options:")));
EXPECT_THAT(help, HasSubstr("Usage:"));
std::vector<std::string> input{"--help"};
try {
app.parse(input);
} catch(const CLI::ParseError &e) {
EXPECT_EQ(static_cast<int>(CLI::ExitCodes::Extras), e.get_exit_code());
}
}
TEST(THelp, CustomHelp) {
CLI::App app{"My prog", false};
CLI::Option *help_option = app.add_help_flag("--yelp", "display help and exit");
EXPECT_EQ(app.get_help_ptr(), help_option);
EXPECT_THROW(app.add_help_flag("--help", "Alias for yelp"), CLI::IncorrectConstruction);
std::string help = app.help();
EXPECT_THAT(help, HasSubstr("My prog"));
EXPECT_THAT(help, Not(HasSubstr("-h,--help")));
EXPECT_THAT(help, HasSubstr("--yelp"));
EXPECT_THAT(help, HasSubstr("Options:"));
EXPECT_THAT(help, HasSubstr("Usage:"));
std::vector<std::string> input{"--yelp"};
try {
app.parse(input);
} catch(const CLI::CallForHelp &e) {
EXPECT_EQ(static_cast<int>(CLI::ExitCodes::Success), e.get_exit_code());
}
}
TEST(Exit, ErrorWithHelp) { TEST(Exit, ErrorWithHelp) {
CLI::App app{"My prog"}; CLI::App app{"My prog"};