Skip to content

Multiple footer printing in help #1161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phlptp merged 3 commits into from
May 8, 2025
Merged

Multiple footer printing in help #1161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2565f0a
fix bug where the help and footer were printed multiple times for opt…
phlptp May 7, 2025
99584c8
style: pre-commit.ci fixes
pre-commit-ci[bot] May 7, 2025
f3dab3c
fix unused variable warning
phlptp May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions include/CLI/App.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,6 +733,9 @@ class App {
auto *ptr = option_group.get();
// move to App_p for overload resolution on older gcc versions
App_p app_ptr = std::dynamic_pointer_cast<App>(option_group);
// don't inherit the footer in option groups and clear the help flag by default
app_ptr->footer_ = "";
app_ptr->set_help_flag();
add_subcommand(std::move(app_ptr));
return ptr;
}
Expand Down
19 changes: 19 additions & 0 deletions tests/HelpTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,25 @@ TEST_CASE("THelp: FooterCallbackBoth", "[help]") {
CHECK_THAT(help, Contains("foot!!!!"));
}

/// @brief from github issue #1156
TEST_CASE("THelp: FooterOptionGroup", "[help]") {
CLI::App app{"My prog"};

app.footer("Report bugs to bugs@example.com");

app.add_option_group("group-a", "");

app.add_option_group("group-b", "");

std::string help = app.help();

auto footer_loc = help.find("bugs@example.com");
auto footer_loc2 = help.find("bugs@example.com", footer_loc + 10);
CHECK(footer_loc != std::string::npos);
// should only see the footer once
CHECK(footer_loc2 == std::string::npos);
}

TEST_CASE("THelp: OptionalPositional", "[help]") {
CLI::App app{"My prog", "program"};

Expand Down
Loading