Common: prepareForOutput(): Use ANSI color codes on Windows as well

Windows' console supports ANSI escape sequences since Windows 10.
https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences

PHP enables this by default since PHP 7.2.
https://www.php.net/manual/en/function.sapi-windows-vt100-support.php
On older PHP versions, the output with --colors will not be correct,
but this is already the case when using this option.

PHP CodeSniffer special-cased Windows in this code in 2014
(bfd095d).
This workaround is no longer needed today in 2024.

Note that the --colors option was already supported on Windows.
This only affects inline highlighting in error and debug messages.

Author: MatmaRex

src/Tokenizers/PHP.php

@@ -516,10 +516,6 @@ protected function tokenize($string)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
             echo "\t*** START PHP TOKENIZING ***".PHP_EOL;
-            $isWin = false;
-            if (stripos(PHP_OS, 'WIN') === 0) {
-                $isWin = true;
-            }
         }
 
         $tokens      = @token_get_all($string);
@@ -584,11 +580,7 @@ protected function tokenize($string)
                 ) {
                     $token[1] .= "\n";
                     if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                        if ($isWin === true) {
-                            echo '\n';
-                        } else {
-                            echo "\033[30;1m\\n\033[0m";
-                        }
+                        echo "\033[30;1m\\n\033[0m";
                     }
 
                     if ($tokens[($stackPtr + 1)][1] === "\n") {

src/Util/Common.php

@@ -267,8 +267,7 @@ public static function escapeshellcmd($cmd)
     /**
      * Prepares token content for output to screen.
      *
-     * Replaces invisible characters so they are visible. On non-Windows
-     * operating systems it will also colour the invisible characters.
+     * Replaces invisible characters so they are visible, and colour them.
      *
      * @param string   $content The content to prepare.
      * @param string[] $exclude A list of characters to leave invisible.
@@ -291,11 +290,9 @@ public static function prepareForOutput($content, $exclude=[])
 
         $replacements = array_diff_key($replacements, array_fill_keys($exclude, true));
 
-        if (stripos(PHP_OS, 'WIN') !== 0) {
-            // On non-Windows, colour runs of invisible characters.
-            $match   = implode('', array_keys($replacements));
-            $content = preg_replace("/([$match]+)/", "\033[30;1m$1\033[0m", $content);
-        }
+        // Colour runs of invisible characters.
+        $match   = implode('', array_keys($replacements));
+        $content = preg_replace("/([$match]+)/", "\033[30;1m$1\033[0m", $content);
 
         $content = strtr($content, $replacements);
 

tests/Core/Util/Common/PrepareForOutputTest.php

@@ -76,7 +76,7 @@ public static function dataPrepareForOutput()
                 'content'     => "\r\n\t",
                 'exclude'     => [],
                 'expected'    => "\033[30;1m\\r\\n\\t\033[0m",
-                'expectedWin' => "\\r\\n\\t",
+                'expectedWin' => "\033[30;1m\\r\\n\\t\033[0m",
             ],
             'Spaces are replaced with a unique mark'             => [
                 'content'     => "    ",
@@ -103,7 +103,7 @@ public static function dataPrepareForOutput()
                     "\n",
                 ],
                 'expected'    => "\r\n\033[30;1m\\t·\033[0m",
-                'expectedWin' => "\r\n\\t ",
+                'expectedWin' => "\r\n\033[30;1m\\t\033[0m ",
             ],
         ];