Merge pull request #4 from adhocore/2-line-nos

Prepend line number to the highlighted code

Author: adhocore

README.md

@@ -63,19 +63,19 @@ clish -f file.php -o file.png
 
 #### Options
 
-Parameter options.
+Parameter options:
 
 ```
-  [-e|--echo]         Forces echo to STDOUT when --output is passed
-  [-f|--file]         Input PHP file to highlight and/or export
-                      (will read from piped input if file not given)
-  [-F|--font]         Font to use for export to png
-  [-h|--help]         Show help
-  [-o|--output]       Output filepath where PNG image is exported
-  [-v|--verbosity]    Verbosity level
-  [-V|--version]      Show version
+  [-e|--echo]            Forces echo to STDOUT when --output is passed
+  [-f|--file]            Input PHP file to highlight and/or export
+                         (will read from piped input if file not given)
+  [-F|--font]            Font to use for export to png
+  [-l|--with-line-no]    Highlight with line number
+  [-o|--output]          Output filepath where PNG image is exported
 ```
 
+> Run `clish -h` to show help.
+
 ##### Examples
 
 ```sh
@@ -84,6 +84,7 @@ Parameter options.
   bin/clish < file.php                                # from redirected stdin
   bin/clish --file file.php --output file.png         # export
   bin/clish --file file.php --output file.png --echo  # print + export
+  bin/clish --file file.php --with-line-no            # print with lineno
   bin/clish -f file.php -o file.png -F dejavu         # export in dejavu font
 ```
 
@@ -99,10 +100,15 @@ use Ahc\CliSyntax\Highlighter;
 // PHP code
 echo new Highlighter('<?php echo "Hello world!";');
 // OR
-echo (new Highlighter)->highlight('<?php echo "Hello world!";');
+echo (new Highlighter)->highlight('<?php echo "Hello world!";', $options);
 
 // PHP file
-echo Highlighter::for('/path/to/file.php');
+echo Highlighter::for('/path/to/file.php', $options);
+
+// $options array is optional and can contain:
+[
+    'lineNo' => true, // bool
+];
 ```
 
 #### Export
@@ -111,13 +117,24 @@ echo Highlighter::for('/path/to/file.php');
 use Ahc\CliSyntax\Exporter;
 
 // PHP file
-Exporter::for('/path/to/file.php')->export('file.png');
+Exporter::for('/path/to/file.php')->export('file.png', $options);
+
+// $options array is optional and can contain:
+[
+    'lineNo' => true, // bool
+    'font'   => 'full/path/of/font.ttf', // str
+    'size'   => 'font size', // int
+];
 ```
 
 See [example usage](./example.php). Here's how the export looks like:
 
 ![adhocore/cli-syntax](./example.png)
 
+---
+And with line numbers:
+
+![Example with line numbers](https://imgur.com/Jqiydf8.png)
 
 ## Customisation
 

composer.json

@@ -27,7 +27,7 @@
         "php": ">=7.0.0",
         "ext-dom": "*",
         "ext-gd": "*",
-        "adhocore/cli": "^0.7.0"
+        "adhocore/cli": "^0.8.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.5 || ^7.5"

example.png

@@ -27,6 +27,7 @@ public function __construct()
         $this
             ->option('-o --output', 'Output filepath where PNG image is exported', null, '')
             ->option('-e --echo', 'Forces echo to STDOUT when --output is passed', null, '')
+            ->option('-l --with-line-no', 'Highlight with line number')
             ->option('-f --file', \implode("\n", [
                 'Input PHP file to highlight and/or export',
                 '(will read from piped input if file not given)',
@@ -38,6 +39,7 @@ public function __construct()
                 . '<bold>  $0</end> <comment>< file.php</end> ## from redirected stdin<eol/>'
                 . '<bold>  $0</end> <comment>--file file.php --output file.png</end> ## export<eol/>'
                 . '<bold>  $0</end> <comment>--file file.php --output file.png --echo</end> ## print + export<eol/>'
+                . '<bold>  $0</end> <comment>--file file.php --with-line-no</end> ## print with lineno<eol/>'
                 . '<bold>  $0</end> <comment>-f file.php -o file.png -F dejavu</end> ## export in dejavu font<eol/>'
             );
     }
@@ -78,7 +80,7 @@ public function execute()
     protected function doHighlight(string $code = null)
     {
         if (!$this->output || $this->echo) {
-            $this->app()->io()->raw((string) new Highlighter($code));
+            $this->app()->io()->raw((new Highlighter)->highlight($code, ['lineNo' => $this->lineNo]));
         }
     }
 
@@ -92,7 +94,7 @@ protected function doExport(string $code = null)
             \mkdir(\dirname($this->output), 0755, true);
         }
 
-        $options = ['font' => $this->fixFont($this->font ?: 'ubuntu')];
+        $options = ['font' => $this->fixFont($this->font ?: 'ubuntu'), 'lineNo' => $this->lineNo];
 
         (new Exporter($code))->export($this->output, $options);
     }

