KeqingMoe/argparse
1
0
Fork 0
mirror of https://github.com/KeqingMoe/argparse.git synced 2025-07-04 07:04:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fixed test for multiline help message alignment

Browse Source
This commit is contained in:
Fanurs 2023-04-22 19:23:17 -04:00
parent 19d85eadb0
commit e82653c2d9
2 changed files with 25 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/argparse/argparse.hpp
View File

@ -675,7 +675,7 @@ public:
auto pos = 0; auto pos = 0;
auto prev = 0; auto prev = 0;
auto first_line = true; auto first_line = true;
const char* hspace = " "; // minimal space between name and help message auto hspace = " "; // minimal space between name and help message
stream << name_stream.str(); stream << name_stream.str();
std::string_view help_view(argument.m_help); std::string_view help_view(argument.m_help);
while ((pos = argument.m_help.find('\n', prev)) != std::string::npos) { while ((pos = argument.m_help.find('\n', prev)) != std::string::npos) {

59
test/test_help.cpp
View File

@ -1,8 +1,6 @@
#include <argparse/argparse.hpp> #include <argparse/argparse.hpp>
#include <doctest.hpp> #include <doctest.hpp>
#include <regex>
#include <sstream> #include <sstream>
#include <unordered_map>
using doctest::test_suite; using doctest::test_suite;
@ -77,55 +75,46 @@ TEST_CASE("Users can replace default -h/--help" * test_suite("help")) {
} }
TEST_CASE("Multiline help message alignment") { TEST_CASE("Multiline help message alignment") {
// '#' is used at the beginning of each help message line to simplify testing.
// It is important to ensure that this character doesn't appear elsewhere in the test case.
// Default arguments (e.g., -h/--help, -v/--version) are not included in this test.
argparse::ArgumentParser program("program"); argparse::ArgumentParser program("program");
program.add_argument("input1") program.add_argument("INPUT1")
.help( .help(
"This is the first line of help message.\n" "#This is the first line of help message.\n"
"And this is the second line of help message." "#And this is the second line of help message."
); );
program.add_argument("program_input2") program.add_argument("program_input2")
.help("There is only one line."); .help("#There is only one line.");
program.add_argument("-p", "--prog_input3") program.add_argument("-p", "--prog_input3")
.help( .help(
R"(Lorem ipsum dolor sit amet, consectetur adipiscing elit. R"(#Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed ut perspiciatis unde omnis iste natus error sit voluptatem #Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam...)" #accusantium doloremque laudantium, totam rem aperiam...)"
); );
program.add_argument("--verbose").default_value(false).implicit_value(true);
std::ostringstream stream; std::ostringstream stream;
stream << program; stream << program;
std::string help_text = stream.str(); std::istringstream iss(stream.str());
// Split the help text into lines int help_message_start = -1;
std::istringstream iss(help_text);
std::vector<std::string> help_lines;
std::string line; std::string line;
while (std::getline(iss, line)) { while (std::getline(iss, line)) {
help_lines.push_back(line); // Find the position of '#', which indicates the start of the help message line
} auto pos = line.find('#');
// A map to store the starting position of the help text for each argument if (pos == std::string::npos) {
std::unordered_map<std::string, int> help_start_positions; continue;
}
for (const auto& line : help_lines) { if (help_message_start == -1) {
// Find the argument names in the line help_message_start = pos;
std::smatch match; } else {
if (std::regex_search(line, match, std::regex(R"((input1|program_input2|--prog_input3))"))) { REQUIRE(pos == help_message_start);
std::string arg_name = match.str();
// Find the position of the first non-space character after the argument name
int position = line.find_first_not_of(' ', match.position() + arg_name.size());
if (position == std::string::npos) {
continue;
}
help_start_positions[arg_name] = position;
} }
} }
// Check if the positions are the same for all arguments // Make sure we have at least one help message
REQUIRE(!help_start_positions.empty()); REQUIRE(help_message_start != -1);
int first_position = help_start_positions.begin()->second;
for (const auto& entry : help_start_positions) {
REQUIRE(entry.second == first_position);
}
} }