Merge pull request #6383 from paulbalandan/spark-help-option

Allow calling help info using `spark --help`

Author: kenjis

phpstan-baseline.neon.dist

@@ -60,6 +60,11 @@ parameters:
 			count: 1
 			path: system/Cache/Handlers/RedisHandler.php
 
+		-
+			message: "#^Strict comparison using === between array and array{} will always evaluate to false\\.$#"
+			count: 1
+			path: system/CLI/Console.php
+
 		-
 			message: "#^Call to an undefined method CodeIgniter\\\\HTTP\\\\Request\\:\\:getPost\\(\\)\\.$#"
 			count: 1

system/CLI/Console.php

@@ -31,6 +31,7 @@ public function run()
     {
         $runner  = Services::commands();
         $params  = array_merge(CLI::getSegments(), CLI::getOptions());
+        $params  = $this->parseParamsForHelpOption($params);
         $command = array_shift($params) ?? 'list';
 
         return $runner->run($command, $params);
@@ -53,4 +54,24 @@ public function showHeader(bool $suppress = false)
         ), 'green');
         CLI::newLine();
     }
+
+    /**
+     * Introspects the `$params` passed for presence of the
+     * `--help` option.
+     *
+     * If present, it will be found as `['help' => null]`.
+     * We'll remove that as an option from `$params` and
+     * unshift it as argument instead.
+     */
+    private function parseParamsForHelpOption(array $params): array
+    {
+        if (array_key_exists('help', $params)) {
+            unset($params['help']);
+
+            $params = $params === [] ? ['list'] : $params;
+            array_unshift($params, 'help');
+        }
+
+        return $params;
+    }
 }

tests/system/CLI/ConsoleTest.php

@@ -99,6 +99,40 @@ public function testHelpCommandDetails()
         $this->assertStringContainsString('Options:', $this->getStreamFilterBuffer());
     }
 
+    public function testHelpCommandUsingHelpOption()
+    {
+        $this->initCLI('env', '--help');
+
+        (new Console())->run();
+
+        $this->assertStringContainsString('env [<environment>]', $this->getStreamFilterBuffer());
+        $this->assertStringContainsString(
+            'Retrieves the current environment, or set a new one.',
+            $this->getStreamFilterBuffer()
+        );
+    }
+
+    public function testHelpOptionIsOnlyPassed()
+    {
+        $this->initCLI('--help');
+
+        (new Console())->run();
+
+        // Since calling `php spark` is the same as calling `php spark list`,
+        // `php spark --help` should be the same as `php spark list --help`
+        $this->assertStringContainsString('Lists the available commands.', $this->getStreamFilterBuffer());
+    }
+
+    public function testHelpArgumentAndHelpOptionCombined()
+    {
+        $this->initCLI('help', '--help');
+
+        (new Console())->run();
+
+        // Same as calling `php spark help` only
+        $this->assertStringContainsString('Displays basic usage information.', $this->getStreamFilterBuffer());
+    }
+
     /**
      * @param array $command
      */

user_guide_src/source/changelogs/v4.3.0.rst

@@ -66,6 +66,7 @@ Others
 - Added method ``Timer::record()`` to measure performance in a callable. Also enhanced common function ``timer()`` to accept optional callable.
 - Now ``spark routes`` command shows route names. See :ref:`URI Routing <routing-spark-routes>`.
 - Added new :ref:`entities-property-casting` class ``IntBoolCast`` for Entity.
+- Help information for a spark command can now be accessed using the ``--help`` option (e.g. ``php spark serve --help``)
 
 Changes
 *******