feat(md): make stripping markers configurable

Author: its-miroma

__tests__/e2e/markdown-extensions/markdown-extensions.test.ts

@@ -216,7 +216,7 @@ describe('Line Numbers', () => {
 describe('Import Code Snippets', () => {
   test('basic', async () => {
     const lines = page.locator('#basic-code-snippet + div code > span')
-    expect(await lines.count()).toBe(9)
+    expect(await lines.count()).toBe(11)
   })
 
   test('specify region', async () => {
@@ -269,7 +269,7 @@ describe('Code Groups', () => {
 
     // blocks
     const blocks = div.locator('.blocks > div')
-    expect(await blocks.nth(0).locator('code > span').count()).toBe(9)
+    expect(await blocks.nth(0).locator('code > span').count()).toBe(11)
     expect(await getClassList(blocks.nth(1))).toContain('line-numbers-mode')
     expect(await getClassList(blocks.nth(1))).toContain('language-ts')
     expect(await blocks.nth(1).locator('code > span').count()).toBe(3)

__tests__/unit/node/markdown/plugins/snippet.test.ts

@@ -2,7 +2,7 @@ import {
   dedent,
   findRegions,
   rawPathToToken,
-  stripRegionMarkers
+  stripMarkers
 } from 'node/markdown/plugins/snippet'
 import { expect } from 'vitest'
 
@@ -438,7 +438,18 @@ describe('node/markdown/plugins/snippet', () => {
         '// #endregion B',
         '// #endregion A'
       ]
-      expect(stripRegionMarkers(src)).toBe('console.log("Hello, World!");')
+      expect(stripMarkers(src, true)).toBe('console.log("Hello, World!");')
+    })
+
+    it('does not remove any marker if stripRegionMarkers is false', () => {
+      const src = [
+        '// #region A',
+        '// #region B',
+        'console.log("Hello, World!");',
+        '// #endregion B',
+        '// #endregion A'
+      ]
+      expect(stripMarkers(src, false)).toBe(src.join('\n'))
     })
 
     it('removes region markers for various syntaxes', () => {
@@ -456,7 +467,7 @@ describe('node/markdown/plugins/snippet', () => {
         'ECHO ON',
         'REM #endregion bat'
       ]
-      const out = stripRegionMarkers(src)
+      const out = stripMarkers(src, true)
       expect(out).not.toContain('#region')
       expect(out).not.toContain('#endregion')
       expect(out).toContain('<div>hi</div>')
@@ -473,7 +484,7 @@ describe('node/markdown/plugins/snippet', () => {
         '   // #endregion spaced',
         '/*    #endregion   */'
       ]
-      const out = stripRegionMarkers(src)
+      const out = stripMarkers(src, true)
       expect(out.trim()).toBe('code();')
     })
   })

src/node/markdown/markdown.ts

@@ -140,6 +140,11 @@ export interface MarkdownOptions extends MarkdownItAsyncOptions {
    * @default 'Copy Code'
    */
   codeCopyButtonTitle?: string
+  /**
+   * Remove all #region markers when including snippets
+   * @default false
+   */
+  stripMarkersFromSnippets?: boolean
 
   /* ==================== Markdown It Plugins ==================== */
 
@@ -274,7 +279,7 @@ export async function createMarkdownRenderer(
     codeCopyButtonTitle,
     languageLabel: options.languageLabel
   })
-  snippetPlugin(md, srcDir)
+  snippetPlugin(md, srcDir, options.stripMarkersFromSnippets)
   containerPlugin(md, options.container)
   imagePlugin(md, options.image)
   linkPlugin(

src/node/markdown/plugins/snippet.ts

@@ -126,7 +126,8 @@ export function findRegions(lines: string[], regionName: string) {
   return returned
 }
 
-export function stripRegionMarkers(lines: string[]): string {
+export function stripMarkers(lines: string[], stripMarkers: boolean): string {
+  if (!stripMarkers) return lines.join('\n')
   return lines
     .filter((l) => {
       for (const m of markers) {
@@ -137,7 +138,11 @@ export function stripRegionMarkers(lines: string[]): string {
     .join('\n')
 }
 
-export const snippetPlugin = (md: MarkdownItAsync, srcDir: string) => {
+export const snippetPlugin = (
+  md: MarkdownItAsync,
+  srcDir: string,
+  stripMarkersFromSnippets = false
+) => {
   const parser: RuleBlock = (state, startLine, endLine, silent) => {
     const CH = '<'.charCodeAt(0)
     const pos = state.bMarks[startLine] + state.tShift[startLine]
@@ -221,12 +226,13 @@ export const snippetPlugin = (md: MarkdownItAsync, srcDir: string) => {
 
       if (regions.length > 0) {
         content = dedent(
-          stripRegionMarkers(
+          stripMarkers(
             regions.flatMap((r) =>
               lines
                 .slice(r.start, r.end)
                 .filter((l) => !(r.re.start.test(l) || r.re.end.test(l)))
-            )
+            ),
+            stripMarkersFromSnippets
           )
         )
       } else {
@@ -235,7 +241,7 @@ export const snippetPlugin = (md: MarkdownItAsync, srcDir: string) => {
         return fence(...args)
       }
     } else {
-      content = stripRegionMarkers(content.split('\n'))
+      content = stripMarkers(content.split('\n'), stripMarkersFromSnippets)
     }
 
     token.content = content