Add -V and --version CLI arguments

Author: rodrigoprimo

Scripts/DocCodeExamples/Config.php

@@ -95,6 +95,10 @@ class Config
                 'arg'  => '--help',
                 'desc' => 'Print this help.',
             ],
+            [
+                'arg'  => '-V, --version',
+                'desc' => 'Display the current version of this script.',
+            ],
         ],
         // phpcs:enable
     ];
@@ -108,6 +112,8 @@ class Config
         '--exclude=',
         '--ignore-sniffs=',
         '--help',
+        '-V',
+        '--version',
     ];
 
     /**
@@ -137,12 +143,26 @@ public function getProperty(string $propertyName)
         return $this->{$propertyName};
     }
 
+    /**
+     * Retrieve the version number of this script.
+     *
+     * @return string
+     */
+    public function getVersion()
+    {
+        $text  = 'PHPCSDevTools: XML documentation code examples checker version ';
+        $text .= \file_get_contents(__DIR__ . '/../../VERSION');
+        $text .= \PHP_EOL . 'by PHPCSDevTools Contributors' . \PHP_EOL . \PHP_EOL;
+
+        return $text;
+    }
+
     /**
      * Process the received command arguments.
      *
      * @return void
      */
-    protected function processCliCommand()
+    private function processCliCommand()
     {
         $this->projectRoot = Helper::normalizePath(\getcwd());
         $args              = $_SERVER['argv'];
@@ -154,11 +174,18 @@ protected function processCliCommand()
 
         if (isset($argsFlipped['--help'])) {
             $helpText = HelpTextFormatter::format($this->helpTexts, HelpTextFormatter::isColorSupported());
+            $this->writer->toStdout($this->getVersion());
             $this->writer->toStdout($helpText);
             $this->executeCheck = false;
             return;
         }
 
+        if (isset($argsFlipped['-V']) || isset($argsFlipped['--version'])) {
+            $this->writer->toStdout($this->getVersion());
+            $this->executeCheck = false;
+            return;
+        }
+
         foreach ($args as $arg) {
             if (\strpos($arg, '-') === 0 && $this->isUnsupportedNamedArgument($arg) === true) {
                 throw new \RuntimeException("Unsupported argument $arg");

Tests/DocCodeExamples/ConfigTest.php

@@ -336,6 +336,20 @@ public static function dataProcessCliCommand(): array
                     'executeCheck' => false,
                 ],
             ],
+            'Version argument short'                                                                     => [
+                'command'         => './phpcs-check-doc-examples -V',
+                'expectedChanged' => [
+                    'projectRoot'  => $projectRoot,
+                    'executeCheck' => false,
+                ],
+            ],
+            'Version argument long'                                                                      => [
+                'command'         => './phpcs-check-doc-examples --version',
+                'expectedChanged' => [
+                    'projectRoot'  => $projectRoot,
+                    'executeCheck' => false,
+                ],
+            ],
         ];
 
         // Windows only test: verify that the paths are normalized to use forward slashes.
@@ -377,6 +391,44 @@ public function testHelpOutput()
         $this->assertStringContainsString('phpcs-check-doc-examples', $output);
     }
 
+    /**
+     * Test that the version command outputs the expected text.
+     *
+     * @dataProvider dataVersionOutput
+     *
+     * @param string $command The command to run.
+     *
+     * @return void
+     */
+    public function testVersionOutput($command)
+    {
+        $regex = '`^PHPCSDevTools: XML documentation code examples checker version'
+                 . ' [0-9]{1,}\.[0-9]{1,}\.[0-9]{1,}(?:-(?:alpha|beta|RC)\S+)?'
+                 . '[\r\n]+by PHPCSDevTools Contributors[\r\n]*$`';
+
+        $_SERVER['argv'] = \explode(' ', $command);
+        new Config($this->writer);
+
+        $this->assertMatchesRegularExpression($regex, $this->writer->getStdout());
+    }
+
+    /**
+     * Data provider for the testVersionOutput method.
+     *
+     * @return array<string, array<string, string>>
+     */
+    public static function dataVersionOutput()
+    {
+        return [
+            '-V'        => [
+                'command' => 'phpcs-check-doc-examples -V',
+            ],
+            '--version' => [
+                'command' => 'phpcs-check-doc-examples --version',
+            ],
+        ];
+    }
+
     /**
      * Helper method: retrieve the current values of the Config properties as an array.
      *