Merge pull request #3 from Moxio/tilde

aboks · web-flow · commit 4f3f609ec402 · 2021-01-19T16:22:29.000+01:00
Add support for tilde as a definition marker
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ Since there are subtle differences between the syntaxes understood by these
 libraries and there is no formally defined standard, 100% compatibility
 with any of the aforementioned libraries cannot be guaranteed. The use
 of the tilde (`~`) as a definition list marker (as understood by Pandoc)
-is not supported yet.
+is also supported.
 
 A simple example:
 ```markdown
diff --git a/src/DefinitionListParser.php b/src/DefinitionListParser.php
@@ -15,7 +15,7 @@ public function parse(ContextInterface $context, Cursor $cursor): bool
             return false;
         }
 
-        if ($cursor->getNextNonSpacePosition() > 2 || $cursor->getNextNonSpaceCharacter() !== ":") {
+        if ($cursor->getNextNonSpacePosition() > 2 || !in_array($cursor->getNextNonSpaceCharacter(), [":", "~"], true)) {
             return false;
         }
 
diff --git a/test/IntegrationTest.php b/test/IntegrationTest.php
@@ -436,6 +436,30 @@ public function testSupportsOtherBlockAfterDefinitionList(): void
         $this->assertMarkdownIsConvertedTo($expectedHtml, $markdown);
     }
 
+    // Example from https://pandoc.org/MANUAL.html#definition-lists
+    public function testSupportsTildeAsListMarker(): void
+    {
+        $markdown = <<<MD
+Term 1
+  ~ Definition 1
+
+Term 2
+  ~ Definition 2a
+  ~ Definition 2b
+MD;
+        $expectedHtml = <<<HTML
+<dl>
+  <dt>Term 1</dt>
+  <dd>Definition 1</dd>
+  <dt>Term 2</dt>
+  <dd>Definition 2a</dd>
+  <dd>Definition 2b</dd>
+</dl>
+HTML;
+
+        $this->assertMarkdownIsConvertedTo($expectedHtml, $markdown);
+    }
+
     public function assertMarkdownIsConvertedTo($expectedHtml, $markdown): void
     {
         $environment = Environment::createCommonMarkEnvironment();

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public function parse(ContextInterface $context, Cursor $cursor): bool`
`15`	`15`	`return false;`
`16`	`16`	`}`
`17`	`17`
`18`		`- if ($cursor->getNextNonSpacePosition() > 2 \|\| $cursor->getNextNonSpaceCharacter() !== ":") {`
	`18`	`+ if ($cursor->getNextNonSpacePosition() > 2 \|\| !in_array($cursor->getNextNonSpaceCharacter(), [":", "~"], true)) {`
`19`	`19`	`return false;`
`20`	`20`	`}`
`21`	`21`