Use colors when outputting information

Author: rodrigoprimo

Scripts/DocCodeExamples/Check.php

@@ -137,7 +137,13 @@ public function run(): int
         $validationFailedCount = 0;
 
         if (empty($this->xmlFiles)) {
-            $this->writer->toStderr('ERROR: No XML documentation files found.');
+            $message = 'ERROR: No XML documentation files found.' . PHP_EOL;
+
+            if ($this->config->getProperty('showColored') === true) {
+                $message = "\033[31m$message\033[0m";
+            }
+
+            $this->writer->toStderr($message);
             return 1;
         }
 
@@ -165,9 +171,19 @@ public function run(): int
 
         if ($exitCode === 0) {
             $feedback .= ' All code examples are valid.' . PHP_EOL;
+
+            if ($this->config->getProperty('showColored') === true) {
+                $feedback = "\033[32m{$feedback}\033[0m";
+            }
+
             $this->writer->toStdout($feedback);
         } else {
             $feedback .= " Found incorrect code examples in {$validationFailedCount}." . PHP_EOL;
+
+            if ($this->config->getProperty('showColored') === true) {
+                $feedback = "\033[31m{$feedback}\033[0m";
+            }
+
             $this->writer->toStdout($feedback);
         }
 

Scripts/DocCodeExamples/Config.php

@@ -67,6 +67,15 @@ class Config
      */
     protected $executeCheck = true;
 
+    /**
+     * Whether or not to show colored output.
+     *
+     * This is automatically detected.
+     *
+     * @var bool
+     */
+    protected $showColored;
+
     /**
      * Help texts.
      *
@@ -123,7 +132,8 @@ class Config
      */
     public function __construct(Writer $writer)
     {
-        $this->writer = $writer;
+        $this->writer      = $writer;
+        $this->showColored = HelpTextFormatter::isColorSupported();
         $this->processCliCommand();
     }
 
@@ -173,7 +183,7 @@ private function processCliCommand()
         $argsFlipped = \array_flip($args);
 
         if (isset($argsFlipped['--help'])) {
-            $helpText = HelpTextFormatter::format($this->helpTexts, HelpTextFormatter::isColorSupported());
+            $helpText = HelpTextFormatter::format($this->helpTexts, $this->showColored);
             $this->writer->toStdout($this->getVersion());
             $this->writer->toStdout($helpText);
             $this->executeCheck = false;

Tests/DocCodeExamples/CheckTest.php

@@ -71,9 +71,10 @@ final class CheckTest extends XTestCase
      */
     protected function setUpPrerequisites()
     {
-        $this->config      = $this->createCompatibleMockBuilderWithMethods(Config::class, [])
+        $this->config = $this->createCompatibleMockBuilderWithMethods(Config::class, [])
             ->disableOriginalConstructor()
             ->getMock();
+        $this->setObjectProperty($this->config, 'showColored', false);
         $this->extractor   = new CodeBlocksExtractor();
         $cliArgs           = ['--runtime-set', 'installed_paths', \realpath(self::STANDARD_DIR)];
         $this->phpcsConfig = PHPCSConfigLoader::getPHPCSConfigInstance($cliArgs);
@@ -195,7 +196,7 @@ public function testGetXmlDocValidator()
 
     /**
      * Test the run() method without mocking the Check class. Test only the two happy paths.
-     * More detailed tests are performed in the testRun() method.
+     * More detailed tests are performed in the testRun() method. Colored output is disabled.
      *
      * @dataProvider dataRunWithoutMockingCheckClass
      *
@@ -206,7 +207,50 @@ public function testGetXmlDocValidator()
      *
      * @return void
      */
-    public function testRunWithoutMockingCheckClass(array $xmlDocs, int $expectedExitCode, string $expectedStdout, string $expectedStderr)
+    public function testRunWithoutMockingCheckClassWithoutColoredOutput(array $xmlDocs, int $expectedExitCode, string $expectedStdout, string $expectedStderr)
+    {
+        $this->executeTestForRunMethodWithoutMockingCheckClass($xmlDocs, $expectedExitCode, $expectedStdout, $expectedStderr);
+    }
+
+    /**
+     * Test the run() method without mocking the Check class. Test only the two happy paths.
+     * More detailed tests are performed in the testRun() method. Colored output is enabled.
+     *
+     * @dataProvider dataRunWithoutMockingCheckClass
+     *
+     * @param array<string> $xmlDocs          XML doc files to process.
+     * @param int           $expectedExitCode Expected exit code from the run() method.
+     * @param string        $expectedStdout   Expected stdout output.
+     * @param string        $expectedStderr   Expected stderr output.
+     *
+     * @return void
+     */
+    public function testRunWithoutMockingCheckClassWithColoredOutput(array $xmlDocs, int $expectedExitCode, string $expectedStdout, string $expectedStderr)
+    {
+        $this->setObjectProperty($this->config, 'showColored', true);
+
+        if (empty($expectedStderr) === true) {
+            $expectedStdout = "\033[32m{$expectedStdout}\033[0m";
+        } elseif (empty($expectedStdout) === false) {
+            $expectedStdout = "\033[31m{$expectedStdout}\033[0m";
+        }
+
+        $this->executeTestForRunMethodWithoutMockingCheckClass($xmlDocs, $expectedExitCode, $expectedStdout, $expectedStderr);
+    }
+
+    /**
+     * Helper method to execute the run() method of the Check class without mocking it.
+     * This is used for both testRunWithoutMockingCheckClassWithoutColoredOutput and
+     * testRunWithoutMockingCheckClassWithColoredOutput.
+     *
+     * @param array<string> $xmlDocs          XML doc files to process.
+     * @param int           $expectedExitCode Expected exit code from the run() method.
+     * @param string        $expectedStdout   Expected stdout output.
+     * @param string        $expectedStderr   Expected stderr output.
+     *
+     * @return void
+     */
+    protected function executeTestForRunMethodWithoutMockingCheckClass(array $xmlDocs, int $expectedExitCode, string $expectedStdout, string $expectedStderr)
     {
         $this->setObjectProperty($this->config, 'projectRoot', \realpath(self::FIXTURE_DIR));
         $this->setObjectProperty($this->config, 'targetPaths', $xmlDocs);