Peter M. Groen / CLI11

Commit 51a0efcbbc21343345d3120517aa45f1c55d05c1

Authored by Josh Soref
Committed by GitHub
1 parent 34bfa386

Spelling (#429) 

* spelling: argument

* spelling: conflicts

* spelling: correctly

* spelling: default

* spelling: description

* spelling: empty

* spelling: enum

* spelling: javascript

* spelling: modifying

* spelling: nonexistent

* spelling: plumbum

* spelling: programmatically

* spelling: received

* spelling: replaced

* spelling: required

* spelling: sanitizers

* spelling: semicolon

* spelling: source

* spelling: subcommands

* spelling: successful
Inline Side-by-side
Showing 16 changed files with 36 additions and 36 deletions
.github/actions/cmake_config/entrypoint.sh
  View file @51a0efc
... ... @@ -10,7 +10,7 @@ rm -rf cmake_dir/* build_tmp/*
10 10 v=$1
11 11 fn=cmake-$v-Linux-x86_64.tar.gz
12 12  
13   -if [ ! -f cmake_souces/$fn ]; then
  13 +if [ ! -f cmake_sources/$fn ]; then
14 14 wget -qO cmake_sources/$fn "https://cmake.org/files/v${v%.*}/$fn"
15 15 fi
16 16  
... ...
CHANGELOG.md
  View file @51a0efc
... ... @@ -333,7 +333,7 @@ This is a quick patch release that makes LICENSE part of the single header file,
333 333  
334 334 ### Version 1.5.1: Access
335 335  
336   -This patch release adds better access to the App progromatically, to assist with writing custom converters to other formats. It also improves the help output, and uses a new feature in CLI11 1.5 to fix an old "quirk" in the way unlimited options and positionals interact.
  336 +This patch release adds better access to the App programmatically, to assist with writing custom converters to other formats. It also improves the help output, and uses a new feature in CLI11 1.5 to fix an old "quirk" in the way unlimited options and positionals interact.
337 337  
338 338 * Make mixing unlimited positionals and options more intuitive [#102]
339 339 * Add missing getters `get_options` and `get_description` to App [#105]
... ... @@ -360,7 +360,7 @@ Note: This is the final release with `requires`, please switch to `needs`.
360 360 * Support for `std::optional`, `std::experimental::optional`, and `boost::optional` added if `__has_include` is supported [#95]
361 361 * All macros/CMake variables now start with `CLI11_` instead of just `CLI_` [#95]
362 362 * The internal stream was not being cleared before use in some cases. Fixed. [#95]
363   -* Using an emum now requires explicit conversion overload [#97]
  363 +* Using an enum now requires explicit conversion overload [#97]
364 364 * The separator `--` now is removed when it ends unlimited arguments [#100]
365 365  
366 366 Other, non-user facing changes:
... ... @@ -551,7 +551,7 @@ Lots of cleanup and docs additions made it into this release. Parsing is simpler
551 551 ## Version 0.3: Plumbum compatibility
552 552  
553 553 * Added `->requires`, `->excludes`, and `->envname` from [Plumbum](http://plumbum.readthedocs.io/en/latest/)
554   -* Supports `->mandatory` from Plubmum
  554 +* Supports `->mandatory` from Plumbum
555 555 * More tests for help strings, improvements in formatting
556 556 * Support type and set syntax in positionals help strings
557 557 * Added help groups, with `->group("name")` syntax
... ...
CMakeLists.txt
  View file @51a0efc
... ... @@ -51,7 +51,7 @@ list(APPEND build-docs "EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/docs")
51 51 option(CLI11_WARNINGS_AS_ERRORS "Turn all warnings into errors (for CI)")
52 52 option(CLI11_SINGLE_FILE "Generate a single header file")
53 53 cmake_dependent_option(CLI11_SANITIZERS
54   - "Download the sanatizers CMake config" OFF
  54 + "Download the sanitizers CMake config" OFF
55 55 "NOT CMAKE_VERSION VERSION_LESS 3.11" OFF)
56 56  
57 57 cmake_dependent_option(CLI11_BUILD_DOCS
... ... @@ -89,7 +89,7 @@ cmake_dependent_option(CLI11_CUDA_TESTS
89 89 cmake_dependent_option(CLI11_CLANG_TIDY
90 90 "Look for and use Clang-Tidy" OFF
91 91 "CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME;NOT CMAKE_VERSION VERSION_LESS 3.6" OFF)
92   -set(CLI11_CLANG_TIDY_OPTIONS "" CACHE STRING "Clang tidy options, such as -fix, simicolon separated")
  92 +set(CLI11_CLANG_TIDY_OPTIONS "" CACHE STRING "Clang tidy options, such as -fix, semicolon separated")
93 93  
94 94 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND NOT DEFINED CMAKE_CXX_STANDARD)
95 95 set(CMAKE_CXX_STANDARD 11)
... ...
CPPLINT.cfg
  View file @51a0efc
... ... @@ -3,7 +3,7 @@ linelength=120 # As in .clang-format
3 3  
4 4 # Non-used filters
5 5 filter=-build/include_order # Requires unusual include order that encourages creating not self-contained headers
6   -filter=-readability/nolint # Conficts with clang-tidy
  6 +filter=-readability/nolint # Conflicts with clang-tidy
7 7 filter=-runtime/references # Requires fundamental change of API, don't see need for this
8 8 filter=-whitespace/blank_line # Unnecessarily strict with blank lines that otherwise help with readability
9 9 filter=-whitespace/parens,-whitespace/braces # Conflict with clang-format
... ...
book/chapters/options.md
  View file @51a0efc
... ... @@ -105,7 +105,7 @@ CLI::Option* opt = app.add_flag("--opt");
105 105 CLI11_PARSE(app, argv, argc);
106 106  
107 107 if(* opt)
108   - std::cout << "Flag recieved " << opt->count() << " times." << std::endl;
  108 + std::cout << "Flag received " << opt->count() << " times." << std::endl;
109 109 ```
110 110  
111 111 ## Inheritance of defaults
... ...
docs/Doxyfile
  View file @51a0efc
... ... @@ -280,7 +280,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
280 280 # parses. With this tag you can assign which parser to use for a given
281 281 # extension. Doxygen has a built-in mapping, but you can override or extend it
282 282 # using this tag. The format is ext=language, where ext is a file extension, and
283   -# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  283 +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
284 284 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
285 285 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
286 286 # Fortran. In the later case the parser tries to guess whether the code is fixed
... ... @@ -1508,7 +1508,7 @@ FORMULA_FONTSIZE = 10
1508 1508 FORMULA_TRANSPARENT = YES
1509 1509  
1510 1510 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1511   -# http://www.mathjax.org) which uses client side Javascript for the rendering
  1511 +# http://www.mathjax.org) which uses client side JavaScript for the rendering
1512 1512 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1513 1513 # installed or if you want to formulas look prettier in the HTML output. When
1514 1514 # enabled you may also need to install MathJax separately and configure the path
... ... @@ -1578,7 +1578,7 @@ MATHJAX_CODEFILE =
1578 1578 SEARCHENGINE = YES
1579 1579  
1580 1580 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1581   -# implemented using a web server instead of a web client using Javascript. There
  1581 +# implemented using a web server instead of a web client using JavaScript. There
1582 1582 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1583 1583 # setting. When disabled, doxygen will generate a PHP script for searching and
1584 1584 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
... ...
examples/inter_argument_order.cpp
  View file @51a0efc
... ... @@ -17,7 +17,7 @@ int main(int argc, char **argv) {
17 17 auto foo = app.add_option("--foo,-f", foos, "Some unlimited argument");
18 18  
19 19 std::vector<int> bars;
20   - auto bar = app.add_option("--bar", bars, "Some unlimited arggument");
  20 + auto bar = app.add_option("--bar", bars, "Some unlimited argument");
21 21  
22 22 app.add_flag("--z,--x", "Random other flags");
23 23  
... ...
include/CLI/App.hpp
  View file @51a0efc
... ... @@ -984,7 +984,7 @@ class App {
984 984 }
985 985  
986 986 ///@}
987   - /// @name Subcommmands
  987 + /// @name Subcommands
988 988 ///@{
989 989  
990 990 /// Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag
... ...
include/CLI/Error.hpp
  View file @51a0efc
... ... @@ -246,11 +246,11 @@ class RequiredError : public ParseError {
246 246 class ArgumentMismatch : public ParseError {
247 247 CLI11_ERROR_DEF(ParseError, ArgumentMismatch)
248 248 CLI11_ERROR_SIMPLE(ArgumentMismatch)
249   - ArgumentMismatch(std::string name, int expected, std::size_t recieved)
  249 + ArgumentMismatch(std::string name, int expected, std::size_t received)
250 250 : ArgumentMismatch(expected > 0 ? ("Expected exactly " + std::to_string(expected) + " arguments to " + name +
251   - ", got " + std::to_string(recieved))
  251 + ", got " + std::to_string(received))
252 252 : ("Expected at least " + std::to_string(-expected) + " arguments to " + name +
253   - ", got " + std::to_string(recieved)),
  253 + ", got " + std::to_string(received)),
254 254 ExitCodes::ArgumentMismatch) {}
255 255  
256 256 static ArgumentMismatch AtLeast(std::string name, int num, std::size_t received) {
... ...
include/CLI/Validators.hpp
  View file @51a0efc
... ... @@ -282,7 +282,7 @@ class CustomValidator : public Validator {
282 282 namespace detail {
283 283  
284 284 /// CLI enumeration of different file types
285   -enum class path_type { nonexistant, file, directory };
  285 +enum class path_type { nonexistent, file, directory };
286 286  
287 287 #if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0
288 288 /// get the type of the path from a file name
... ... @@ -290,12 +290,12 @@ inline path_type check_path(const char *file) noexcept {
290 290 std::error_code ec;
291 291 auto stat = std::filesystem::status(file, ec);
292 292 if(ec) {
293   - return path_type::nonexistant;
  293 + return path_type::nonexistent;
294 294 }
295 295 switch(stat.type()) {
296 296 case std::filesystem::file_type::none:
297 297 case std::filesystem::file_type::not_found:
298   - return path_type::nonexistant;
  298 + return path_type::nonexistent;
299 299 case std::filesystem::file_type::directory:
300 300 return path_type::directory;
301 301 case std::filesystem::file_type::symlink:
... ... @@ -323,7 +323,7 @@ inline path_type check_path(const char *file) noexcept {
323 323 return ((buffer.st_mode & S_IFDIR) != 0) ? path_type::directory : path_type::file;
324 324 }
325 325 #endif
326   - return path_type::nonexistant;
  326 + return path_type::nonexistent;
327 327 }
328 328 #endif
329 329 /// Check for an existing file (returns error message if check fails)
... ... @@ -332,7 +332,7 @@ class ExistingFileValidator : public Validator {
332 332 ExistingFileValidator() : Validator("FILE") {
333 333 func_ = [](std::string &filename) {
334 334 auto path_result = check_path(filename.c_str());
335   - if(path_result == path_type::nonexistant) {
  335 + if(path_result == path_type::nonexistent) {
336 336 return "File does not exist: " + filename;
337 337 }
338 338 if(path_result == path_type::directory) {
... ... @@ -349,7 +349,7 @@ class ExistingDirectoryValidator : public Validator {
349 349 ExistingDirectoryValidator() : Validator("DIR") {
350 350 func_ = [](std::string &filename) {
351 351 auto path_result = check_path(filename.c_str());
352   - if(path_result == path_type::nonexistant) {
  352 + if(path_result == path_type::nonexistent) {
353 353 return "Directory does not exist: " + filename;
354 354 }
355 355 if(path_result == path_type::file) {
... ... @@ -366,7 +366,7 @@ class ExistingPathValidator : public Validator {
366 366 ExistingPathValidator() : Validator("PATH(existing)") {
367 367 func_ = [](std::string &filename) {
368 368 auto path_result = check_path(filename.c_str());
369   - if(path_result == path_type::nonexistant) {
  369 + if(path_result == path_type::nonexistent) {
370 370 return "Path does not exist: " + filename;
371 371 }
372 372 return std::string();
... ... @@ -380,7 +380,7 @@ class NonexistentPathValidator : public Validator {
380 380 NonexistentPathValidator() : Validator("PATH(non-existing)") {
381 381 func_ = [](std::string &filename) {
382 382 auto path_result = check_path(filename.c_str());
383   - if(path_result != path_type::nonexistant) {
  383 + if(path_result != path_type::nonexistent) {
384 384 return "Path already exists: " + filename;
385 385 }
386 386 return std::string();
... ...
test_package/example.cpp
  View file @51a0efc
... ... @@ -6,7 +6,7 @@
6 6  
7 7 int main(int argc, char **argv) {
8 8  
9   - CLI::App app("Some nice discription");
  9 + CLI::App app("Some nice description");
10 10  
11 11 int x = 0;
12 12 app.add_option("-x", x, "an integer value", true /* show default */);
... ...
tests/AppTest.cpp
  View file @51a0efc
