Remove-EscapedMarkdownCode: Fix escaping issues (#141)

Author: johlju

CHANGELOG.md

@@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- `Remove-EscapedMarkdownCode`
+  - Add additional escape sequences to remove ([issue #140](https://github.com/dsccommunity/DscResource.DocGenerator/issues/140)).
+
 ## [0.12.0] - 2024-01-21
 
 ### Removed

source/Private/Remove-EscapedMarkdownCode.ps1

@@ -40,18 +40,40 @@ function Remove-EscapedMarkdownCode
 
         $escapedPatterns = @(
             @{
-                RegularExpression = '\\\`(.+?)\\\`' # Remove escaped inline code-blocks
+                # Remove escaped inline code-blocks, ingores escaped code-blocks.
+                RegularExpression = '\\\`(?!\\\`)(?!\`)(.+?)\\\`'
                 Replacement = '`$1`'
             }
             @{
-                RegularExpression = '\\\[(.+?)\\\]' # Remove escaped links
+                # Remove escaped links.
+                RegularExpression = '\\\[(.+?)\\\]'
                 Replacement = '[$1]'
             }
-
             @{
-                RegularExpression = '(?m)^\\\>' # Remove quoted blocks
+                 # Remove quoted blocks, if they start on each line.
+                RegularExpression = '(?m)^\\\>'
+                Replacement = '>'
+            }
+            @{
+                # Remove escaped code blocks.
+                RegularExpression = '\\\`\\\`\\\`'
+                Replacement = '```'
+            }
+            @{
+                # Remove escaped less than character.
+                RegularExpression = '\\\<'
+                Replacement = '<'
+            }
+            @{
+                # Remove escaped greater than character.
+                RegularExpression = '\\\>'
                 Replacement = '>'
             }
+            @{
+                # Remove escaped path separator.
+                RegularExpression = '\\\\'
+                Replacement = '\'
+            }
         )
 
         foreach ($pattern in $escapedPatterns)

tests/unit/private/Remove-EscapedMarkdownCode.Tests.ps1

@@ -34,12 +34,18 @@ This is \`inline code 2\`
 
 Removes escaped links: \[MyLinkName\]
 
-Do not start at the beginning of the line: \> This quote block should be kept
+Greater than sign \>
+Less than sign \<
 
 Removes quoted blocks:
 \> This block should be changed
 \> This block should be changed
 \> This block should be changed
+
+\`\`\`code block 1\`\`\`e
+\`\`\`code block 2\`\`\`
+
+C:\\Path\\To\\File.ps1
 "@
 
             Set-Content -Path $testFilePath -Value $contentWithParameter
@@ -62,13 +68,45 @@ Removes quoted blocks:
             $content | Should -Not -Match '\\\[MyLinkName\\\]'
         }
 
-        It 'Should remove quoted blocks from the markdown file' {
+        It 'Should remove escaped quoted blocks from the markdown file' {
             Remove-EscapedMarkdownCode -FilePath $testFilePath
 
             $content = Get-Content -Path $testFilePath -Raw
 
             $content | Should -Not -Match '\\\> This block should be changed'
-            $content | Should -Match '\\\> This quote block should be kept' -Because 'the quote block does not start at the beginning of the line'
+        }
+
+        It 'Should remove escaped greater than character from the markdown file' {
+            Remove-EscapedMarkdownCode -FilePath $testFilePath
+
+            $content = Get-Content -Path $testFilePath -Raw
+
+            $content | Should -Not -Match '\\>'
+        }
+
+        It 'Should remove escaped less than character from the markdown file' {
+            Remove-EscapedMarkdownCode -FilePath $testFilePath
+
+            $content = Get-Content -Path $testFilePath -Raw
+
+            $content | Should -Not -Match '\\<'
+        }
+
+        It 'Should remove escaped code blocks from the markdown file' {
+            Remove-EscapedMarkdownCode -FilePath $testFilePath
+
+            $content = Get-Content -Path $testFilePath -Raw
+
+            $content | Should -Not -Match '\\\`\\\`\\\`'
+            $content | Should -Not -Match '\`\`\`'
+        }
+
+        It 'Should remove escaped path separator from the markdown file' {
+            Remove-EscapedMarkdownCode -FilePath $testFilePath
+
+            $content = Get-Content -Path $testFilePath -Raw
+
+            $content | Should -Match 'C:\\Path\\To\\File.ps1'
         }
     }
 }