Merge pull request #41 from javiereguiluz/improve_highlighter

Changed a bit the way PHP code is highlighted

Author: nikophil

src/Renderers/CodeNodeRenderer.php

@@ -74,6 +74,9 @@ public function render(): string
         if ('text' !== $language) {
             $highLighter = new Highlighter();
             $code = $highLighter->highlight(self::LANGUAGES_MAPPING[$language] ?? $language, $code)->value;
+
+            // this allows to highlight the $ in PHP variable names
+            $code = str_replace('<span class="hljs-variable">$', '<span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>', $code);
         }
 
         return $this->templateRenderer->render(

tests/fixtures/expected/blocks/code-blocks/php-annotations.html

@@ -27,7 +27,7 @@
 </span>
                                     {
                                     <span class="hljs-comment">/** * <span class="hljs-doctag">@Assert</span>\Iban( * message="This is not a valid International Bank Account Number (IBAN)." * ) */</span>
-                                    <span class="hljs-keyword">protected</span> <span class="hljs-variable">$bankAccountNumber</span>;
+                                    <span class="hljs-keyword">protected</span> <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>bankAccountNumber</span>;
 }
                                 </pre>
                     </div>

tests/fixtures/expected/blocks/code-blocks/php.html

@@ -26,9 +26,9 @@
 <span class="hljs-keyword">namespace</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Routing</span>\<span class="hljs-title">Loader</span>\<span class="hljs-title">Configurator</span>; <span class="hljs-keyword">return</span>
                                     <span class="hljs-function">
                                         <span class="hljs-keyword">function</span>
-                                        <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable">$routes</span>)</span>
+                                        <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>routes</span>)</span>
                                     </span>
-                                    { <span class="hljs-variable">$routes</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
+                                    { <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>routes</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
 };</pre>
                     </div>
                 </td>

tests/fixtures/expected/blocks/nodes/literal.html

@@ -25,8 +25,11 @@
                         <pre class="hljs php">
                                     <span class="hljs-comment">// config/routes.php</span>
 <span class="hljs-keyword">namespace</span> <span class="hljs-title">Symfony</span>\<span class="hljs-title">Component</span>\<span class="hljs-title">Routing</span>\<span class="hljs-title">Loader</span>\<span class="hljs-title">Configurator</span>; <span class="hljs-keyword">return</span>
-                                    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable">$routes</span>)</span> </span>
-                                    { <span class="hljs-variable">$routes</span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
+                                    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(RoutingConfigurator <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>routes</span>)</span> </span>
+                                    {                                    <span class="hljs-variable">
+                                        <span class="hljs-variable-other-marker">$</span>
+                                        routes
+                                    </span><span class="hljs-operator">-&gt;</span>add(<span class="hljs-string">'about_us'</span>, [<span class="hljs-string">'nl'</span> =&gt; <span class="hljs-string">'/over-ons'</span>, <span class="hljs-string">'en'</span> =&gt; <span class="hljs-string">'/about-us'</span>]) <span class="hljs-operator">-&gt;</span>controller(<span class="hljs-string">'App\Controller\CompanyController::about'</span>);
 };</pre>
                     </div>
                 </td>

tests/fixtures/expected/main/datetime.html

@@ -140,7 +140,10 @@ <h3 id="placeholder">
                                                         \
                                                         <span class="hljs-title">DateTimeType</span>
                                                         ; 
-                                                        <span class="hljs-variable">$builder</span>
+                                                        <span class="hljs-variable">
+                                                            <span class="hljs-variable-other-marker">$</span>
+                                                            builder
+                                                        </span>
                                                         <span class="hljs-operator">-&gt;</span>
                                                         add(
                                                         <span class="hljs-string">'startDateTime'</span>
@@ -397,7 +400,10 @@ <h3 id="error-bubbling">
                                         <div class="highlight">
                                             <pre class="hljs php">
                                                                     <span class="hljs-comment">// app/config/config.php</span>
-                                                                    <span class="hljs-variable">$container</span>
+                                                                    <span class="hljs-variable">
+                                                                        <span class="hljs-variable-other-marker">$</span>
+                                                                        container
+                                                                    </span>
                                                                     <span class="hljs-operator">-&gt;</span>
                                                                     loadFromExtension(
                                                                     <span class="hljs-string">'framework'</span>