[5.x] Added the option to add renderers to markdown parsers

src/Markdown/Parser.php

@@ -15,6 +15,7 @@ class Parser
 
     protected $converter;
     protected $extensions = [];
+    protected $renderers = [];
     protected $config = [];
 
     public function __construct(array $config = [])
@@ -37,8 +38,12 @@ public function converter(): CommonMarkConverter
 
         $env = $converter->getEnvironment();
 
-        foreach ($this->extensions() as $ext) {
-            $env->addExtension($ext);
+        foreach ($this->extensions() as $extension) {
+            $env->addExtension($extension);
+        }
+
+        foreach ($this->renderers() as $renderer) {
+            $env->addRenderer(...$renderer);
         }
 
         return $this->converter = $converter;
@@ -65,15 +70,50 @@ public function addExtensions(Closure $closure): self
 
     public function extensions(): array
     {
-        $exts = [];
+        $extensions = [];
 
         foreach ($this->extensions as $closure) {
-            foreach (Arr::wrap($closure()) as $ext) {
-                $exts[] = $ext;
+            foreach (Arr::wrap($closure()) as $extension) {
+                $extensions[] = $extension;
+            }
+        }
+
+        return $extensions;
+    }
+
+    public function addRenderer(Closure $closure): self
+    {
+        $this->converter = null;
+
+        $this->renderers[] = $closure;
+
+        return $this;
+    }
+
+    public function addRenderers(Closure $closure): self
+    {
+        return $this->addRenderer($closure);
+    }
+
+    public function renderers(): array
+    {
+        $renderers = [];
+
+        foreach ($this->renderers as $closure) {
+            $closureRenderers = $closure();
+
+            // When the first item isn't an array, assume it's a single
+            // renderer and wrap it in an array.
+            if (! is_array($closureRenderers[0])) {
+                $closureRenderers = [$closureRenderers];
+            }
+
+            foreach ($closureRenderers as $renderer) {
+                $renderers[] = $renderer;
             }
         }
 
-        return $exts;
+        return $renderers;
     }
 
     public function withStatamicDefaults()
@@ -151,6 +191,10 @@ public function newInstance(array $config = [])
             $parser->addExtensions($ext);
         }
 
+        foreach ($this->renderers as $renderer) {
+            $parser->addRenderers($renderer);
+        }
+
         return $parser;
     }
 }

tests/Markdown/Fixtures/HeadingRenderer.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Tests\Markdown\Fixtures;
+
+use League\CommonMark\Extension\CommonMark\Node\Block\Heading;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+class HeadingRenderer implements NodeRendererInterface
+{
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer)
+    {
+        if (! ($node instanceof Heading)) {
+            throw new \InvalidArgumentException('Incompatible node type: '.get_class($node));
+        }
+
+        return "<h1 data-custom-renderer>{$childRenderer->renderNodes($node->children())}</h1>";
+    }
+}

tests/Markdown/Fixtures/LinkRenderer.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Tests\Markdown\Fixtures;
+
+use League\CommonMark\Extension\CommonMark\Node\Inline\Link as InlineLink;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+class LinkRenderer implements NodeRendererInterface
+{
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer)
+    {
+        if (! ($node instanceof InlineLink)) {
+            throw new \InvalidArgumentException('Incompatible node type: '.get_class($node));
+        }
+
+        return "<a data-custom-renderer href=\"{$node->getUrl()}\" title=\"{$node->getTitle()}\">{$childRenderer->renderNodes($node->children())}</a>";
+    }
+}

tests/Markdown/ParserTest.php

@@ -2,6 +2,8 @@
 
 namespace Tests\Markdown;
 
+use League\CommonMark\Extension\CommonMark\Node\Block\Heading;
+use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
 use PHPUnit\Framework\Attributes\Test;
 use Statamic\Markdown;
 use Tests\TestCase;
@@ -47,13 +49,52 @@ public function it_adds_extensions_using_an_array()
         $this->assertEquals("<p>smile 😀 frown 🙁</p>\n", $this->parser->parse('smile :) frown :('));
     }
 
+    #[Test]
+    public function it_adds_a_renderer()
+    {
+        $this->assertEquals("<p><a href=\"http://example.com\">test</a></p>\n", $this->parser->parse('[test](http://example.com)'));
+
+        $this->parser->addRenderer(function () {
+            return [
+                Link::class,
+                new Fixtures\LinkRenderer,
+            ];
+        });
+
+        $this->assertEquals("<p><a data-custom-renderer href=\"http://example.com\" title=\"\">test</a></p>\n", $this->parser->parse('[test](http://example.com)'));
+    }
+
+    #[Test]
+    public function it_adds_renderers_using_an_array()
+    {
+        $this->assertEquals("<p><a href=\"http://example.com\">test</a></p>\n", $this->parser->parse('[test](http://example.com)'));
+        $this->assertEquals("<h1>Hello world</h1>\n", $this->parser->parse('# Hello world'));
+
+        $this->parser->addRenderers(function () {
+            return [
+                [Link::class, new Fixtures\LinkRenderer],
+                [Heading::class, new Fixtures\HeadingRenderer],
+            ];
+        });
+
+        $this->assertEquals("<p><a data-custom-renderer href=\"http://example.com\" title=\"\">test</a></p>\n", $this->parser->parse('[test](http://example.com)'));
+        $this->assertEquals("<h1 data-custom-renderer>Hello world</h1>\n", $this->parser->parse('# Hello world'));
+    }
+
     #[Test]
     public function it_creates_a_new_instance_based_on_the_current_instance()
     {
         $this->parser->addExtension(function () {
             return new Fixtures\SmileyExtension;
         });
 
+        $this->parser->addRenderer(function () {
+            return [
+                Link::class,
+                new Fixtures\LinkRenderer,
+            ];
+        });
+
         $this->assertEquals("\n", $this->parser->config('renderer/block_separator'));
         $this->assertEquals("\n", $this->parser->config('renderer/inner_separator'));
         $this->assertEquals('allow', $this->parser->config('html_input'));
@@ -71,11 +112,20 @@ public function it_creates_a_new_instance_based_on_the_current_instance()
             return new Fixtures\FrownyExtension;
         });
 
+        $newParser->addRenderer(function () {
+            return [
+                Heading::class,
+                new Fixtures\HeadingRenderer,
+            ];
+        });
+
         $this->assertNotSame($this->parser, $newParser);
         $this->assertEquals("\n", $newParser->config('renderer/block_separator'));
         $this->assertEquals('foo', $newParser->config('renderer/inner_separator'));
         $this->assertEquals('strip', $newParser->config('html_input'));
         $this->assertCount(2, $newParser->extensions());
         $this->assertCount(1, $this->parser->extensions());
+        $this->assertCount(2, $newParser->renderers());
+        $this->assertCount(1, $this->parser->renderers());
     }
 }