FEATURE: Introduce help flag option for existing CLI commands

neos · Sep 1, 2024 · b1af6ca · b1af6ca
1 parent af3481b
commit b1af6ca
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/Neos.Flow/Classes/Cli/RequestBuilder.php b/Neos.Flow/Classes/Cli/RequestBuilder.php
@@ -118,6 +118,14 @@ public function build($commandLine): Request
         $request = new Request();
         $request->setControllerObjectName(HelpCommandController::class);
 
+        // @TODO: Can this be implemented even better/cleaner?
+        if (in_array('--help', $commandLine)) {
+            $request->setControllerCommandName('help');
+            $request->setArguments(['commandIdentifier' => $commandLine[0]]);
+            $request->setControllerObjectName(HelpCommandController::class);
+            return $request;
+        }
+
         if (is_array($commandLine) === true) {
             $rawCommandLineArguments = $commandLine;
         } else {

diff --git a/Neos.Flow/Classes/Command/HelpCommandController.php b/Neos.Flow/Classes/Command/HelpCommandController.php
@@ -215,6 +215,8 @@ protected function displayHelpForCommand(Command $command)
             foreach ($optionDescriptions as $optionDescription) {
                 $this->outputLine($optionDescription);
             }
+            $this->outputLine('--help');
+            $this->outputLine('Shows information about the specific command and which parameters are available');
         }
 
         if ($command->getDescription() !== '') {