Merge pull request #82 from glady/issue_78

Issue #78: added option to force colors

Author: phpjsdev623

parallel-lint.php

@@ -28,6 +28,7 @@ function showOptions()
     --exclude       Exclude a file or directory. If you want exclude multiple items,
                     use multiple exclude parameters.
     -j <num>        Run <num> jobs in parallel (default: 10).
+    --colors        Enable colors in console output. (disables auto detection of color support)
     --no-colors     Disable colors in console output.
     --json          Output results as JSON string (require PHP 5.4).
     --blame         Try to show git blame for row with error.

src/ErrorFormatter.php

@@ -35,15 +35,19 @@
 
 class ErrorFormatter
 {
-    /** @var bool */
+    /** @var string */
     private $useColors;
 
+    /** @var bool */
+    private $forceColors;
+
     /** @var bool */
     private $translateTokens;
 
-    public function __construct($useColors = false, $translateTokens = false)
+    public function __construct($useColors = Settings::AUTODETECT, $translateTokens = false, $forceColors = false)
     {
         $this->useColors = $useColors;
+        $this->forceColors = $forceColors;
         $this->translateTokens = $translateTokens;
     }
 
@@ -78,7 +82,7 @@ public function formatSyntaxErrorMessage(SyntaxError $error, $withCodeSnipped =
             $string .= ":$onLine" . PHP_EOL;
 
             if ($withCodeSnipped) {
-                if ($this->useColors) {
+                if ($this->useColors !== Settings::DISABLED) {
                     $string .= $this->getColoredCodeSnippet($error->getFilePath(), $onLine);
                 } else {
                     $string .= $this->getCodeSnippet($error->getFilePath(), $onLine);
@@ -143,10 +147,10 @@ protected function getColoredCodeSnippet($filePath, $lineNumber, $linesBefore =
         }
 
         $colors = new ConsoleColor();
-        $colors->setForceStyle(true);
+        $colors->setForceStyle($this->forceColors);
         $highlighter = new Highlighter($colors);
 
         $fileContent = file_get_contents($filePath);
         return $highlighter->getCodeSnippet($fileContent, $lineNumber, $linesBefore, $linesAfter);
     }
-}
+}

src/Manager.php

@@ -107,7 +107,10 @@ protected function getDefaultOutput(Settings $settings)
         if ($settings->json) {
             return new JsonOutput($writer);
         } else {
-            return ($settings->colors ? new TextOutputColored($writer) : new TextOutput($writer));
+            if ($settings->colors === Settings::DISABLED) {
+                return new TextOutput($writer);
+            }
+            return new TextOutputColored($writer, $settings->colors);
         }
     }
 

src/Output.php

@@ -320,13 +320,13 @@ class TextOutputColored extends TextOutput
     /** @var \JakubOnderka\PhpConsoleColor\ConsoleColor */
     private $colors;
 
-    public function __construct(IWriter $writer)
+    public function __construct(IWriter $writer, $colors = Settings::AUTODETECT)
     {
         parent::__construct($writer);
 
         if (class_exists('\JakubOnderka\PhpConsoleColor\ConsoleColor')) {
             $this->colors = new \JakubOnderka\PhpConsoleColor\ConsoleColor();
-            $this->colors->setForceStyle(true);
+            $this->colors->setForceStyle($colors === Settings::FORCED);
         }
     }
 

src/Settings.php

@@ -32,6 +32,14 @@
 
 class Settings
 {
+
+    /**
+     * constants for enum settings
+     */
+    const FORCED = 'FORCED';
+    const DISABLED = 'DISABLED';
+    const AUTODETECT = 'AUTODETECT';
+
     /**
      * Path to PHP executable
      * @var string
@@ -75,10 +83,10 @@ class Settings
     public $excluded = array();
 
     /**
-     * Print to console with colors
-     * @var bool
+     * Mode for color detection. Possible values: self::FORCED, self::DISABLED and self::AUTODETECT
+     * @var string
      */
-    public $colors = true;
+    public $colors = self::AUTODETECT;
 
     /**
      * Output results as JSON string
@@ -158,8 +166,12 @@ public static function parseArguments(array $arguments)
                         $settings->parallelJobs = max((int) $arguments->getNext(), 1);
                         break;
 
+                    case '--colors':
+                        $settings->colors = self::FORCED;
+                        break;
+
                     case '--no-colors':
-                        $settings->colors = false;
+                        $settings->colors = self::DISABLED;
                         break;
 
                     case '--json':

tests/Settings.parseArguments.phpt

@@ -25,7 +25,7 @@ class SettingsParseArgumentsTest extends Tester\TestCase
         $expectedSettings->extensions = array('php', 'phtml', 'php3', 'php4', 'php5');
         $expectedSettings->paths = array('.');
         $expectedSettings->excluded = array();
-        $expectedSettings->colors = true;
+        $expectedSettings->colors = Settings::AUTODETECT;
         $expectedSettings->json = false;
 
         Assert::equal($expectedSettings->phpExecutable, $settings->phpExecutable);
@@ -53,7 +53,7 @@ class SettingsParseArgumentsTest extends Tester\TestCase
         $expectedSettings->extensions = array('php', 'phtml', 'php3', 'php4', 'php5');
         $expectedSettings->paths = array('.');
         $expectedSettings->excluded = array('vendor');
-        $expectedSettings->colors = false;
+        $expectedSettings->colors = Settings::DISABLED;
         $expectedSettings->json = false;
 
         Assert::equal($expectedSettings->phpExecutable, $settings->phpExecutable);
@@ -66,6 +66,18 @@ class SettingsParseArgumentsTest extends Tester\TestCase
         Assert::equal($expectedSettings->colors, $settings->colors);
         Assert::equal($expectedSettings->json, $settings->json);
     }
+
+    public function testColorsForced()
+    {
+        $commandLine = "./parallel-lint --exclude vendor --colors .";
+        $argv = explode(" ", $commandLine);
+        $settings = Settings::parseArguments($argv);
+
+        $expectedSettings = new Settings();
+        $expectedSettings->colors = Settings::FORCED;
+
+        Assert::equal($expectedSettings->colors, $settings->colors);
+    }
 }
 
 $testCase = new SettingsParseArgumentsTest;