@readme/markdown 11.5.1 → 11.6.0

package/dist/index.d.ts

@@ -6,7 +6,7 @@ declare const utils: {
     getHref: typeof getHref;
     calloutIcons: {};
 };
-export { compile, exports, hast, run, mdast, mdastV6, mdx, migrate, plain, remarkPlugins, tags } from './lib';
+export { compile, exports, hast, run, mdast, mdastV6, mdx, migrate, plain, remarkPlugins, stripComments, tags } from './lib';
 export { default as Owlmoji } from './lib/owlmoji';
 export { Components, utils };
 export { tailwindCompiler } from './utils/tailwind-compiler';

package/dist/lib/index.d.ts

@@ -10,3 +10,4 @@ export { default as migrate } from './migrate';
 export { default as plain } from './plain';
 export { default as run } from './run';
 export { default as tags } from './tags';
+export { default as stripComments } from './stripComments';

package/dist/lib/stripComments.d.ts

@@ -0,0 +1,8 @@
+interface Opts {
+    mdx?: boolean;
+}
+/**
+ * Removes Markdown and MDX comments.
+ */
+declare function stripComments(doc: string, { mdx }?: Opts): Promise<string>;
+export default stripComments;

package/dist/main.js

@@ -8720,6 +8720,7 @@ __webpack_require__.d(__webpack_exports__, {
   plain: () => (/* reexport */ lib_plain),
   remarkPlugins: () => (/* reexport */ remarkPlugins),
   run: () => (/* reexport */ lib_run),
+  stripComments: () => (/* reexport */ lib_stripComments),
   tags: () => (/* reexport */ lib_tags),
   tailwindCompiler: () => (/* reexport */ tailwindCompiler),
   utils: () => (/* binding */ utils)
@@ -67873,6 +67874,9 @@ const visitor = (table, index, parent) => {
         const content = cell.children.length === 1 && cell.children[0].type === 'paragraph'
             ? cell.children[0].children[0]
             : cell.children[0];
+        // If cell is empty there's nothing to visit
+        if (!content)
+            return EXIT;
         // @note: Compatibility with RDMD. Ideally, I'd put this in a separate
         // transformer, but then there'd be some duplication.
         visit(cell, 'break', (_, breakIndex, breakParent) => {
@@ -87979,6 +87983,66 @@ const tags = (doc) => {
 };
 /* harmony default export */ const lib_tags = (tags);
 
+;// ./processor/transform/stripComments.ts
+
+const HTML_COMMENT_REGEX = /<!--[\s\S]*?-->/g;
+const MDX_COMMENT_REGEX = /\/\*[\s\S]*?\*\//g;
+/**
+ * A remark plugin to remove comments from Markdown and MDX.
+ */
+const stripCommentsTransformer = () => {
+    return (tree) => {
+        visit(tree, ['html', 'mdxFlowExpression', 'mdxTextExpression'], (node, index, parent) => {
+            if (parent && typeof index === 'number') {
+                // Remove HTML comments
+                if (node.type === 'html' && HTML_COMMENT_REGEX.test(node.value)) {
+                    const newValue = node.value.replace(HTML_COMMENT_REGEX, '').trim();
+                    if (newValue) {
+                        node.value = newValue;
+                    }
+                    else {
+                        parent.children.splice(index, 1);
+                        return [SKIP, index];
+                    }
+                }
+                // Remove MDX comments
+                if ((node.type === 'mdxFlowExpression' || node.type === 'mdxTextExpression') &&
+                    MDX_COMMENT_REGEX.test(node.value)) {
+                    const newValue = node.value.replace(MDX_COMMENT_REGEX, '').trim();
+                    if (newValue) {
+                        node.value = newValue;
+                    }
+                    else {
+                        parent.children.splice(index, 1);
+                        return [SKIP, index];
+                    }
+                }
+            }
+            return undefined;
+        });
+    };
+};
+
+;// ./lib/stripComments.ts
+
+
+
+
+
+/**
+ * Removes Markdown and MDX comments.
+ */
+async function stripComments(doc, { mdx } = {}) {
+    const processor = unified()
+        .use(remarkParse)
+        .use(mdx ? remarkMdx : undefined)
+        .use(stripCommentsTransformer)
+        .use(remarkStringify);
+    const file = await processor.process(doc);
+    return String(file);
+}
+/* harmony default export */ const lib_stripComments = (stripComments);
+
 ;// ./lib/index.ts
 
 
@@ -87992,6 +88056,7 @@ const tags = (doc) => {
 
 
 
+
 ;// ./index.tsx
 
 

package/dist/main.node.js

@@ -16389,6 +16389,7 @@ __webpack_require__.d(__webpack_exports__, {
   plain: () => (/* reexport */ lib_plain),
   remarkPlugins: () => (/* reexport */ remarkPlugins),
   run: () => (/* reexport */ lib_run),
+  stripComments: () => (/* reexport */ lib_stripComments),
   tags: () => (/* reexport */ lib_tags),
   tailwindCompiler: () => (/* reexport */ tailwindCompiler),
   utils: () => (/* binding */ utils)
@@ -88084,6 +88085,9 @@ const visitor = (table, index, parent) => {
         const content = cell.children.length === 1 && cell.children[0].type === 'paragraph'
             ? cell.children[0].children[0]
             : cell.children[0];
+        // If cell is empty there's nothing to visit
+        if (!content)
+            return EXIT;
         // @note: Compatibility with RDMD. Ideally, I'd put this in a separate
         // transformer, but then there'd be some duplication.
         visit(cell, 'break', (_, breakIndex, breakParent) => {
@@ -108190,6 +108194,66 @@ const tags = (doc) => {
 };
 /* harmony default export */ const lib_tags = (tags);
 
+;// ./processor/transform/stripComments.ts
+
+const HTML_COMMENT_REGEX = /<!--[\s\S]*?-->/g;
+const MDX_COMMENT_REGEX = /\/\*[\s\S]*?\*\//g;
+/**
+ * A remark plugin to remove comments from Markdown and MDX.
+ */
+const stripCommentsTransformer = () => {
+    return (tree) => {
+        visit(tree, ['html', 'mdxFlowExpression', 'mdxTextExpression'], (node, index, parent) => {
+            if (parent && typeof index === 'number') {
+                // Remove HTML comments
+                if (node.type === 'html' && HTML_COMMENT_REGEX.test(node.value)) {
+                    const newValue = node.value.replace(HTML_COMMENT_REGEX, '').trim();
+                    if (newValue) {
+                        node.value = newValue;
+                    }
+                    else {
+                        parent.children.splice(index, 1);
+                        return [SKIP, index];
+                    }
+                }
+                // Remove MDX comments
+                if ((node.type === 'mdxFlowExpression' || node.type === 'mdxTextExpression') &&
+                    MDX_COMMENT_REGEX.test(node.value)) {
+                    const newValue = node.value.replace(MDX_COMMENT_REGEX, '').trim();
+                    if (newValue) {
+                        node.value = newValue;
+                    }
+                    else {
+                        parent.children.splice(index, 1);
+                        return [SKIP, index];
+                    }
+                }
+            }
+            return undefined;
+        });
+    };
+};
+
+;// ./lib/stripComments.ts
+
+
+
+
+
+/**
+ * Removes Markdown and MDX comments.
+ */
+async function stripComments(doc, { mdx } = {}) {
+    const processor = unified()
+        .use(remarkParse)
+        .use(mdx ? remarkMdx : undefined)
+        .use(stripCommentsTransformer)
+        .use(remarkStringify);
+    const file = await processor.process(doc);
+    return String(file);
+}
+/* harmony default export */ const lib_stripComments = (stripComments);
+
 ;// ./lib/index.ts
 
 
@@ -108203,6 +108267,7 @@ const tags = (doc) => {
 
 
 
+
 ;// ./index.tsx