@readme/markdown 13.3.0 → 13.4.0

package/dist/main.js

@@ -52928,6 +52928,12 @@ const stripCommentsTransformer = () => {
 
 
 const STRIP_TAGS = ['script', 'style'];
+/** Valid JS identifier: starts with $, _, or a letter; followed by $, _, letters, digits, etc. */
+const JS_IDENTIFIER_RE = /^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\u200C\u200D]*$/u;
+/** Format a variable key as MDX syntax, using bracket notation for non-identifier keys (e.g. hyphens). */
+function toMdxVariableSyntax(key) {
+    return JS_IDENTIFIER_RE.test(key) ? `{user.${key}}` : `{user["${key}"]}`;
+}
 /**
  * Extract variable key from MDX expression AST (e.g., {user.name} → 'name')
  * Uses ESTree AST inspection, matching the approach in processor/transform/variables.ts
@@ -52986,8 +52992,9 @@ function plain_one(node, opts) {
             case 'variable':
             case 'Variable': {
                 const key = node.properties.name.toString();
-                if (opts.preserveVariableSyntax)
-                    return `{user.${key}}`;
+                if (opts.preserveVariableSyntax) {
+                    return node.properties.isLegacy ? `<<${key}>>` : toMdxVariableSyntax(key);
+                }
                 const val = 'variables' in opts && opts.variables[key];
                 return val || key;
             }
@@ -53012,7 +53019,7 @@ function plain_one(node, opts) {
         const key = extractMdxVariableKey(node);
         if (key) {
             if (opts.preserveVariableSyntax)
-                return `{user.${key}}`;
+                return toMdxVariableSyntax(key);
             return ('variables' in opts && opts.variables[key]) || key;
         }
     }
@@ -94297,15 +94304,13 @@ function preprocessJSXExpressions(content, context = {}) {
     let processed = protectHTMLBlockContent(content);
     // Step 1: Protect code blocks and inline code
     const { protectedCode, protectedContent } = protectCodeBlocks(processed);
-    // Step 2: Remove JSX comments
-    processed = removeJSXComments(protectedContent);
-    // Step 3: Evaluate attribute expressions (JSX attribute syntax: href={baseUrl})
+    // Step 2: Evaluate attribute expressions (JSX attribute syntax: href={baseUrl})
     // For inline expressions, we use a library to parse the expression & evaluate it later
     // For attribute expressions, it was difficult to use a library to parse them, so do it manually
-    processed = evaluateAttributeExpressions(processed, context, protectedCode);
-    // Step 4: Escape unbalanced braces to prevent MDX expression parsing errors
+    processed = evaluateAttributeExpressions(protectedContent, context, protectedCode);
+    // Step 3: Escape unbalanced braces to prevent MDX expression parsing errors
     processed = escapeUnbalancedBraces(processed);
-    // Step 5: Restore protected code blocks
+    // Step 4: Restore protected code blocks
     processed = restoreCodeBlocks(processed, protectedCode);
     return processed;
 }
@@ -96351,13 +96356,38 @@ const variablesCodeResolver = ({ variables } = {}) => tree => {
  * Captures the field name in group 1 (dot notation) or group 2 (bracket notation)
  */
 const USER_VAR_REGEX = /\{user\.(\w+)\}|\{user\[['"](\w+)['"]\]\}/g;
+function makeVariableNode(varName, rawValue) {
+    return {
+        type: NodeTypes.variable,
+        data: {
+            hName: 'Variable',
+            hProperties: { name: varName },
+        },
+        value: rawValue,
+    };
+}
 /**
- * A remark plugin that parses {user.<field>} patterns from text nodes
- * without requiring remarkMdx. Creates Variable nodes for runtime resolution.
+ * A remark plugin that parses {user.<field>} patterns from text nodes and
+ * mdxTextExpression nodes, creating Variable nodes for runtime resolution.
+ *
+ * Handles both:
+ * - `text` nodes: when safeMode is true or after expression evaluation
+ * - `mdxTextExpression` nodes: when mdxExpression has parsed {user.*} before evaluation
  *
  * Supports any user field: name, email, email_verified, exp, iat, etc.
  */
 const variablesTextTransformer = () => tree => {
+    // Handle mdxTextExpression nodes (e.g. {user.name} parsed by mdxExpression)
+    visit(tree, 'mdxTextExpression', (node, index, parent) => {
+        if (index === undefined || !parent)
+            return;
+        const wrapped = `{${(node.value ?? '').trim()}}`; // Wrap the expression value in {} to match the USER_VAR_REGEX pattern
+        const matches = [...wrapped.matchAll(USER_VAR_REGEX)];
+        if (matches.length !== 1)
+            return;
+        const varName = matches[0][1] || matches[0][2];
+        parent.children.splice(index, 1, makeVariableNode(varName, wrapped));
+    });
     visit(tree, 'text', (node, index, parent) => {
         if (index === undefined || !parent)
             return;
@@ -96382,15 +96412,7 @@ const variablesTextTransformer = () => tree => {
             }
             // Extract variable name from either capture group (dot or bracket notation)
             const varName = match[1] || match[2];
-            // Create Variable node
-            parts.push({
-                type: NodeTypes.variable,
-                data: {
-                    hName: 'Variable',
-                    hProperties: { name: varName },
-                },
-                value: match[0],
-            });
+            parts.push(makeVariableNode(varName, match[0]));
             lastIndex = matchIndex + match[0].length;
         });
         // Add remaining text after last match
@@ -97486,6 +97508,7 @@ function loadComponents() {
 
 
 
+
 
 
 const defaultTransformers = [callouts, code_tabs, gemoji_, transform_embeds];
@@ -97546,8 +97569,7 @@ function mdxishAstProcessor(mdContent, opts = {}) {
         .use(mdxish_tables)
         .use(mdxish_html_blocks)
         .use(newEditorTypes ? mdxish_jsx_to_mdast : undefined) // Convert JSX elements to MDAST types
-        .use(safeMode ? undefined : evaluate_expressions, { context: jsxContext }) // Evaluate MDX expressions using jsxContext
-        .use(variables_text) // Parse {user.*} patterns from text
+        .use(variables_text) // Parse {user.*} patterns from text nodes
         .use(useTailwind ? transform_tailwind : undefined, { components: tempComponentsMap })
         .use(remarkGfm);
     return {
@@ -97581,13 +97603,18 @@ function mdxishMdastToMd(mdast) {
  * @see {@link https://github.com/readmeio/rmdx/blob/main/docs/mdxish-flow.md}
  */
 function mdxish(mdContent, opts = {}) {
-    const { components: userComponents = {}, variables } = opts;
+    const { components: userComponents = {}, jsxContext = {}, safeMode = false, variables } = opts;
     const components = {
         ...loadComponents(),
         ...userComponents,
     };
-    const { processor, parserReadyContent } = mdxishAstProcessor(mdContent, opts);
+    // Remove JSX comments before processing (protect code blocks first)
+    const { protectedCode, protectedContent } = protectCodeBlocks(mdContent);
+    const withoutComments = removeJSXComments(protectedContent);
+    const contentWithoutComments = restoreCodeBlocks(withoutComments, protectedCode);
+    const { processor, parserReadyContent } = mdxishAstProcessor(contentWithoutComments, opts);
     processor
+        .use(safeMode ? undefined : evaluate_expressions, { context: jsxContext }) // Evaluate MDX expressions using jsxContext
         .use(remarkBreaks)
         .use(variables_code, { variables }) // Resolve <<...>> and {user.*} inside code and inline code nodes
         .use(remarkRehype, { allowDangerousHtml: true, handlers: mdxComponentHandlers })
@@ -98146,6 +98173,7 @@ function restoreMagicBlocks(replaced, blocks) {
 
 
 
+
 /**
  * Removes Markdown and MDX comments.
  */
@@ -98166,6 +98194,7 @@ async function stripComments(doc, { mdx, mdxish } = {}) {
         .use(normalize_malformed_md_syntax)
         .use(mdx ? remarkMdx : undefined)
         .use(stripCommentsTransformer)
+        .use(remarkGfm)
         .use(remarkStringify, mdx
         ? {}
         : {

package/dist/main.node.js

@@ -73132,6 +73132,12 @@ const stripCommentsTransformer = () => {
 
 
 const STRIP_TAGS = ['script', 'style'];
+/** Valid JS identifier: starts with $, _, or a letter; followed by $, _, letters, digits, etc. */
+const JS_IDENTIFIER_RE = /^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\u200C\u200D]*$/u;
+/** Format a variable key as MDX syntax, using bracket notation for non-identifier keys (e.g. hyphens). */
+function toMdxVariableSyntax(key) {
+    return JS_IDENTIFIER_RE.test(key) ? `{user.${key}}` : `{user["${key}"]}`;
+}
 /**
  * Extract variable key from MDX expression AST (e.g., {user.name} → 'name')
  * Uses ESTree AST inspection, matching the approach in processor/transform/variables.ts
@@ -73190,8 +73196,9 @@ function plain_one(node, opts) {
             case 'variable':
             case 'Variable': {
                 const key = node.properties.name.toString();
-                if (opts.preserveVariableSyntax)
-                    return `{user.${key}}`;
+                if (opts.preserveVariableSyntax) {
+                    return node.properties.isLegacy ? `<<${key}>>` : toMdxVariableSyntax(key);
+                }
                 const val = 'variables' in opts && opts.variables[key];
                 return val || key;
             }
@@ -73216,7 +73223,7 @@ function plain_one(node, opts) {
         const key = extractMdxVariableKey(node);
         if (key) {
             if (opts.preserveVariableSyntax)
-                return `{user.${key}}`;
+                return toMdxVariableSyntax(key);
             return ('variables' in opts && opts.variables[key]) || key;
         }
     }
@@ -114501,15 +114508,13 @@ function preprocessJSXExpressions(content, context = {}) {
     let processed = protectHTMLBlockContent(content);
     // Step 1: Protect code blocks and inline code
     const { protectedCode, protectedContent } = protectCodeBlocks(processed);
-    // Step 2: Remove JSX comments
-    processed = removeJSXComments(protectedContent);
-    // Step 3: Evaluate attribute expressions (JSX attribute syntax: href={baseUrl})
+    // Step 2: Evaluate attribute expressions (JSX attribute syntax: href={baseUrl})
     // For inline expressions, we use a library to parse the expression & evaluate it later
     // For attribute expressions, it was difficult to use a library to parse them, so do it manually
-    processed = evaluateAttributeExpressions(processed, context, protectedCode);
-    // Step 4: Escape unbalanced braces to prevent MDX expression parsing errors
+    processed = evaluateAttributeExpressions(protectedContent, context, protectedCode);
+    // Step 3: Escape unbalanced braces to prevent MDX expression parsing errors
     processed = escapeUnbalancedBraces(processed);
-    // Step 5: Restore protected code blocks
+    // Step 4: Restore protected code blocks
     processed = restoreCodeBlocks(processed, protectedCode);
     return processed;
 }
@@ -116555,13 +116560,38 @@ const variablesCodeResolver = ({ variables } = {}) => tree => {
  * Captures the field name in group 1 (dot notation) or group 2 (bracket notation)
  */
 const USER_VAR_REGEX = /\{user\.(\w+)\}|\{user\[['"](\w+)['"]\]\}/g;
+function makeVariableNode(varName, rawValue) {
+    return {
+        type: NodeTypes.variable,
+        data: {
+            hName: 'Variable',
+            hProperties: { name: varName },
+        },
+        value: rawValue,
+    };
+}
 /**
- * A remark plugin that parses {user.<field>} patterns from text nodes
- * without requiring remarkMdx. Creates Variable nodes for runtime resolution.
+ * A remark plugin that parses {user.<field>} patterns from text nodes and
+ * mdxTextExpression nodes, creating Variable nodes for runtime resolution.
+ *
+ * Handles both:
+ * - `text` nodes: when safeMode is true or after expression evaluation
+ * - `mdxTextExpression` nodes: when mdxExpression has parsed {user.*} before evaluation
  *
  * Supports any user field: name, email, email_verified, exp, iat, etc.
  */
 const variablesTextTransformer = () => tree => {
+    // Handle mdxTextExpression nodes (e.g. {user.name} parsed by mdxExpression)
+    visit(tree, 'mdxTextExpression', (node, index, parent) => {
+        if (index === undefined || !parent)
+            return;
+        const wrapped = `{${(node.value ?? '').trim()}}`; // Wrap the expression value in {} to match the USER_VAR_REGEX pattern
+        const matches = [...wrapped.matchAll(USER_VAR_REGEX)];
+        if (matches.length !== 1)
+            return;
+        const varName = matches[0][1] || matches[0][2];
+        parent.children.splice(index, 1, makeVariableNode(varName, wrapped));
+    });
     visit(tree, 'text', (node, index, parent) => {
         if (index === undefined || !parent)
             return;
@@ -116586,15 +116616,7 @@ const variablesTextTransformer = () => tree => {
             }
             // Extract variable name from either capture group (dot or bracket notation)
             const varName = match[1] || match[2];
-            // Create Variable node
-            parts.push({
-                type: NodeTypes.variable,
-                data: {
-                    hName: 'Variable',
-                    hProperties: { name: varName },
-                },
-                value: match[0],
-            });
+            parts.push(makeVariableNode(varName, match[0]));
             lastIndex = matchIndex + match[0].length;
         });
         // Add remaining text after last match
@@ -117690,6 +117712,7 @@ function loadComponents() {
 
 
 
+
 
 
 const defaultTransformers = [callouts, code_tabs, gemoji_, transform_embeds];
@@ -117750,8 +117773,7 @@ function mdxishAstProcessor(mdContent, opts = {}) {
         .use(mdxish_tables)
         .use(mdxish_html_blocks)
         .use(newEditorTypes ? mdxish_jsx_to_mdast : undefined) // Convert JSX elements to MDAST types
-        .use(safeMode ? undefined : evaluate_expressions, { context: jsxContext }) // Evaluate MDX expressions using jsxContext
-        .use(variables_text) // Parse {user.*} patterns from text
+        .use(variables_text) // Parse {user.*} patterns from text nodes
         .use(useTailwind ? transform_tailwind : undefined, { components: tempComponentsMap })
         .use(remarkGfm);
     return {
@@ -117785,13 +117807,18 @@ function mdxishMdastToMd(mdast) {
  * @see {@link https://github.com/readmeio/rmdx/blob/main/docs/mdxish-flow.md}
  */
 function mdxish(mdContent, opts = {}) {
-    const { components: userComponents = {}, variables } = opts;
+    const { components: userComponents = {}, jsxContext = {}, safeMode = false, variables } = opts;
     const components = {
         ...loadComponents(),
         ...userComponents,
     };
-    const { processor, parserReadyContent } = mdxishAstProcessor(mdContent, opts);
+    // Remove JSX comments before processing (protect code blocks first)
+    const { protectedCode, protectedContent } = protectCodeBlocks(mdContent);
+    const withoutComments = removeJSXComments(protectedContent);
+    const contentWithoutComments = restoreCodeBlocks(withoutComments, protectedCode);
+    const { processor, parserReadyContent } = mdxishAstProcessor(contentWithoutComments, opts);
     processor
+        .use(safeMode ? undefined : evaluate_expressions, { context: jsxContext }) // Evaluate MDX expressions using jsxContext
         .use(remarkBreaks)
         .use(variables_code, { variables }) // Resolve <<...>> and {user.*} inside code and inline code nodes
         .use(remarkRehype, { allowDangerousHtml: true, handlers: mdxComponentHandlers })
@@ -118350,6 +118377,7 @@ function restoreMagicBlocks(replaced, blocks) {
 
 
 
+
 /**
  * Removes Markdown and MDX comments.
  */
@@ -118370,6 +118398,7 @@ async function stripComments(doc, { mdx, mdxish } = {}) {
         .use(normalize_malformed_md_syntax)
         .use(mdx ? remarkMdx : undefined)
         .use(stripCommentsTransformer)
+        .use(remarkGfm)
         .use(remarkStringify, mdx
         ? {}
         : {