Added a EscapeAtInMarkdown setting that can control @ escaping in…

… Markdown files on a file-by-file basis (#254)
statiqdev · May 19, 2023 · 6f114aa · 6f114aa
1 parent 040e69f
commit 6f114aa
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 3 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,7 +1,8 @@
 # 1.0.0-beta.67
 
 - Fixed a bug that still resulted in file cleaning even when `CleanMode.None` is set (I.e. `--noclean`).
-- `RenderMarkdown` no longer escapes `@` characters inside `mailto` links (#254). 
+- `RenderMarkdown` no longer escapes `@` characters inside `mailto` links (#254).
+- Added a `EscapeAtInMarkdown` setting that can control `@` escaping in Markdown files by the `RenderMarkdown` module on a file-by-file basis (#254).
 
 # 1.0.0-beta.66
 

diff --git a/src/extensions/Statiq.Markdown/MarkdownKeys.cs b/src/extensions/Statiq.Markdown/MarkdownKeys.cs
@@ -8,5 +8,12 @@ public static class MarkdownKeys
         /// <type cref="string" />
         /// <type cref="T:string[]" />
         public const string MarkdownExtensions = nameof(MarkdownExtensions);
+
+        /// <summary>
+        /// Controls whether the <c>@</c> character should be escaped. This takes precedence over the
+        /// <see cref="RenderMarkdown.EscapeAt"/> method of the module if defined.
+        /// </summary>
+        /// <type cref="bool" />
+        public const string EscapeAtInMarkdown = nameof(EscapeAtInMarkdown);
     }
 }
diff --git a/src/extensions/Statiq.Markdown/RenderMarkdown.cs b/src/extensions/Statiq.Markdown/RenderMarkdown.cs
@@ -276,7 +276,10 @@ protected override async Task<IEnumerable<IDocument>> ExecuteInputAsync(IDocumen
             }
 
             // Add the @ escaping extension if escaping @ symbols
-            if (_escapeAt)
+            bool escapeAt = input.ContainsKey(MarkdownKeys.EscapeAtInMarkdown)
+                ? input.GetBool(MarkdownKeys.EscapeAtInMarkdown)
+                : _escapeAt;
+            if (escapeAt)
             {
                 if (extensions == _extensions)
                 {
@@ -300,7 +303,7 @@ protected override async Task<IEnumerable<IDocument>> ExecuteInputAsync(IDocumen
                     writer,
                     _prependLinkRoot,
                     _passThroughRawFence,
-                    _escapeAt,
+                    escapeAt,
                     _configuration,
                     extensions);
                 if (markdownDocument is null)

diff --git a/tests/extensions/Statiq.Markdown.Tests/RenderMarkdownFixture.cs b/tests/extensions/Statiq.Markdown.Tests/RenderMarkdownFixture.cs
@@ -200,6 +200,46 @@ public async Task ShouldNotEscapeAtWhenFalse()
                 result.Content.ShouldBe(output, StringCompareShould.IgnoreLineEndings);
             }
 
+            [Test]
+            public async Task ShouldEscapeAtWhenOverriddenByMetadata()
+            {
+                // Given
+                const string input = "Looking @Good, @Man!";
+                const string output = @"<p>Looking &#64;Good, &#64;Man!</p>
+";
+                TestDocument document = new TestDocument(input)
+                {
+                    { MarkdownKeys.EscapeAtInMarkdown, true }
+                };
+                RenderMarkdown markdown = new RenderMarkdown().EscapeAt(false);
+
+                // When
+                TestDocument result = await ExecuteAsync(document, markdown).SingleAsync();
+
+                // Then
+                result.Content.ShouldBe(output, StringCompareShould.IgnoreLineEndings);
+            }
+
+            [Test]
+            public async Task ShouldNotEscapeAtWhenOverriddenByMetadata()
+            {
+                // Given
+                const string input = "Looking @Good, @Man!";
+                const string output = @"<p>Looking @Good, @Man!</p>
+";
+                TestDocument document = new TestDocument(input)
+                {
+                    { MarkdownKeys.EscapeAtInMarkdown, false }
+                };
+                RenderMarkdown markdown = new RenderMarkdown().EscapeAt();
+
+                // When
+                TestDocument result = await ExecuteAsync(document, markdown).SingleAsync();
+
+                // Then
+                result.Content.ShouldBe(output, StringCompareShould.IgnoreLineEndings);
+            }
+
             [Test]
             public async Task ShouldNotEscapeAtWhenEscapedBySlash()
             {