src/Console/ClishCommand.php

@@ -30,9 +30,6 @@ class Exporter extends Pretty
     /** @var array Colors cached for each types. */
     protected $colors = [];
 
-    /** @var array Lengths of each line */
-    protected $lengths = [];
-
     public function __destruct()
     {
         if (\is_resource($this->image)) {
@@ -48,8 +45,11 @@ public function export(string $output, array $options = [])
 
         $this->setOptions($options);
 
-        $this->imgSize = $this->estimateSize($this->code);
-        $this->image   = \imagecreate($this->imgSize['x'] + 50, $this->imgSize['y'] + 25);
+        $this->imgSize   = $this->estimateSize($this->code);
+        $this->lineCount = \substr_count($this->code, "\n") ?: 1;
+
+        $padLineNo   = $this->withLineNo ? $this->estimateSize($this->formatLineNo())['x'] : 0;
+        $this->image = \imagecreate($this->imgSize['x'] + $padLineNo + 50, $this->imgSize['y'] + 25);
 
         \imagecolorallocate($this->image, 0, 0, 0);
 
@@ -60,6 +60,8 @@ public function export(string $output, array $options = [])
 
     protected function setOptions(array $options)
     {
+        parent::setOptions($options);
+
         if (isset($options['size'])) {
             $this->size = $options['size'];
         }
@@ -90,28 +92,32 @@ protected function estimateSize(string $for): array
         return ['x' => $box[2], 'y' => $box[1], 'y1' => \intval($box[1] / $eol)];
     }
 
-    protected function reset()
+    protected function doReset()
     {
-        $this->colors = $this->lengths = [];
+        $this->colors = [];
     }
 
     protected function visit(\DOMNode $el)
     {
-        $lineNo = $el->getLineNo() - 2;
         $type   = $el instanceof \DOMElement ? $el->getAttribute('data-type') : 'raw';
         $color  = $this->colorCode($type);
+        $ncolor = $this->colorCode('lineno');
         $text   = \str_replace(['&nbsp;', '&lt;', '&gt;'], [' ', '<', '>'], $el->textContent);
 
         foreach (\explode("\n", $text) as $line) {
-            $lineNo++;
+            $xlen = $this->lengths[$this->lineNo] ?? 0;
+            $ypos = 12 + $this->imgSize['y1'] * $this->lineNo;
+
+            if ('' !== $lineNo = $this->formatLineNo()) {
+                $xlen += $this->estimateSize($lineNo)['x'];
+                \imagefttext($this->image, $this->size, 0, 12, $ypos, $ncolor, $this->font, $lineNo);
+            }
 
-            $xlen = $this->lengths[$lineNo] ?? 0;
-            $xpos = 12 + $xlen;
-            $ypos = 12 + $this->imgSize['y1'] * $lineNo;
+            \imagefttext($this->image, $this->size, 0, 12 + $xlen, $ypos, $color, $this->font, $line);
 
-            \imagefttext($this->image, $this->size, 0, $xpos, $ypos, $color, $this->font, $line);
+            $this->lengths[$this->lineNo] = $xlen + $this->estimateSize($line)['x'];
 
-            $this->lengths[$lineNo] = $xlen + $this->estimateSize($line)['x'];
+            $this->lineNo++;
         }
     }
 
@@ -127,6 +133,7 @@ protected function colorCode(string $type): int
             'keyword' => [192, 0, 0],
             'string'  => [192, 192, 0],
             'raw'     => [128, 128, 128],
+            'lineno'  => [128, 224, 224],
         ];
 
         return $this->colors[$type] = \imagecolorallocate($this->image, ...$palette[$type]);

src/Exporter.php

@@ -23,30 +23,53 @@ public function __toString(): string
         return $this->highlight();
     }
 
-    public function highlight(string $code = null): string
+    public function highlight(string $code = null, array $options = []): string
     {
-        $this->parse($code);
+        $this->setOptions($options);
+
+        $this->parse($code ?? $this->code);
 
         return \trim($this->out, "\n") . "\n";
     }
 
-    protected function reset()
+    protected function doReset()
     {
         $this->out = '';
     }
 
     protected function visit(\DOMNode $el)
