mdast-util-mdx-expression - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

lib/index.d.ts

@@ -11,3 +11,3 @@ /**
  */
-export function mdxExpressionFromMarkdown(): FromMarkdownExtension
+export function mdxExpressionFromMarkdown(): FromMarkdownExtension;
 /**
@@ -20,9 +20,5 @@ * Create an extension for `mdast-util-to-markdown` to enable MDX expressions
  */
-export function mdxExpressionToMarkdown(): ToMarkdownExtension
-export type CompileContext = import('mdast-util-from-markdown').CompileContext
-export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension
-export type FromMarkdownHandle = import('mdast-util-from-markdown').Handle
-export type ToMarkdownHandle = import('mdast-util-to-markdown').Handle
-export type ToMarkdownExtension = import('mdast-util-to-markdown').Options
-export type MdxFlowExpression = import('../index.js').MdxFlowExpression
-export type MdxTextExpression = import('../index.js').MdxTextExpression
+export function mdxExpressionToMarkdown(): ToMarkdownExtension;
+import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown';
+import type { Options as ToMarkdownExtension } from 'mdast-util-to-markdown';
+//# sourceMappingURL=index.d.ts.map

lib/index.js

 /**
- * @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
- * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
- * @typedef {import('mdast-util-from-markdown').Handle} FromMarkdownHandle
- *
- * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- *
- * @typedef {import('../index.js').MdxFlowExpression} MdxFlowExpression
- * @typedef {import('../index.js').MdxTextExpression} MdxTextExpression
+ * @import {CompileContext, Extension as FromMarkdownExtension, Handle as FromMarkdownHandle} from 'mdast-util-from-markdown'
+ * @import {MdxFlowExpression, MdxTextExpression} from 'mdast-util-mdx-expression'
+ * @import {Handle as ToMarkdownHandle, Options as ToMarkdownExtension, State} from 'mdast-util-to-markdown'
+ * @import {Parents} from 'mdast'
  */
@@ -107,6 +102,20 @@
  * @param {MdxFlowExpression | MdxTextExpression} node
+ *   Node.
+ * @param {Parents | undefined} parent
+ *   Parent, if any.
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @returns {string}
+ *   Serialized markdown.
  */
-function handleMdxExpression(node) {
+function handleMdxExpression(node, parent, state) {
   const value = node.value || ''
-  return '{' + value + '}'
+  const result = state.indentLines(value, function (line, index, blank) {
+    // Tab-size to eat has to be the same as what we serialize as.
+    // While in some places in markdown that’s 4, in JS it’s more common as 2.
+    // Which is what’s also in `mdast-util-mdx-jsx`:
+    // <https://github.com/syntax-tree/mdast-util-mdx-jsx/blob/40b951b/lib/index.js#L52>
+    return (index === 0 || blank ? '' : '  ') + line
+  })
+  return '{' + result + '}'
 }

package.json

 {
   "name": "mdast-util-mdx-expression",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "mdast extension to parse and serialize MDX (or MDX.js) expressions",
@@ -48,13 +48,13 @@ "license": "MIT",
     "@types/acorn": "^4.0.0",
-    "@types/node": "^20.0.0",
+    "@types/node": "^22.0.0",
     "acorn": "^8.0.0",
-    "c8": "^8.0.0",
-    "micromark-extension-mdx-expression": "^2.0.0",
-    "prettier": "^2.0.0",
-    "remark-cli": "^11.0.0",
-    "remark-preset-wooorm": "^9.0.0",
+    "c8": "^10.0.0",
+    "micromark-extension-mdx-expression": "^3.0.0",
+    "prettier": "^3.0.0",
+    "remark-cli": "^12.0.0",
+    "remark-preset-wooorm": "^10.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
     "unist-util-remove-position": "^5.0.0",
-    "xo": "^0.54.0"
+    "xo": "^0.59.0"
   },
@@ -64,3 +64,3 @@ "scripts": {
     "build": "tsc --build --clean && tsc --build && type-coverage",
-    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+    "format": "remark . -qfo && prettier . -w --log-level warn && xo --fix",
     "test-api-prod": "node --conditions production test.js",
@@ -103,4 +103,7 @@ "test-api-dev": "node --conditions development test.js",
     ],
-    "prettier": true
+    "prettier": true,
+    "rules": {
+      "unicorn/prefer-at": "off"
+    }
   }
 }

