mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-29 20:23:55 +00:00
Code Issues Releases Wiki Activity

Adding REQUIRED and Needs, using simple name more often

Browse Source
This commit is contained in:
Henry Fredrick Schreiner 2018-04-11 12:01:19 +02:00 committed by Henry Schreiner
parent c63288a91c
commit 067bb43a84
3 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -3,9 +3,13 @@
* Make unlimited positionals vs. unlimited options more intuitive [#102] * Make unlimited positionals vs. unlimited options more intuitive [#102]
* Add missing getters `get_options` and `get_description` to App [#105] * Add missing getters `get_options` and `get_description` to App [#105]
* The app name now can be set, and will override the auto name if present [#105] * The app name now can be set, and will override the auto name if present [#105]
* Add `(REQUIRED)` for required options [#104]
* Print simple name for Needs/Excludes [#104]
* Use Needs instead of Requires in help print [#104]
[#102]: https://github.com/CLIUtils/CLI11/issues/102 [#102]: https://github.com/CLIUtils/CLI11/issues/102
[#105]: https://github.com/CLIUtils/CLI11/issues/105 [#105]: https://github.com/CLIUtils/CLI11/issues/105
[#104]: https://github.com/CLIUtils/CLI11/pull/104
## Version 1.5: Optionals ## Version 1.5: Optionals

10
include/CLI/Option.hpp
View File

@ -295,7 +295,7 @@ class Option : public OptionBase<Option> {
Option *needs(Option *opt) { Option *needs(Option *opt) {
auto tup = requires_.insert(opt); auto tup = requires_.insert(opt);
if(!tup.second) if(!tup.second)
throw OptionAlreadyAdded::Requires(get_name(), opt->get_name()); throw OptionAlreadyAdded::Requires(single_name(), opt->single_name());
return this; return this;
} }
@ -503,18 +503,20 @@ class Option : public OptionBase<Option> {
out << " x " << get_expected(); out << " x " << get_expected();
if(get_expected() == -1) if(get_expected() == -1)
out << " ..."; out << " ...";
if(get_required())
out << " (REQUIRED)";
} }
if(!envname_.empty()) if(!envname_.empty())
out << " (env:" << envname_ << ")"; out << " (env:" << envname_ << ")";
if(!requires_.empty()) { if(!requires_.empty()) {
out << " Requires:"; out << " Needs:";
for(const Option *opt : requires_) for(const Option *opt : requires_)
out << " " << opt->get_name(); out << " " << opt->single_name();
} }
if(!excludes_.empty()) { if(!excludes_.empty()) {
out << " Excludes:"; out << " Excludes:";
for(const Option *opt : excludes_) for(const Option *opt : excludes_)
out << " " << opt->get_name(); out << " " << opt->single_name();
} }
return out.str(); return out.str();
} }

25
tests/HelpTest.cpp
View File

@ -162,7 +162,7 @@ TEST(THelp, Needs) {
std::string help = app.help(); std::string help = app.help();
EXPECT_THAT(help, HasSubstr("Requires: --op1")); EXPECT_THAT(help, HasSubstr("Needs: --op1"));
} }
TEST(THelp, NeedsPositional) { TEST(THelp, NeedsPositional) {
@ -176,7 +176,7 @@ TEST(THelp, NeedsPositional) {
std::string help = app.help(); std::string help = app.help();
EXPECT_THAT(help, HasSubstr("Positionals:")); EXPECT_THAT(help, HasSubstr("Positionals:"));
EXPECT_THAT(help, HasSubstr("Requires: op1")); EXPECT_THAT(help, HasSubstr("Needs: op1"));
} }
TEST(THelp, Excludes) { TEST(THelp, Excludes) {
@ -495,3 +495,24 @@ TEST(THelp, AccessDescription) {
EXPECT_EQ(app.get_description(), "My description goes here"); EXPECT_EQ(app.get_description(), "My description goes here");
} }
TEST(THelp, CleanNeeds) {
CLI::App app;
int x;
auto a_name = app.add_option("-a,--alpha", x);
app.add_option("-b,--boo", x)->needs(a_name);
EXPECT_THAT(app.help(), Not(HasSubstr("Requires")));
EXPECT_THAT(app.help(), Not(HasSubstr("Needs: -a,--alpha")));
EXPECT_THAT(app.help(), HasSubstr("Needs: --alpha"));
}
TEST(THelp, RequiredPrintout) {
CLI::App app;
int x;
app.add_option("-a,--alpha", x)->required();
EXPECT_THAT(app.help(), HasSubstr("(REQUIRED)"));
}