From e068f060a4dc4a8b36cf841c2b5dcf09bd976ea3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20=22DualFroz=22=20Fox?= Definition\nwith lazy continuation. Second paragraph of the definition. Term 1
- // : Invalid with less than 3 characters Term 1\n: Invalid with less than 3 characters Term 1
+ // :Invalid without a space after the colon Term 1\n:Invalid without a space after the colon Term 1 Term 1 First Second First Second` / `
- TestParser.TestSpec("Term 1\n : Valid even if `:` starts at most 3 spaces", "\n
", "definitionlists+attributes|advanced", context: "Example 2\nSection Extensions / Definition lists\n");
}
- // The definition must be indented to 4 characters including the `:`.
+ // The `:` or `~` must be followed by at least one space or tab. A single space is enough:
[Test]
public void ExtensionsDefinitionLists_Example003()
{
@@ -109,17 +109,26 @@ namespace Markdig.Tests.Specs.DefinitionLists
// Section: Extensions / Definition lists
//
// The following Markdown:
- // Term 1
- // : Invalid with less than 3 characters
+ // First Term
+ // : This is the definition of the first term.
+ //
+ // Second Term
+ // : This is one definition of the second term.
+ // ~ This is another definition of the second term.
//
// Should be rendered as:
- //
+ //
- TestParser.TestSpec("Term 1\n: Invalid with less than 3 characters", "\n
", "definitionlists+attributes|advanced", context: "Example 3\nSection Extensions / Definition lists\n");
}
- // The `:` can be indented up to 3 spaces:
+ // Without a space or tab after the `:`, the line is not a definition:
[Test]
public void ExtensionsDefinitionLists_Example004()
{
@@ -128,6 +137,24 @@ namespace Markdig.Tests.Specs.DefinitionLists
//
// The following Markdown:
// Term 1
+ // :Invalid without a space after the colon
+ //
+ // Should be rendered as:
+ // : starts at most 3 spaces\n
", "definitionlists+attributes|advanced", context: "Example 4\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("Term 1\n : Valid even if `:` starts at most 3 spaces", ": starts at most 3 spaces\n
", "definitionlists+attributes|advanced", context: "Example 5\nSection Extensions / Definition lists\n");
}
// But more than 3 spaces before `:` will trigger an indented code block:
[Test]
- public void ExtensionsDefinitionLists_Example005()
+ public void ExtensionsDefinitionLists_Example006()
{
- // Example 5
+ // Example 6
// Section: Extensions / Definition lists
//
// The following Markdown:
@@ -156,14 +183,14 @@ namespace Markdig.Tests.Specs.DefinitionLists
// : starts at most 3 spaces
- TestParser.TestSpec("Term 1\n\n : Not valid", ": Not valid
//
", "definitionlists+attributes|advanced", context: "Example 5\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("Term 1\n\n : Not valid", ": Not valid\n
", "definitionlists+attributes|advanced", context: "Example 6\nSection Extensions / Definition lists\n");
}
// Definition lists can be nested inside list items
[Test]
- public void ExtensionsDefinitionLists_Example006()
+ public void ExtensionsDefinitionLists_Example007()
{
- // Example 6
+ // Example 7
// Section: Extensions / Definition lists
//
// The following Markdown:
@@ -189,14 +216,14 @@ namespace Markdig.Tests.Specs.DefinitionLists
//
//
- TestParser.TestSpec("1. First\n \n2. Second\n \n Term 1\n : Definition\n \n Term 2\n : Second Definition", ": Not valid\n\n
", "definitionlists+attributes|advanced", context: "Example 6\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("1. First\n \n2. Second\n \n Term 1\n : Definition\n \n Term 2\n : Second Definition", "\n
\n
", "definitionlists+attributes|advanced", context: "Example 7\nSection Extensions / Definition lists\n");
}
// An invalid continuation must preserve its leading marker when it starts the next term:
[Test]
- public void ExtensionsDefinitionLists_Example007()
+ public void ExtensionsDefinitionLists_Example008()
{
- // Example 7
+ // Example 8
// Section: Extensions / Definition lists
//
// The following Markdown:
@@ -214,14 +241,14 @@ namespace Markdig.Tests.Specs.DefinitionLists
// \n
\n
", "definitionlists+attributes|advanced", context: "Example 7\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("Term\n: First definition\n\n:foo: Foo\n: Second definition", "\n
", "definitionlists+attributes|advanced", context: "Example 8\nSection Extensions / Definition lists\n");
}
// The same applies to the tilde marker:
[Test]
- public void ExtensionsDefinitionLists_Example008()
+ public void ExtensionsDefinitionLists_Example009()
{
- // Example 8
+ // Example 9
// Section: Extensions / Definition lists
//
// The following Markdown:
@@ -239,14 +266,14 @@ namespace Markdig.Tests.Specs.DefinitionLists
// \n
", "definitionlists+attributes|advanced", context: "Example 8\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("Term\n: First definition\n\n~foo Foo\n: Second definition", "\n
", "definitionlists+attributes|advanced", context: "Example 9\nSection Extensions / Definition lists\n");
}
// Without a blank line, the next line remains part of the current definition but keeps its marker:
[Test]
- public void ExtensionsDefinitionLists_Example009()
+ public void ExtensionsDefinitionLists_Example010()
{
- // Example 9
+ // Example 10
// Section: Extensions / Definition lists
//
// The following Markdown:
@@ -261,7 +288,7 @@ namespace Markdig.Tests.Specs.DefinitionLists
// :foo: Foo
//
- TestParser.TestSpec("Term\n: First definition\n:foo: Foo", "\n
", "definitionlists+attributes|advanced", context: "Example 9\nSection Extensions / Definition lists\n");
+ TestParser.TestSpec("Term\n: First definition\n:foo: Foo", "\n
", "definitionlists+attributes|advanced", context: "Example 10\nSection Extensions / Definition lists\n");
}
}
}
diff --git a/src/Markdig.Tests/Specs/DefinitionListSpecs.md b/src/Markdig.Tests/Specs/DefinitionListSpecs.md
index 6cd3dfa0..836236f7 100644
--- a/src/Markdig.Tests/Specs/DefinitionListSpecs.md
+++ b/src/Markdig.Tests/Specs/DefinitionListSpecs.md
@@ -72,14 +72,33 @@ with lazy continuation.
Term 1 -: Invalid with less than 3 characters
+:Invalid without a space after the colon ```````````````````````````````` The `:` can be indented up to 3 spaces: diff --git a/src/Markdig.Tests/TestDefinitionLists.cs b/src/Markdig.Tests/TestDefinitionLists.cs index 5b62c8df..306e939c 100644 --- a/src/Markdig.Tests/TestDefinitionLists.cs +++ b/src/Markdig.Tests/TestDefinitionLists.cs @@ -7,8 +7,10 @@ public class TestDefinitionLists { [TestCase(":foo: Foo", 1)] [TestCase(":foo: Foo", 2)] + [TestCase(":foo: Foo", 3)] [TestCase("~foo Foo", 1)] [TestCase("~foo Foo", 2)] + [TestCase("~foo Foo", 3)] public void IndentedInvalidContinuationPreservesTerm(string term, int indent) { var markdown = $"Term\n: First definition\n\n{new string(' ', indent)}{term}\n: Second definition"; @@ -21,7 +23,7 @@ public class TestDefinitionLists public void InvalidDefinitionMarkerPreservesSourceLocation( [Values("Term\n", "Term\n: First definition\n")] string prefix, [Values(":foo: Foo", "~foo Foo")] string marker, - [Values(1, 2)] int indent) + [Values(1, 2, 3)] int indent) { var markdown = $"{prefix}{new string(' ', indent)}{marker}"; var pipeline = new MarkdownPipelineBuilder().UseDefinitionLists().UsePreciseSourceLocation().Build(); @@ -32,4 +34,15 @@ public class TestDefinitionLists Assert.AreEqual(prefix.Length + indent, literal.Span.Start); Assert.AreEqual(markdown.Length - 1, literal.Span.End); } + + [Test] + public void DefinitionMarkersAcceptSpacesOrTabs( + [Values(':', '~')] char marker, + [Values(" ", " ", "\t")] string whitespace) + { + var markdown = $"Term\n{marker}{whitespace}First definition\n{marker}{whitespace}Second definition"; + const string expected = "