[Console] Make error message more verbose

symfony · Nov 1, 2020 · 5164210 · 5164210
1 parent f372360
commit 5164210
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/Input/ArgvInput.php b/Input/ArgvInput.php
@@ -165,11 +165,25 @@ private function parseArgument(string $token)
         // unexpected argument
         } else {
             $all = $this->definition->getArguments();
+            $symfonyCommandName = null;
+            if (($inputArgument = $all[$key = array_key_first($all)] ?? null) && 'command' === $inputArgument->getName()) {
+                $symfonyCommandName = $this->arguments['command'] ?? null;
+                unset($all[$key]);
+            }
+
             if (\count($all)) {
-                throw new RuntimeException(sprintf('Too many arguments, expected arguments "%s".', implode('" "', array_keys($all))));
+                if ($symfonyCommandName) {
+                    $message = sprintf('Too many arguments to "%s" command, expected arguments "%s".', $symfonyCommandName, implode('" "', array_keys($all)));
+                } else {
+                    $message = sprintf('Too many arguments, expected arguments "%s".', implode('" "', array_keys($all)));
+                }
+            } elseif ($symfonyCommandName) {
+                $message = sprintf('No arguments expected for "%s" command, got "%s".', $symfonyCommandName, $token);
+            } else {
+                $message = sprintf('No arguments expected, got "%s".', $token);
             }
 
-            throw new RuntimeException(sprintf('No arguments expected, got "%s".', $token));
+            throw new RuntimeException($message);
         }
     }
 

diff --git a/Tests/Input/ArgvInputTest.php b/Tests/Input/ArgvInputTest.php
@@ -247,6 +247,16 @@ public function provideInvalidInput()
                 new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE)]),
                 'The "-Щ" option does not exist.',
             ],
+            [
+                ['cli.php', 'acme:foo', 'bar'],
+                new InputDefinition([new InputArgument('command', InputArgument::REQUIRED)]),
+                'No arguments expected for "acme:foo" command, got "bar"',
+            ],
+            [
+                ['cli.php', 'acme:foo', 'bar'],
+                new InputDefinition([new InputArgument('name', InputArgument::REQUIRED)]),
+                'Too many arguments, expected arguments "name".',
+            ],
         ];
     }