[9.x] feature: Str::inlineMarkdown() (#43126)

* feature: Inline markdown helpers

* chore: fix styleci

* Update Str.php

Co-authored-by: Taylor Otwell <[email protected]>

src/Illuminate/Support/Str.php

@@ -5,7 +5,11 @@
 use Closure;
 use Illuminate\Support\Traits\Macroable;
 use JsonException;
+use League\CommonMark\Environment\Environment;
+use League\CommonMark\Extension\GithubFlavoredMarkdownExtension;
+use League\CommonMark\Extension\InlinesOnly\InlinesOnlyExtension;
 use League\CommonMark\GithubFlavoredMarkdownConverter;
+use League\CommonMark\MarkdownConverter;
 use Ramsey\Uuid\Codec\TimestampFirstCombCodec;
 use Ramsey\Uuid\Generator\CombGenerator;
 use Ramsey\Uuid\Uuid;
@@ -503,6 +507,25 @@ public static function markdown($string, array $options = [])
         return (string) $converter->convert($string);
     }
 
+    /**
+     * Converts inline Markdown into HTML.
+     *
+     * @param  string  $string
+     * @param  array  $options
+     * @return string
+     */
+    public static function inlineMarkdown($string, array $options = [])
+    {
+        $environment = new Environment($options);
+
+        $environment->addExtension(new GithubFlavoredMarkdownExtension());
+        $environment->addExtension(new InlinesOnlyExtension());
+
+        $converter = new MarkdownConverter($environment);
+
+        return (string) $converter->convert($string);
+    }
+
     /**
      * Masks a portion of a string with a repeated character.
      *

src/Illuminate/Support/Stringable.php

@@ -391,6 +391,17 @@ public function markdown(array $options = [])
         return new static(Str::markdown($this->value, $options));
     }
 
+    /**
+     * Convert inline Markdown into HTML.
+     *
+     * @param  array  $options
+     * @return static
+     */
+    public function inlineMarkdown(array $options = [])
+    {
+        return new static(Str::inlineMarkdown($this->value, $options));
+    }
+
     /**
      * Masks a portion of a string with a repeated character.
      *

tests/Support/SupportStrTest.php

@@ -898,6 +898,12 @@ public function testMarkdown()
         $this->assertSame("<h1>hello world</h1>\n", Str::markdown('# hello world'));
     }
 
+    public function testInlineMarkdown()
+    {
+        $this->assertSame("<em>hello world</em>\n", Str::inlineMarkdown('*hello world*'));
+        $this->assertSame("<a href=\"https://laravel.com\"><strong>Laravel</strong></a>\n", Str::inlineMarkdown('[**Laravel**](https://laravel.com)'));
+    }
+
     public function testRepeat()
     {
         $this->assertSame('aaaaa', Str::repeat('a', 5));

tests/Support/SupportStringableTest.php

@@ -959,6 +959,12 @@ public function testMarkdown()
         $this->assertEquals("<h1>hello world</h1>\n", $this->stringable('# hello world')->markdown());
     }
 
+    public function testInlineMarkdown()
+    {
+        $this->assertEquals("<em>hello world</em>\n", $this->stringable('*hello world*')->inlineMarkdown());
+        $this->assertEquals("<a href=\"https://laravel.com\"><strong>Laravel</strong></a>\n", $this->stringable('[**Laravel**](https://laravel.com)')->inlineMarkdown());
+    }
+
     public function testMask()
     {
         $this->assertSame('tay*************', (string) $this->stringable('[email protected]')->mask('*', 3));