Added support for highlighted source code with suggested package jakub-onderka/php-console-highlighter

Author: JakubOnderka

composer.json

@@ -6,6 +6,9 @@
     "require": {
         "php": ">=5.3.2"
     },
+    "suggest": {
+        "jakub-onderka/php-console-highlighter": "Highlight syntax in code snippet"
+    },
     "authors": [
         {
             "name": "Jakub Onderka",

parallel-lint.php

@@ -21,6 +21,7 @@ function showOptions()
     --exclude   Exclude directory. If you want exclude multiple directory, use
                 multiple exclude parameters.
     -j <num>    Run <num> jobs in parallel (default 10)
+    --no-colors Disable colors in console output.
     -h, --help  Print this help.
 <?php
 }
@@ -38,7 +39,7 @@ function showOptions()
     exit;
 }
 
-require_once __DIR__ . '/src/Manager.php';
+require_once __DIR__ . '/vendor/autoload.php';
 
 try {
     $manager = new PhpParallelLint\Manager;

src/Error.php

@@ -30,6 +30,8 @@
 either expressed or implied, of the FreeBSD Project.
  */
 
+use JakubOnderka\PhpConsoleHighlighter\Highlighter;
+
 class Error
 {
     /** @var string */
@@ -92,22 +94,26 @@ public function __toString()
     }
 
     /**
-     * @param int $line
+     * @param int $lineNumber
+     * @param int $linesBefore
+     * @param int $linesAfter
      * @return string
      */
-    protected function getCodeSnippet($line)
+    protected function getCodeSnippet($lineNumber, $linesBefore = 2, $linesAfter = 2)
     {
         $lines = file($this->filePath);
 
-        $snippet = '';
-        $lineStrlen = strlen($line + 2);
-        $line -= 1; // because $lines array is indexed from zero
+        $offset = $lineNumber - $linesBefore - 1;
+        $length = $linesAfter + $linesBefore + 1;
+        $lines = array_slice($lines, $offset, $length, $preserveKeys = true);
 
-        for ($i = $line - 2; $i <= $line + 2; $i++) {
-            if (isset($lines[$i])) {
-                $snippet .= ($line === $i ? '  > ' : '    ');
-                $snippet .= $this->stringWidth($i + 1, $lineStrlen) . '| ' . rtrim($lines[$i]) . PHP_EOL;
-            }
+        end($lines);
+        $lineStrlen = strlen(key($lines) + 1);
+
+        $snippet = '';
+        foreach ($lines as $i => $line) {
+            $snippet .= ($lineNumber === $i + 1 ? '  > ' : '    ');
+            $snippet .= str_pad($i + 1, $lineStrlen, ' ', STR_PAD_LEFT) . '| ' . rtrim($line) . PHP_EOL;
         }
 
         return $snippet;
@@ -188,4 +194,33 @@ protected function getShortFilePath()
     {
         return str_replace(getcwd(), '', $this->filePath);
     }
+}
+
+class SyntaxErrorColored extends SyntaxError
+{
+    /**
+     * @param int $lineNumber
+     * @param int $linesBefore
+     * @param int $linesAfter
+     * @return string
+     */
+    protected function getCodeSnippet($lineNumber, $linesBefore = 2, $linesAfter = 2)
+    {
+        if (!class_exists('\JakubOnderka\PhpConsoleHighlighter\Highlighter')) {
+            return parent::getCodeSnippet($lineNumber, $linesBefore, $linesAfter);
+        }
+
+        $colors = new \Colors\Color();
+        $colors->setTheme(array(
+            Highlighter::TOKEN_STRING => 'red',
+            Highlighter::TOKEN_COMMENT => 'yellow',
+            Highlighter::TOKEN_KEYWORD => 'green',
+            Highlighter::TOKEN_DEFAULT => 'white',
+            Highlighter::TOKEN_HTML => 'cyan'
+        ));
+        $highliger = new Highlighter($colors);
+
+        $fileContent = file_get_contents($this->filePath);
+        return $highliger->getCodeSnippet($fileContent, $lineNumber, $linesBefore, $linesAfter);
+    }
 }

src/Manager.php

@@ -30,13 +30,6 @@
 either expressed or implied, of the FreeBSD Project.
  */
 
-
-require_once __DIR__ . '/exceptions.php';
-require_once __DIR__ . '/Settings.php';
-require_once __DIR__ . '/Process.php';
-require_once __DIR__ . '/Output.php';
-require_once __DIR__ . '/Error.php';
-
 class Manager
 {
     const CODE_OK = 0,
@@ -87,6 +80,10 @@ public function parseArguments(array $arguments)
                         $setting->parallelJobs = max((int) $arguments->getNext(), 1);
                         break;
 
+                    case '--no-colors':
+                        $setting->colors = false;
+                        break;
+
                     default:
                         throw new InvalidArgumentException($argument);
                 }
@@ -108,7 +105,7 @@ public function parseArguments(array $arguments)
     public function run(Settings $settings = null)
     {
         $settings = $settings ?: new Settings;
-        $output = $this->output ?: new Output(new ConsoleWriter);
+        $output = $this->output ?: ($settings->colors ? new OutputColored(new ConsoleWriter) : new Output(new ConsoleWriter));
 
         $this->checkPhpExecutableExists($settings->phpExecutable);
 
@@ -145,7 +142,12 @@ public function run(Settings $settings = null)
                     } else {
                         $checkedFiles++;
                         if ($process->hasSyntaxError()) {
-                            $errors[] = new SyntaxError($file, $process->getSyntaxError());
+                            if ($settings->colors) {
+                                $errors[] = new SyntaxErrorColored($file, $process->getSyntaxError());
+                            } else {
+                                $errors[] = new SyntaxError($file, $process->getSyntaxError());
+                            }
+
                             $filesWithSyntaxError++;
                             $output->error();
                         } else {
@@ -174,7 +176,7 @@ public function run(Settings $settings = null)
             $output->writeNewLine();
 
             foreach ($errors as $errorMessage) {
-                $output->writeLine('----------------------------------------------------------------------');
+                $output->writeLine(str_repeat('-', 60));
                 $output->writeLine($errorMessage);
             }
 

src/Output.php

@@ -115,6 +115,31 @@ protected function stringWidth($input, $width = 3)
     }
 }
 
+class OutputColored extends Output
+{
+    /** @var \Colors\Color */
+    private $colors;
+
+    public function __construct(IWriter $writer)
+    {
+        parent::__construct($writer);
+
+        if (class_exists('\Colors\Color')) {
+            $this->colors = new \Colors\Color();
+        }
+    }
+
+    public function error()
+    {
+        if ($this->colors) {
+            $this->writer->write($this->colors->apply('bg_red', 'X'));
+            $this->progress();
+        } else {
+             parent::error();
+        }
+    }
+}
+
 interface IWriter
 {
     /**

src/Settings.php

@@ -73,4 +73,10 @@ class Settings
      * @var array
      */
     public $excluded = array();
+
+    /**
+     * Print to console with colors
+     * @var bool
+     */
+    public $colors = true;
 }