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

Support groups for subcommands.

Browse Source
This commit is contained in:
Marcus Brinkmann 2017-11-20 16:30:54 +01:00 committed by Henry Schreiner
parent f7e10d02ef
commit 642a67034d
2 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
include/CLI/App.hpp
View File

@ -121,6 +121,9 @@ class App {
/// -1 for 1 or more, 0 for not required, # for exact number required /// -1 for 1 or more, 0 for not required, # for exact number required
int require_subcommand_ = 0; int require_subcommand_ = 0;
/// The group membership
std::string group_{"Subcommands"};
///@} ///@}
/// @name Config /// @name Config
///@{ ///@{
@ -212,6 +215,15 @@ class App {
return this; return this;
} }
/// Changes the group membership
App *group(std::string name) {
group_ = name;
return this;
}
/// Get the group of this subcommand
const std::string &get_group() const { return group_; }
///@} ///@}
/// @name Adding options /// @name Adding options
///@{ ///@{
@ -845,10 +857,19 @@ class App {
// Subcommands // Subcommands
if(!subcommands_.empty()) { if(!subcommands_.empty()) {
out << std::endl << "Subcommands:" << std::endl; std::set<std::string> subcmd_groups_seen;
for(const App_p &com : subcommands_) {
const std::string &group_key = detail::to_lower(com->get_group());
if(group_key == "hidden" || subcmd_groups_seen.count(group_key) != 0)
continue;
subcmd_groups_seen.insert(group_key);
out << std::endl << com->get_group() << ":" << std::endl;
for(const App_p &com : subcommands_) for(const App_p &com : subcommands_)
if(detail::to_lower(com->get_group()) == group_key)
detail::format_help(out, com->get_name(), com->description_, wid); detail::format_help(out, com->get_name(), com->description_, wid);
} }
}
if(!footer_.empty()) { if(!footer_.empty()) {
out << std::endl << footer_ << std::endl; out << std::endl << footer_ << std::endl;

24
tests/SubcommandTest.cpp
View File

@ -1,5 +1,11 @@
#include "app_helper.hpp" #include "app_helper.hpp"
#include "gtest/gtest.h"
#include "gmock/gmock.h"
using ::testing::HasSubstr;
using ::testing::Not;
TEST_F(TApp, BasicSubcommands) { TEST_F(TApp, BasicSubcommands) {
auto sub1 = app.add_subcommand("sub1"); auto sub1 = app.add_subcommand("sub1");
auto sub2 = app.add_subcommand("sub2"); auto sub2 = app.add_subcommand("sub2");
@ -482,3 +488,21 @@ TEST_F(SubcommandProgram, Callbacks) {
EXPECT_THROW(run(), CLI::Success); EXPECT_THROW(run(), CLI::Success);
} }
TEST_F(SubcommandProgram, Groups) {
std::string help = app.help();
EXPECT_THAT(help, Not(HasSubstr("More Commands:")));
EXPECT_THAT(help, HasSubstr("Subcommands:"));
start->group("More Commands");
help = app.help();
EXPECT_THAT(help, HasSubstr("More Commands:"));
EXPECT_THAT(help, HasSubstr("Subcommands:"));
// Case is ignored but for the first subcommand in a group.
stop->group("more commands");
help = app.help();
EXPECT_THAT(help, HasSubstr("More Commands:"));
EXPECT_THAT(help, Not(HasSubstr("Subcommands:")));
}