mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-05 06:33:52 +00:00
Code Issues Releases Wiki Activity

Adding corrected positional help

Browse Source
This commit is contained in:
Henry Fredrick Schreiner 2017-03-15 09:11:32 -04:00
parent 6d445ff03d
commit f6e771a248
3 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/CLI/App.hpp
View File

@ -593,7 +593,7 @@ public:
//if(detail::to_lower(opt->get_group()) == "hidden") //if(detail::to_lower(opt->get_group()) == "hidden")
// continue; // continue;
out << " " << opt->help_positional(); out << " " << opt->help_positional();
if(opt->has_description()) if(opt->_has_help_positional())
pos=true; pos=true;
} }
@ -612,7 +612,7 @@ public:
for(const Option_p &opt : options_) { for(const Option_p &opt : options_) {
if(detail::to_lower(opt->get_group()) == "hidden") if(detail::to_lower(opt->get_group()) == "hidden")
continue; continue;
if(opt->get_positional() && opt->has_description()) if(opt->_has_help_positional())
detail::format_help(out, opt->help_pname(), opt->get_description(), wid); detail::format_help(out, opt->help_pname(), opt->get_description(), wid);
} }
out << std::endl; out << std::endl;

11
include/CLI/Option.hpp
View File

@ -364,6 +364,7 @@ public:
} }
///@} ///@}
/// @name Parser tools /// @name Parser tools
///@{ ///@{
@ -451,6 +452,16 @@ public:
///@} ///@}
protected:
/// @name App Helpers
///@{
/// Can print positional name detailed option if true
bool _has_help_positional() const {
return get_positional() && (has_description() || requires_.size()>0 || excludes_.size()>0 );
}
///@}
}; };

27
tests/HelpTest.cpp
View File

@ -149,6 +149,20 @@ TEST(THelp, Requires) {
EXPECT_THAT(help, HasSubstr("Requires: --op1")); EXPECT_THAT(help, HasSubstr("Requires: --op1"));
} }
TEST(THelp, RequiresPositional) {
CLI::App app{"My prog"};
int x,y;
CLI::Option* op1 = app.add_option("op1", x, "one");
app.add_option("op2", y, "two")->requires(op1);
std::string help = app.help();
EXPECT_THAT(help, HasSubstr("Positionals:"));
EXPECT_THAT(help, HasSubstr("Requires: op1"));
}
TEST(THelp, Excludes) { TEST(THelp, Excludes) {
CLI::App app{"My prog"}; CLI::App app{"My prog"};
@ -160,6 +174,19 @@ TEST(THelp, Excludes) {
EXPECT_THAT(help, HasSubstr("Excludes: --op1")); EXPECT_THAT(help, HasSubstr("Excludes: --op1"));
} }
TEST(THelp, ExcludesPositional) {
CLI::App app{"My prog"};
int x,y;
CLI::Option* op1 = app.add_option("op1", x);
app.add_option("op2", y)->excludes(op1);
std::string help = app.help();
EXPECT_THAT(help, HasSubstr("Positionals:"));
EXPECT_THAT(help, HasSubstr("Excludes: op1"));
}
TEST(THelp, Subcom) { TEST(THelp, Subcom) {
CLI::App app{"My prog"}; CLI::App app{"My prog"};