fix: make the IncorrectConstruction errors on bad subcommand name more comprehensible. (#602)

Philip Top · GitHub
1 parent ee2b7250
Showing 2 changed files with 37 additions and 2 deletions
include/CLI/App.hpp
tests/SubcommandTest.cpp
@@ -368,7 +368,20 @@ class App {
     /// Set an alias for the app
     App *alias(std::string app_name) {
         if(!detail::valid_name_string(app_name)) {
-            throw(IncorrectConstruction("alias is not a valid name string"));
+            if(app_name.empty()) {
+                throw IncorrectConstruction("Empty aliases are not allowed");
+            }
+            if(!detail::valid_first_char(app_name[0])) {
+                throw IncorrectConstruction(
+                    "Alias starts with invalid character, allowed characters are [a-zA-z0-9]+'_','?','@' ");
+            }
+            for(auto c : app_name) {
+                if(!detail::valid_later_char(c)) {
+                    throw IncorrectConstruction(std::string("Alias contains invalid character ('") + c +
+                                                "'), allowed characters are "
+                                                "[a-zA-z0-9]+'_','?','@','.','-' ");
+                }
+            }
         }
  
         if(parent_ != nullptr) {
@@ -963,7 +976,17 @@ class App {
     /// Add a subcommand. Inherits INHERITABLE and OptionDefaults, and help flag
     App *add_subcommand(std::string subcommand_name = "", std::string subcommand_description = "") {
         if(!subcommand_name.empty() && !detail::valid_name_string(subcommand_name)) {
-            throw IncorrectConstruction("subcommand name is not valid");
+            if(!detail::valid_first_char(subcommand_name[0])) {
+                throw IncorrectConstruction(
+                    "Subcommand name starts with invalid character, allowed characters are [a-zA-z0-9]+'_','?','@' ");
+            }
+            for(auto c : subcommand_name) {
+                if(!detail::valid_later_char(c)) {
+                    throw IncorrectConstruction(std::string("Subcommand name contains invalid character ('") + c +
+                                                "'), allowed characters are "
+                                                "[a-zA-z0-9]+'_','?','@','.','-' ");
+                }
+            }
         }
         CLI::App_p subcom = std::shared_ptr<App>(new App(std::move(subcommand_description), subcommand_name, this));
         return add_subcommand(std::move(subcom));
@@ -811,6 +811,18 @@ TEST_CASE_METHOD(TApp, &quot;RequiredPosInSubcommand&quot;, &quot;[subcom]&quot;) {
     CHECK_THROWS_AS(run(), CLI::RequiredError);
 }
  
+TEST_CASE_METHOD(TApp, "invalidSubcommandName", "[subcom]") {
+
+    bool gotError{false};
+    try {
+        app.add_subcommand("foo/foo", "Foo a bar");
+    } catch(const CLI::IncorrectConstruction &e) {
+        gotError = true;
+        CHECK_THAT(e.what(), Contains("/"));
+    }
+    CHECK(gotError);
+}
+
 struct SubcommandProgram : public TApp {
  
     CLI::App *start{nullptr};