Always output version header when running the script

Author: rodrigoprimo

Scripts/DocCodeExamples/Check.php

@@ -131,6 +131,8 @@ public function __construct(
      */
     public function run(): int
     {
+        $this->writer->toStderr($this->config->getVersion());
+
         $exitCode = 0;
 
         if (empty($this->xmlFiles)) {

Tests/DocCodeExamples/ConfigTest.php

@@ -402,14 +402,10 @@ public function testHelpOutput()
      */
     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());
+        $this->assertMatchesRegularExpression(VersionTestUtils::VERSION_HEADER_REGEX, $this->writer->getStdout());
     }
 
     /**

Tests/DocCodeExamples/EndToEndTest.php

@@ -109,12 +109,24 @@ public function testScriptBasicExecution(string $cliArgs, int $expectedExitCode,
         $this->assertEmpty($result['stdout']);
 
         if (empty($expectedStderr)) {
-            $this->assertEmpty($result['stderr']);
+            $this->assertStderrContainsOnlyScriptHeader($result['stderr']);
         } else {
             $this->assertMatchesRegularExpression($expectedStderr, $result['stderr']);
         }
     }
 
+    /**
+     * Assert that stderr contains only the script header and nothing else.
+     *
+     * @param string $stderr The stderr output to check.
+     *
+     * @return void
+     */
+    protected function assertStderrContainsOnlyScriptHeader(string $stderr)
+    {
+        $this->assertMatchesRegularExpression(VersionTestUtils::VERSION_HEADER_REGEX, $stderr);
+    }
+
     /**
      * Data provider for testScriptBasicExecution.
      *

Tests/DocCodeExamples/VersionTestUtils.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Tests\DocCodeExamples;
+
+/**
+ * Utility class for version headeroutput testing.
+ */
+class VersionTestUtils
+{
+    const VERSION_HEADER_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]*$`';
+}

phpcs.xml.dist

@@ -143,4 +143,9 @@
 		<exclude-pattern>/Tests/DocCodeExamples/*\.php$</exclude-pattern>
 	</rule>
 
+	<rule ref="PHPCompatibility.InitialValue.NewConstantScalarExpressions.constFound">
+		<exclude-pattern>/Scripts/DocCodeExamples/*\.php$</exclude-pattern>
+		<exclude-pattern>/Tests/DocCodeExamples/*\.php$</exclude-pattern>
+	</rule>
+
 </ruleset>