readme.md

@@ -15,23 +15,23 @@ # mdast-util-mdx-expression
 
-*   [What is this?](#what-is-this)
-*   [When to use this](#when-to-use-this)
-*   [Install](#install)
-*   [Use](#use)
-*   [API](#api)
-    *   [`mdxExpressionFromMarkdown()`](#mdxexpressionfrommarkdown)
-    *   [`mdxExpressionToMarkdown()`](#mdxexpressiontomarkdown)
-    *   [`MdxFlowExpression`](#mdxflowexpression)
-    *   [`MdxTextExpression`](#mdxtextexpression)
-    *   [`MdxFlowExpressionHast`](#mdxflowexpressionhast)
-    *   [`MdxTextExpressionHast`](#mdxtextexpressionhast)
-*   [HTML](#html)
-*   [Syntax](#syntax)
-*   [Syntax tree](#syntax-tree)
-    *   [Nodes](#nodes)
-    *   [Content model](#content-model)
-*   [Types](#types)
-*   [Compatibility](#compatibility)
-*   [Related](#related)
-*   [Contribute](#contribute)
-*   [License](#license)
+* [What is this?](#what-is-this)
+* [When to use this](#when-to-use-this)
+* [Install](#install)
+* [Use](#use)
+* [API](#api)
+  * [`mdxExpressionFromMarkdown()`](#mdxexpressionfrommarkdown)
+  * [`mdxExpressionToMarkdown()`](#mdxexpressiontomarkdown)
+  * [`MdxFlowExpression`](#mdxflowexpression)
+  * [`MdxTextExpression`](#mdxtextexpression)
+  * [`MdxFlowExpressionHast`](#mdxflowexpressionhast)
+  * [`MdxTextExpressionHast`](#mdxtextexpressionhast)
+* [HTML](#html)
+* [Syntax](#syntax)
+* [Syntax tree](#syntax-tree)
+  * [Nodes](#nodes)
+  * [Content model](#content-model)
+* [Types](#types)
+* [Compatibility](#compatibility)
+* [Related](#related)
+* [Contribute](#contribute)
+* [License](#license)
 
@@ -394,3 +394,4 @@ ## What is this?
 /**
- * @typedef {import('mdast-util-mdx-expression')}
+ * @import {} from 'mdast-util-mdx-expression'
+ * @import {Root} from 'mdast'
  */
@@ -400,3 +401,3 @@
 
-/** @type {import('mdast').Root} */
+/** @type {Root} */
 const tree = getMdastNodeSomeHow()
@@ -424,8 +425,8 @@
 
-*   [`remarkjs/remark-mdx`][remark-mdx]
-    — remark plugin to support MDX
-*   [`syntax-tree/mdast-util-mdx`][mdast-util-mdx]
-    — mdast utility to support MDX
-*   [`micromark/micromark-extension-mdx-expression`][extension]
-    — micromark extension to parse MDX expressions
+* [`remarkjs/remark-mdx`][remark-mdx]
+  — remark plugin to support MDX
+* [`syntax-tree/mdast-util-mdx`][mdast-util-mdx]
+  — mdast utility to support MDX
+* [`micromark/micromark-extension-mdx-expression`][extension]
+  — micromark extension to parse MDX expressions
 
@@ -432,0 +433,0 @@ ## Contribute

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25728

increased by1.32%

Number of package files

8

increased by14.29%

Lines of code

280

increased by1.45%

Number of lines in readme file

532

increased by0.19%

No dependency changes