mirror of
https://github.com/CLIUtils/CLI11.git
synced 2026-01-19 04:52:08 +00:00
e7e8de0346
The default formatter has hardcoded ratio at which the long options are
aligned. It's currently 1/3 of the column, which makes the default look
awkward:
```
-h, --help Print
--option Something
```
A ->long_option_alignment_ratio(6/30.f) allows output to look like this:
```
-h, --help Print
--option Something
```
The 1/3 ratio is also bad if you want to print "descriptive" long
options on a single line, because then you might want to increase the
column width, but that means you waste more space on short options.
e.g. ->column_width(46)
```
-l, --very-descriptive-long-option Something
```
vs. ->column_width(38)
```
-l, --very-descriptive-long-option
Something
```
vs. ->column_width(38) ->long_option_alignment_ratio(6/38.f)
```
-l, --very-descriptive-long-option Something
```
Any absolute offset `X` can be set as `X/column_width`, so provide a
ratio-based interface.
I would have prefered to give an absolute integer offset, but we still
have to preserve the functionality that does 1/3 if user changed
nothing, which means that ratio-based interface is simpler.
I don't have a good idea for the name, "short_option_ratio" might work
as well.
The setter does not sanity check that the value is in [0;1] range.
---------
Signed-off-by: Radim Krčmář <radim@krcmar.dev>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
278 lines
9.4 KiB
C++
278 lines
9.4 KiB
C++
// Copyright (c) 2017-2025, University of Cincinnati, developed by Henry Schreiner
|
|
// under NSF AWARD 1414736 and by the respective contributors.
|
|
// All rights reserved.
|
|
//
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
#ifdef CLI11_SINGLE_FILE
|
|
#include "CLI11.hpp"
|
|
#else
|
|
#include "CLI/CLI.hpp"
|
|
#endif
|
|
|
|
#include "catch.hpp"
|
|
#include <fstream>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
class SimpleFormatter : public CLI::FormatterBase {
|
|
public:
|
|
SimpleFormatter() : FormatterBase() {}
|
|
|
|
std::string make_help(const CLI::App *, std::string, CLI::AppFormatMode) const override {
|
|
return "This is really simple";
|
|
}
|
|
};
|
|
|
|
TEST_CASE("Formatter: Nothing", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.formatter(std::make_shared<SimpleFormatter>());
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK("This is really simple" == help);
|
|
}
|
|
|
|
TEST_CASE("Formatter: NothingLambda", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.formatter_fn(
|
|
[](const CLI::App *, std::string, CLI::AppFormatMode) { return std::string("This is really simple"); });
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK("This is really simple" == help);
|
|
}
|
|
|
|
TEST_CASE("Formatter: OptCustomize", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
auto optfmt = std::make_shared<CLI::Formatter>();
|
|
optfmt->column_width(25);
|
|
optfmt->label("REQUIRED", "(MUST HAVE)");
|
|
app.formatter(optfmt);
|
|
|
|
int v{0};
|
|
app.add_option("--opt", v, "Something")->required();
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK_THAT(help, Contains("(MUST HAVE)"));
|
|
CHECK_THAT(help, Contains("Something"));
|
|
CHECK_THAT(help, Contains("--opt INT"));
|
|
CHECK_THAT(help, Contains("-h, --help Print"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: OptCustomizeSimple", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.get_formatter()->column_width(25);
|
|
app.get_formatter()->label("REQUIRED", "(MUST HAVE)");
|
|
|
|
int v{0};
|
|
app.add_option("--opt", v, "Something")->required();
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK_THAT(help, Contains("(MUST HAVE)"));
|
|
CHECK_THAT(help, Contains("(MUST HAVE)"));
|
|
CHECK_THAT(help, Contains("Something"));
|
|
CHECK_THAT(help, Contains("--opt INT"));
|
|
CHECK_THAT(help, Contains("-h, --help Print"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: OptCustomizeOptionText", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.get_formatter()->column_width(25);
|
|
|
|
int v{0};
|
|
app.add_option("--opt", v, "Something")->option_text("(ARG)");
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK_THAT(help, Contains("(ARG)"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: FalseFlagExample", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.get_formatter()->column_width(25);
|
|
app.get_formatter()->label("REQUIRED", "(MUST HAVE)");
|
|
|
|
int v{0};
|
|
app.add_flag("--opt,!--no_opt", v, "Something");
|
|
|
|
bool flag{false};
|
|
app.add_flag("!-O,--opt2,--no_opt2{false}", flag, "Something else");
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK_THAT(help, Contains("--no_opt{false}"));
|
|
CHECK_THAT(help, Contains("--no_opt2{false}"));
|
|
CHECK_THAT(help, Contains("-O{false}"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: AppCustomize", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
app.add_subcommand("subcom1", "This");
|
|
|
|
auto appfmt = std::make_shared<CLI::Formatter>();
|
|
appfmt->column_width(20);
|
|
appfmt->label("Usage", "Run");
|
|
app.formatter(appfmt);
|
|
|
|
app.add_subcommand("subcom2", "That");
|
|
|
|
std::string help = app.help();
|
|
CHECK_THAT(help, Contains("Run: [OPTIONS] [SUBCOMMANDS]\n\n"));
|
|
CHECK_THAT(help, Contains("\nSUBCOMMANDS:\n"));
|
|
CHECK_THAT(help, Contains(" subcom1 This \n"));
|
|
CHECK_THAT(help, Contains(" subcom2 That \n"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: AppCustomizeSimple", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
app.add_subcommand("subcom1", "This");
|
|
|
|
app.get_formatter()->column_width(20);
|
|
app.get_formatter()->label("Usage", "Run");
|
|
|
|
app.add_subcommand("subcom2", "That");
|
|
|
|
std::string help = app.help();
|
|
CHECK_THAT(help, Contains("Run: [OPTIONS] [SUBCOMMANDS]\n\n"));
|
|
CHECK_THAT(help, Contains("\nSUBCOMMANDS:\n"));
|
|
CHECK_THAT(help, Contains(" subcom1 This \n"));
|
|
CHECK_THAT(help, Contains(" subcom2 That \n"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: AllSub", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
CLI::App *sub = app.add_subcommand("subcom", "This");
|
|
sub->add_flag("--insub", "MyFlag");
|
|
|
|
std::string help = app.help("", CLI::AppFormatMode::All);
|
|
CHECK_THAT(help, Contains("--insub"));
|
|
CHECK_THAT(help, Contains("subcom"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: AllSubRequired", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
CLI::App *sub = app.add_subcommand("subcom", "This");
|
|
sub->add_flag("--insub", "MyFlag");
|
|
sub->required();
|
|
std::string help = app.help("", CLI::AppFormatMode::All);
|
|
CHECK_THAT(help, Contains("--insub"));
|
|
CHECK_THAT(help, Contains("subcom"));
|
|
CHECK_THAT(help, Contains("REQUIRED"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: NamelessSub", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
CLI::App *sub = app.add_subcommand("", "This subcommand");
|
|
sub->add_flag("--insub", "MyFlag");
|
|
|
|
std::string help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, Contains("--insub"));
|
|
CHECK_THAT(help, Contains("This subcommand"));
|
|
}
|
|
|
|
TEST_CASE("Formatter: NamelessSubInGroup", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
CLI::App *sub = app.add_subcommand("", "This subcommand");
|
|
CLI::App *sub2 = app.add_subcommand("sub2", "subcommand2");
|
|
sub->add_flag("--insub", "MyFlag");
|
|
int val{0};
|
|
sub2->add_option("pos", val, "positional");
|
|
sub->group("group1");
|
|
sub2->group("group1");
|
|
std::string help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, Contains("--insub"));
|
|
CHECK_THAT(help, Contains("This subcommand"));
|
|
CHECK_THAT(help, Contains("group1"));
|
|
CHECK_THAT(help, Contains("sub2"));
|
|
CHECK(help.find("pos") == std::string::npos);
|
|
}
|
|
|
|
TEST_CASE("Formatter: Footer", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
std::string footer_string{"this is a test of the footer "
|
|
"systemsssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss to Pr e s "
|
|
" e r v e SPA C ES"};
|
|
app.footer(footer_string);
|
|
app.add_flag("--option", "MyFlag");
|
|
app.get_formatter()->footer_paragraph_width(50);
|
|
app.get_formatter()->enable_footer_formatting(false);
|
|
CHECK(!app.get_formatter()->is_footer_paragraph_formatting_enabled());
|
|
std::string help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, Contains("is a"));
|
|
CHECK_THAT(help, Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, Contains(footer_string));
|
|
|
|
help = app.help("", CLI::AppFormatMode::Sub);
|
|
CHECK_THAT(help, Contains("is a"));
|
|
CHECK_THAT(help, Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, Contains(footer_string));
|
|
|
|
app.get_formatter()->enable_footer_formatting(true);
|
|
CHECK(app.get_formatter()->is_footer_paragraph_formatting_enabled());
|
|
help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, !Contains("is a"));
|
|
CHECK_THAT(help, !Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, !Contains(footer_string));
|
|
|
|
help = app.help("", CLI::AppFormatMode::Sub);
|
|
CHECK_THAT(help, !Contains("is a"));
|
|
CHECK_THAT(help, !Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, !Contains(footer_string));
|
|
}
|
|
|
|
TEST_CASE("Formatter: Description", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
std::string desc_string{"this is a test of the footer "
|
|
"systemsssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss to Pr e s "
|
|
"e r v e SPA C ES"};
|
|
app.description(desc_string);
|
|
app.add_flag("--option", "MyFlag");
|
|
app.get_formatter()->description_paragraph_width(50);
|
|
app.get_formatter()->enable_description_formatting(false);
|
|
CHECK(!app.get_formatter()->is_description_paragraph_formatting_enabled());
|
|
std::string help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, Contains("is a"));
|
|
CHECK_THAT(help, Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, Contains(desc_string));
|
|
|
|
help = app.help("", CLI::AppFormatMode::Sub);
|
|
CHECK_THAT(help, Contains("is a"));
|
|
CHECK_THAT(help, Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, Contains(desc_string));
|
|
|
|
app.get_formatter()->enable_description_formatting(true);
|
|
CHECK(app.get_formatter()->is_description_paragraph_formatting_enabled());
|
|
help = app.help("", CLI::AppFormatMode::Normal);
|
|
CHECK_THAT(help, !Contains("is a"));
|
|
CHECK_THAT(help, !Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, !Contains(desc_string));
|
|
|
|
help = app.help("", CLI::AppFormatMode::Sub);
|
|
CHECK_THAT(help, !Contains("is a"));
|
|
CHECK_THAT(help, !Contains("to Pr e s e r v e SPA C ES"));
|
|
CHECK_THAT(help, !Contains(desc_string));
|
|
}
|
|
|
|
TEST_CASE("Formatter: LongOptionAlignment", "[formatter]") {
|
|
CLI::App app{"My prog"};
|
|
|
|
app.get_formatter()->long_option_alignment_ratio(6 / 30.f);
|
|
|
|
int v{0};
|
|
app.add_option("--opt", v, "Something");
|
|
|
|
std::string help = app.help();
|
|
|
|
CHECK_THAT(help, Contains("\n -h, --help Print"));
|
|
CHECK_THAT(help, Contains("\n --opt INT Something"));
|
|
}
|