+    {
+        $type = $el instanceof \DOMElement ? $el->getAttribute('data-type') : 'raw';
+        $text = \str_replace(['&nbsp;', '&lt;', '&gt;'], [' ', '<', '>'], $el->textContent);
+
+        $lastLine = 0;
+        $lines    = \explode("\n", $text);
+        foreach ($lines as $i => $line) {
+            $this->out .= $this->formatLine($type, $line);
+
+            if (isset($lines[$i + 1])) {
+                $this->out .= "\n";
+            }
+
+            $this->lengths[$this->lineNo++] = \strlen($line);
+        }
+    }
+
+    protected function formatLine(string $type, string $line)
     {
         static $formats = [
             'comment' => "\033[0;34;40m%s\033[0m",
             'default' => "\033[0;32;40m%s\033[0m",
             'keyword' => "\033[0;31;40m%s\033[0m",
             'string'  => "\033[0;33;40m%s\033[0m",
+            'lineno'  => "\033[2;36;40m%s\033[0m",
+            'raw'     => '%s',
         ];
 
-        $type = $el instanceof \DOMElement ? $el->getAttribute('data-type') : 'raw';
-        $text = \str_replace(['&nbsp;', '&lt;', '&gt;'], [' ', '<', '>'], $el->textContent);
+        if ('' !== $lineNo = $this->formatLineNo()) {
+            $lineNo = \sprintf($formats['lineno'], $lineNo);
+        }
 
-        $this->out .= \sprintf($formats[$type] ?? '%s', $text);
+        return $lineNo . \sprintf($formats[$type], $line);
     }
 }

src/Highlighter.php

@@ -18,6 +18,18 @@ abstract class Pretty
     /** @var string The PHP code. */
     protected $code;
 
+    /** @var int The current line number. */
+    protected $lineNo = 0;
+
+    /** @var int The total lines count. */
+    protected $lineCount = 0;
+
+    /** @var bool Show line numbers. */
+    protected $withLineNo = false;
+
+    /** @var array Lengths of each line */
+    protected $lengths = [];
+
     /** @var bool Indicates if it has been already configured. */
     protected static $configured;
 
@@ -48,28 +60,56 @@ public static function configure()
         static::$configured = true;
     }
 
+    protected function setOptions(array $options)
+    {
+        if ($options['lineNo'] ?? false) {
+            $this->withLineNo = true;
+        }
+    }
+
     protected function parse(string $code = null)
     {
         $this->reset();
 
         $dom = new \DOMDocument;
-        $dom->loadHTML($this->codeToHtml($code));
+        $dom->loadHTML($this->codeToHtml($code ?? $this->code));
 
-        foreach ((new \DOMXPath($dom))->query('/html/body/span')[0]->childNodes as $el) {
+        $adjust = -1;
+        foreach ((new \DOMXPath($dom))->query('/html/body/code/span/*') as $el) {
+            $this->lineNo = $el->getLineNo() + $adjust;
             $this->visit($el);
         }
     }
 
-    protected function codeToHtml(string $code = null): string
+    protected function codeToHtml(string $code): string
     {
         static::configure();
 
-        $html = \highlight_string($code ?? $this->code, true);
+        $this->lineCount = \substr_count($code, "\n") ?: 1;
+
+        $html = \highlight_string($code, true);
+
+        return \str_replace(['<br />'], ["\n"], $html);
+    }
+
+    protected function formatLineNo(): string
+    {
+        if ($this->withLineNo && $this->lineNo <= $this->lineCount && !isset($this->lengths[$this->lineNo])) {
+            return \str_pad("$this->lineNo", \strlen("$this->lineCount"), ' ', \STR_PAD_LEFT) . '. ';
+        }
+
+        return '';
+    }
+
+    protected function reset()
+    {
+        $this->doReset();
 
-        return \str_replace(['<br />', '<code>', '</code>'], ["\n", '', ''], $html);
+        $this->lengths = [];
+        $this->lineNo  = $this->lineCount = 0;
     }
 
-    abstract protected function reset();
+    abstract protected function doReset();
 
     abstract protected function visit(\DOMNode $el);
 }

src/Pretty.php

@@ -53,7 +53,10 @@ public function testSetOptions()
 
     public function testSetOptionsFont()
     {
-        Exporter::for(__DIR__ . '/../example.php')->export($this->out, ['font' => __DIR__ . '/../font/dejavu.ttf']);
+        Exporter::for(__DIR__ . '/../example.php')->export(
+            $this->out,
+            ['font' => __DIR__ . '/../font/dejavu.ttf', 'lineNo' => true]
+        );
 
         $this->assertFileExists($this->out, 'It should export with given font');
         // $this->assertSame(\file_get_contents($this->ref), \file_get_contents($this->out));

tests/ExporterTest.php

@@ -26,6 +26,16 @@ public function testHighlightCode()
         );
     }
 
+    public function testHighlightCodeWithLineNo()
+    {
+        $code = (new Highlighter)->highlight('<?php echo "Hello world!";', ['lineNo' => true]);
+
+        $this->assertContains(
+            '1. <?php echo "Hello world!";',
+            $code
+        );
+    }
+
     public function testHighlightFile()
     {
         $code = (string) Highlighter::for(__DIR__ . '/../example.php');