Skip to content

[2.x] Fix Markdown heading conversion #2590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emmadesilva wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open

[2.x] Fix Markdown heading conversion #2590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/framework/src/Framework/Actions/ConvertsMarkdownToPlainText.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*/
class ConvertsMarkdownToPlainText
{
protected const ATX_HEADERS = ['/^(\n)?\s{0,}#{1,6}\s+| {0,}(\n)?\s{0,}#{0,} {0,}(\n)?\s{0,}$/m' => '$1$2$3'];
protected const ATX_HEADERS = ['/^[ \t]*#{1,6}[ \t]+|[ \t]+#{1,6}[ \t]*$/m' => ''];
protected const SETEXT_HEADERS = ['/\n={2,}/' => "\n"];
protected const HORIZONTAL_RULES = ['/^(-\s*?|\*\s*?|_\s*?){3,}\s*/m' => ''];
protected const HTML_TAGS = ['/<[^>]*>/' => ''];
Expand Down
20 changes: 19 additions & 1 deletion packages/framework/tests/Feature/Actions/ConvertsMarkdownToPlainTextTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,24 @@ public function testItRemovesHeadings()
$this->assertSame($text, $this->convert($markdown));
}

public function testItRemovesHeadingsFromLongMarkdownDocuments()
{
$markdown = <<<'MD'
# Customizing Your Site

## Introduction

| Collection Type | Facade Method | Returned Object Type | File Extension |
|---------------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
MD;

$text = $this->convert($markdown);

$this->assertStringContainsString("Customizing Your Site\n\nIntroduction", $text);
$this->assertStringNotContainsString('# Customizing Your Site', $text);
$this->assertStringContainsString('Collection Type', $text);
}

public function testItRemovesHeadingsAlternateSyntax()
{
$markdown = <<<'MD'
Expand Down Expand Up @@ -509,7 +527,7 @@ public function testWithEmptyString()

public function testWithOnlyEmptyLines()
{
$this->assertSame("\n", $this->convert("\n\n\n"));
$this->assertSame("\n\n", $this->convert("\n\n\n"));
}

protected function convert(string $markdown): string
Expand Down
Loading