Merge pull request #1 from adhocore/develop

Develop

Author: adhocore

.gitignore

@@ -6,3 +6,5 @@
 composer.lock
 coverage.xml
 clover.xml
+test.php
+*.ttf.png

README.md

@@ -9,11 +9,33 @@
 
 
 ## Installation
+
+### As standalone binary
+
+```sh
+composer global require adhocore/cli-syntax
+
+# then you will be able to run it as
+clish -h
+clish -f file.php
+echo '<?php date("Ymd");' | clish
+cat file.php | clish
+
+# export png
+clish -f file.php -o file.png
+```
+
+### As project dependency
 ```bash
 composer require adhocore/cli-syntax
 ```
 
 ## Usage
+
+You can either highlight PHP code in terminal output or export to png image.
+
+### Highlight
+
 ```php
 use Ahc\CliSyntax\Highlighter;
 
@@ -26,9 +48,25 @@ echo (new Highlighter)->highlight('<?php echo "Hello world!";');
 echo Highlighter::for('/path/to/file.php');
 ```
 
-See [example](./example.php). Here's the screenshot too:
+### Export
+
+```php
+use Ahc\CliSyntax\Exporter;
+
+// PHP file
+Exporter::for('/path/to/file.php')->export('file.png');
+```
+
+See [example usage](./example.php). Here's how the export looks like:
+
+![adhocore/cli-syntax](./example.png)
+
+
+### Customisation
 
