@readme/markdown 11.7.0 → 11.7.1

package/dist/lib/utils/extractMagicBlocks.d.ts

@@ -0,0 +1,17 @@
+interface BlockHit {
+    raw: string;
+    token: string;
+}
+/**
+ * Extract legacy magic block syntax from a markdown string.
+ * Returns the modified markdown and an array of extracted blocks.
+ */
+export declare function extractMagicBlocks(markdown: string): {
+    replaced: string;
+    blocks: BlockHit[];
+};
+/**
+ * Restore extracted magic blocks back into a markdown string.
+ */
+export declare function restoreMagicBlocks(replaced: string, blocks: BlockHit[]): string;
+export {};

package/dist/main.js

@@ -88109,23 +88109,62 @@ const stripCommentsTransformer = () => {
     };
 };
 
+;// ./lib/utils/extractMagicBlocks.ts
+/**
+ * The content matching in this regex captures everything between `[block:TYPE]`
+ * and `[/block]`, including new lines. Negative lookahead for the closing
+ * `[/block]` tag is required to prevent greedy matching to ensure it stops at
+ * the first closing tag it encounters preventing vulnerability to polynomial
+ * backtracking issues.
+ */
+const MAGIC_BLOCK_REGEX = /\[block:[^\]]{1,100}\](?:(?!\[block:)(?!\[\/block\])[\s\S])*\[\/block\]/g;
+/**
+ * Extract legacy magic block syntax from a markdown string.
+ * Returns the modified markdown and an array of extracted blocks.
+ */
+function extractMagicBlocks(markdown) {
+    const blocks = [];
+    let index = 0;
+    const replaced = markdown.replace(MAGIC_BLOCK_REGEX, match => {
+        // Use backticks so it becomes a code span, preventing remarkParse from
+        // parsing special characters in the token as markdown syntax
+        const token = `\`__MAGIC_BLOCK_${index}__\``;
+        blocks.push({ token, raw: match });
+        index += 1;
+        return token;
+    });
+    return { replaced, blocks };
+}
+/**
+ * Restore extracted magic blocks back into a markdown string.
+ */
+function restoreMagicBlocks(replaced, blocks) {
+    return blocks.reduce((acc, { token, raw }) => {
+        return acc.split(token).join(raw);
+    }, replaced);
+}
+
 ;// ./lib/stripComments.ts
 
 
 
 
 
+
 /**
  * Removes Markdown and MDX comments.
  */
 async function stripComments(doc, { mdx } = {}) {
+    const { replaced, blocks } = extractMagicBlocks(doc);
     const processor = unified()
         .use(remarkParse)
         .use(mdx ? remarkMdx : undefined)
         .use(stripCommentsTransformer)
         .use(remarkStringify);
-    const file = await processor.process(doc);
-    return String(file);
+    const file = await processor.process(replaced);
+    const stringified = String(file).trim();
+    const restored = restoreMagicBlocks(stringified, blocks);
+    return restored;
 }
 /* harmony default export */ const lib_stripComments = (stripComments);
 

package/dist/main.node.js

@@ -108320,23 +108320,62 @@ const stripCommentsTransformer = () => {
     };
 };
 
+;// ./lib/utils/extractMagicBlocks.ts
+/**
+ * The content matching in this regex captures everything between `[block:TYPE]`
+ * and `[/block]`, including new lines. Negative lookahead for the closing
+ * `[/block]` tag is required to prevent greedy matching to ensure it stops at
+ * the first closing tag it encounters preventing vulnerability to polynomial
+ * backtracking issues.
+ */
+const MAGIC_BLOCK_REGEX = /\[block:[^\]]{1,100}\](?:(?!\[block:)(?!\[\/block\])[\s\S])*\[\/block\]/g;
+/**
+ * Extract legacy magic block syntax from a markdown string.
+ * Returns the modified markdown and an array of extracted blocks.
+ */
+function extractMagicBlocks(markdown) {
+    const blocks = [];
+    let index = 0;
+    const replaced = markdown.replace(MAGIC_BLOCK_REGEX, match => {
+        // Use backticks so it becomes a code span, preventing remarkParse from
+        // parsing special characters in the token as markdown syntax
+        const token = `\`__MAGIC_BLOCK_${index}__\``;
+        blocks.push({ token, raw: match });
+        index += 1;
+        return token;
+    });
+    return { replaced, blocks };
+}
+/**
+ * Restore extracted magic blocks back into a markdown string.
+ */
+function restoreMagicBlocks(replaced, blocks) {
+    return blocks.reduce((acc, { token, raw }) => {
+        return acc.split(token).join(raw);
+    }, replaced);
+}
+
 ;// ./lib/stripComments.ts
 
 
 
 
 
+
 /**
  * Removes Markdown and MDX comments.
  */
 async function stripComments(doc, { mdx } = {}) {
+    const { replaced, blocks } = extractMagicBlocks(doc);
     const processor = unified()
         .use(remarkParse)
         .use(mdx ? remarkMdx : undefined)
         .use(stripCommentsTransformer)
         .use(remarkStringify);
-    const file = await processor.process(doc);
-    return String(file);
+    const file = await processor.process(replaced);
+    const stringified = String(file).trim();
+    const restored = restoreMagicBlocks(stringified, blocks);
+    return restored;
 }
 /* harmony default export */ const lib_stripComments = (stripComments);