... ... @@ -1394,7 +1394,7 @@ TEST_F(TApp, RequireOptPriorityShort) {
1394 1394 EXPECT_EQ(remain, std::vector<std::string>({"two", "three"}));
1395 1395 }
1396 1396  
1397   -TEST_F(TApp, NotRequiedExpectedDouble) {
  1397 +TEST_F(TApp, NotRequiredExpectedDouble) {
1398 1398  
1399 1399 std::vector<std::string> strs;
1400 1400 app.add_option("--str", strs)->expected(2);
... ... @@ -1404,7 +1404,7 @@ TEST_F(TApp, NotRequiedExpectedDouble) {
1404 1404 EXPECT_THROW(run(), CLI::ArgumentMismatch);
1405 1405 }
1406 1406  
1407   -TEST_F(TApp, NotRequiedExpectedDoubleShort) {
  1407 +TEST_F(TApp, NotRequiredExpectedDoubleShort) {
1408 1408  
1409 1409 std::vector<std::string> strs;
1410 1410 app.add_option("-s", strs)->expected(2);
... ... @@ -2338,7 +2338,7 @@ TEST_F(TApp, OptionWithDefaults) {
2338 2338 }
2339 2339  
2340 2340 // Added to test ->transform
2341   -TEST_F(TApp, OrderedModifingTransforms) {
  2341 +TEST_F(TApp, OrderedModifyingTransforms) {
2342 2342 std::vector<std::string> val;
2343 2343 auto m = app.add_option("-m", val);
2344 2344 m->transform([](std::string x) { return x + "1"; });
... ...
tests/DeprecatedTest.cpp
  View file @51a0efc
... ... @@ -5,7 +5,7 @@
5 5 using ::testing::HasSubstr;
6 6 using ::testing::Not;
7 7  
8   -TEST(Deprecated, Emtpy) {
  8 +TEST(Deprecated, Empty) {
9 9 // No deprecated features at this time.
10 10 EXPECT_TRUE(true);
11 11 }
... ...
tests/HelpTest.cpp
  View file @51a0efc
... ... @@ -731,7 +731,7 @@ struct CapturedHelp : public ::testing::Test {
731 731 }
732 732 };
733 733  
734   -TEST_F(CapturedHelp, Sucessful) {
  734 +TEST_F(CapturedHelp, Successful) {
735 735 EXPECT_EQ(run(CLI::Success()), 0);
736 736 EXPECT_EQ(out.str(), "");
737 737 EXPECT_EQ(err.str(), "");
... ... @@ -825,7 +825,7 @@ TEST_F(CapturedHelp, AllOnlyError) {
825 825 EXPECT_THAT(err.str(), Not(HasSubstr("Usage")));
826 826 }
827 827  
828   -TEST_F(CapturedHelp, RepacedError) {
  828 +TEST_F(CapturedHelp, ReplacedError) {
829 829 app.failure_message(CLI::FailureMessage::help);
830 830  
831 831 EXPECT_EQ(run(CLI::ExtrasError({"Thing"})), static_cast<int>(CLI::ExitCodes::ExtrasError));
... ... @@ -995,7 +995,7 @@ TEST(THelp, CombinedValidatorsText) {
995 995 app.add_option("--f1", filename)->check(CLI::ExistingFile | CLI::ExistingDirectory);
996 996  
997 997 // This would be nice if it put something other than string, but would it be path or file?
998   - // Can't programatically tell!
  998 + // Can't programmatically tell!
999 999 // (Users can use ExistingPath, by the way)
1000 1000 std::string help = app.help();
1001 1001 EXPECT_THAT(help, HasSubstr("TEXT:(FILE) OR (DIR)"));
... ...
tests/SubcommandTest.cpp
  View file @51a0efc
... ... @@ -104,7 +104,7 @@ TEST_F(TApp, CrazyNameSubcommand) {
104 104 EXPECT_EQ(sub1->count(), 1u);
105 105 }
106 106  
107   -TEST_F(TApp, RequiredAndSubcoms) { // #23
  107 +TEST_F(TApp, RequiredAndSubcommands) { // #23
108 108  
109 109 std::string baz;
110 110 app.add_option("baz", baz, "Baz Description", true)->required();
... ... @@ -719,7 +719,7 @@ TEST_F(TApp, Required1SubCom) {
719 719 EXPECT_THROW(run(), CLI::ExtrasError);
720 720 }
721 721  
722   -TEST_F(TApp, BadSubcomSearch) {
  722 +TEST_F(TApp, BadSubcommandSearch) {
723 723  
724 724 auto one = app.add_subcommand("one");
725 725 auto two = one->add_subcommand("two");
... ...
tests/TransformTest.cpp
  View file @51a0efc
... ... @@ -104,7 +104,7 @@ TEST_F(TApp, EnumCheckedTransform) {
104 104 }
105 105  
106 106 // from jzakrzewski Issue #330
107   -TEST_F(TApp, EnumCheckedDefualtTransform) {
  107 +TEST_F(TApp, EnumCheckedDefaultTransform) {
108 108 enum class existing : std::int16_t { abort, overwrite, remove };
109 109 app.add_option("--existing", "What to do if file already exists in the destination")
110 110 ->transform(
... ... @@ -541,7 +541,7 @@ TEST_F(TApp, BoundTests) {
541 541 EXPECT_TRUE(help.find("[3.4 - 5.9]") != std::string::npos);
542 542 }
543 543  
544   -TEST_F(TApp, NumberWithUnitCorrecltySplitNumber) {
  544 +TEST_F(TApp, NumberWithUnitCorrectlySplitNumber) {
545 545 std::map<std::string, int> mapping{{"a", 10}, {"b", 100}, {"cc", 1000}};
546 546  
547 547 int value = 0;
... ...