-![adhocore/cli-syntax](https://imgur.com/wcNp3qJ.png)
+If you would like to change color etc, extend the classes
+[`Highlighter`](./src/Highlighter.php) and [`Exporter`](./src/Exporter.php),
+then override `visit()` method which recieves [`DOMNode`](https://php.net/DOMNode).
 
 ## Contributing
 

bin/clish

@@ -0,0 +1,45 @@
+#!/usr/bin/env php
+<?php
+
+if (\PHP_VERSION_ID < 70000) {
+    echo "clish requires PHP7.0 or newer\n";
+
+    exit(1);
+}
+
+if (\Phar::running() && !\extension_loaded('zlib')) {
+    echo "clish.phar requires 'zlib' extension\n(OR you can compile phar with `compression: NONE` in box.json)\n";
+
+    exit(1);
+}
+
+if (\file_exists(__DIR__ . '/../../../autoload.php')) {
+    require __DIR__ . '/../../../autoload.php';
+} elseif (\file_exists(__DIR__ . '/../../autoload.php')) {
+    require __DIR__ . '/../../autoload.php';
+} else {
+    require __DIR__ . '/../vendor/autoload.php';
+}
+
+\chdir(\getcwd());
+
+$logo = "
+        _   _          _
+  ___  | | (_)  ___   | |__
+ / __| | | | | / __|  '  _  \
+| (__  | | | | \___ \ | | | |
+ \___| |_| |_| |____/ |_| |_|
+
+PHP CLI Syntax Highlight Tool
+=============================
+";
+
+$app = new Ahc\Cli\Application(
+    'Clish',
+    \trim(\file_get_contents(__DIR__ . '/../VERSION'))
+);
+
+// Add commands and their aliases
+$app->add(new Ahc\CliSyntax\Console\ClishCommand, 'c', true);
+
+$app->logo($logo)->handle($_SERVER['argv'] + ['', 'clish']);

composer.json

@@ -2,7 +2,8 @@
     "name": "adhocore/cli-syntax",
     "description": "PHP Code Syntax Highlighter for CLI",
     "type": "library",
-    "keywords": ["php", "cli-syntax", "php-cli-highlight", "cli-syntax-highlight", "syntax-highlight"],
+    "keywords": ["php", "cli-syntax", "php-cli-highlight", "cli-syntax-highlight", "syntax-highlight",
+        "export-php-code", "code-to-image", "code-screenshot"],
     "license": "MIT",
     "authors": [
         {
@@ -24,7 +25,9 @@
     },
     "require": {
         "php": ">=7.0.0",
-        "ext-dom": "*"
+        "ext-dom": "*",
+        "ext-gd": "*",
+        "adhocore/cli": "^0.6.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.5 || ^7.5"
@@ -35,10 +38,9 @@
             "*": "dist"
         }
     },
+    "bin": ["bin/clish"],
     "scripts": {
-        "post-root-package-install": [
-        ],
         "test": "vendor/bin/phpunit",
-        "test:cov": "vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml"
+        "test:cov": "vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml --coverage-html vendor/cov"
     }
 }

example.php

@@ -9,16 +9,23 @@
  * Licensed under MIT license.
  */
 
+use Ahc\CliSyntax\Exporter;
 use Ahc\CliSyntax\Highlighter;
 
+require_once __DIR__ . '/src/Pretty.php';
+require_once __DIR__ . '/src/Exporter.php';
 require_once __DIR__ . '/src/Highlighter.php';
 
 // Highlight code
-echo (new Highlighter("<?php echo 'Hello world!'; ?>\n"))->highlight();
+echo (new Highlighter("<?php echo 'Hello world!'; ?>" . PHP_EOL))
+    ->highlight();
 
 // Highlight file
 echo Highlighter::for(__FILE__)->highlight();
 
+// Export highlighted file as image
+Exporter::for(__FILE__)->export(__DIR__ . '/example.png');
+
 // Magic string works too:
-// echo new Highlighter('<?php echo "Hello world!";');
+echo new Highlighter('<?php echo "Hello Again!";' . PHP_EOL);
 // echo Highlighter::for(__FILE__);

example.png

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the CLI-SYNTAX package.
+ *
+ * (c) Jitendra Adhikari <jiten.adhikary@gmail.com>
+ *     <https://github.com/adhocore>
+ *
+ * Licensed under MIT license.
+ */
+
+namespace Ahc\CliSyntax\Console;
+
+use Ahc\Cli\Input\Command;
+use Ahc\Cli\IO\Interactor;
+use Ahc\CliSyntax\Exporter;
+use Ahc\CliSyntax\Highlighter;
+
+class ClishCommand extends Command
+{
+    public function __construct()
+    {
+        parent::__construct('clish', 'PHP CLI syntax highlight and/or export.');
+
+        $this
+            ->option('-o --output', 'Output filepath where PNG image is exported')
+            ->option('-e --echo', 'Forces echo to STDOUT when --output is passed')
+            ->option('-f --file', \implode("\n", [
+                'Input PHP file to highlight and/or export',
+                '(will read from piped input if file not given)',
+            ]))
+            ->option('-F --font', 'Font to use for export to png')
+            ->usage(
+                '<bold>  $0</end> <comment>--file file.php</end> ## print<eol/>'
+                . '<bold>  cat file.php | $0</end> ## from piped stream<eol/>'
+                . '<bold>  $0</end> <comment>< file.php ## 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>-f file.php -o file.png -F dejavu</end> ## export in dejavu font<eol/>'
+            );
+    }
+
+    public function interact(Interactor $io)
+    {
+        if ($this->file) {
+            return;
+        }
+
+        $code = $io->readPiped(function ($reader) use ($io) {
+            $io->warn('Type in or paste PHP Code below, Press Ctrl+D when done.', true);
+            $io->warn('(Opening tag `<?php` will be prepended as required):', true);
+
+            return $reader->readAll();
+        });
+
+        if ('' !== $code && \substr($code, 0, 5) != '<?php') {
+            $eol  = \substr_count(\rtrim($code), "\n") ? "\n\n" : '';
+            $code = '<?php ' . $eol . $code;
+        }
+
+        $this->set('code', $code);
+    }
+
+    public function execute()
+    {
+        $code = $this->file ? \file_get_contents($this->file) : $this->code;
+
+        if ('' === \trim($code)) {
+            return;
+        }
+
+        $this->doExport($code);
+        $this->doHighlight($code);
+    }
+
+    protected function doHighlight(string $code = null)
+    {
+        if (!$this->output || $this->echo) {
+            $this->app()->io()->raw((string) new Highlighter($code));
+        }
+    }
+
+    protected function doExport(string $code = null)
+    {
+        if (!$this->output) {
+            return;
+        }
+
+        if (!\is_dir(\dirname($this->output))) {
+            \mkdir(\dirname($this->output), 0755, true);
+        }
+
+        (new Exporter($code))->export($this->output, \array_filter(['font' => $this->font]));
+    }
+}