Add options.quote for attribute values

Related to: GH-3.

Author: wooorm

index.js

@@ -4,6 +4,7 @@
  * @typedef {import('./lib/index.js').MdxJsxExpressionAttribute} MdxJsxExpressionAttribute
  * @typedef {import('./lib/index.js').MdxJsxFlowElement} MdxJsxFlowElement
  * @typedef {import('./lib/index.js').MdxJsxTextElement} MdxJsxTextElement
+ * @typedef {import('./lib/index.js').ToMarkdownOptions} ToMarkdownOptions
  */
 
 export {mdxJsxFromMarkdown, mdxJsxToMarkdown} from './lib/index.js'

lib/index.js

@@ -16,6 +16,9 @@
  * @typedef {import('./complex-types').MdxJsxFlowElement} MdxJsxFlowElement
  * @typedef {import('./complex-types').MdxJsxTextElement} MdxJsxTextElement
  * @typedef {{name: string|null, attributes: (MdxJsxAttribute|MdxJsxExpressionAttribute)[], close?: boolean, selfClosing?: boolean, start: Token['start'], end: Token['start']}} Tag
+ *
+ * @typedef ToMarkdownOptions
+ * @property {'"'|"'"} [quote='"']
  */
 
 import {parseEntities} from 'parse-entities'
@@ -24,7 +27,6 @@ import {VFileMessage} from 'vfile-message'
 import {stringifyEntitiesLight} from 'stringify-entities'
 import {containerFlow} from 'mdast-util-to-markdown/lib/util/container-flow.js'
 import {containerPhrasing} from 'mdast-util-to-markdown/lib/util/container-phrasing.js'
-import {checkQuote} from 'mdast-util-to-markdown/lib/util/check-quote.js'
 import {indentLines} from 'mdast-util-to-markdown/lib/util/indent-lines.js'
 
 /** @return {FromMarkdownExtension} */
@@ -351,8 +353,22 @@ export function mdxJsxFromMarkdown() {
   }
 }
 
-/** @returns {ToMarkdownExtension} */
-export function mdxJsxToMarkdown() {
+/**
+ * @param {ToMarkdownOptions} [options={}]
+ *   Configuration (optional).
+ * @returns {ToMarkdownExtension}
+ */
+export function mdxJsxToMarkdown(options = {}) {
+  const {quote = '"'} = options
+
+  if (quote !== '"' && quote !== "'") {
+    throw new Error(
+      'Cannot serialize attribute values with `' +
+        quote +
+        '` for `options.quote`, expected `"`, or `\'`'
+    )
+  }
+
   mdxElement.peek = peekElement
 
   return {
@@ -376,7 +392,6 @@ export function mdxJsxToMarkdown() {
   function mdxElement(node, _, context) {
     const selfClosing =
       node.name && (!node.children || node.children.length === 0)
-    const quote = checkQuote(context)
     const exit = context.enter(node.type)
     let attributeValue = ''
     let index = -1

readme.md

@@ -18,7 +18,7 @@ Extensions to parse and serialize JSX between mdast and markdown
 *   [Use](#use)
 *   [API](#api)
     *   [`mdxJsxFromMarkdown()`](#mdxjsxfrommarkdown)
-    *   [`mdxJsxToMarkdown()`](#mdxjsxtomarkdown)
+    *   [`mdxJsxToMarkdown(options?)`](#mdxjsxtomarkdownoptions)
 *   [Syntax tree](#syntax-tree)
     *   [Nodes](#nodes)
     *   [Mixin](#mixin)
@@ -220,7 +220,7 @@ When using [`micromark-extension-mdx-jsx`][micromark-extension-mdx-jsx]
 with `options.addResult`, nodes will have a `data.estree` field set to an
 [ESTree][].
 
-### `mdxJsxToMarkdown()`
+### `mdxJsxToMarkdown(options?)`
 
 Function that can be called to get an extension for
 [`mdast-util-to-markdown`][mdast-util-to-markdown].
@@ -230,9 +230,13 @@ This extension configures `mdast-util-to-markdown` with
 [`options.resourceLink: true`][mdast-util-to-markdown-resourcelink] too, do not
 overwrite them!
 
-Passing [`options.quote`][mdast-util-to-markdown-quote] to
-`mdast-util-to-markdown` is honored for
-attributes.
+##### `options`
+
+Configuration (optional).
+
+###### `options.quote`
+
+Quote to use around attribute values (`'"'` or `"'"`, default: `'"'`).
 
 ## Syntax tree
 
@@ -368,7 +372,10 @@ type MdxJsxPhrasingContent = MdxJsxTextElement | PhrasingContent
 
 This package is fully typed with [TypeScript][].
 It exports the `MdxJsxAttributeValueExpression`, `MdxJsxAttribute`,
-`MdxJsxExpressionAttribute`, `MdxJsxFlowElement`, and `MdxJsxTextElement` types.
+`MdxJsxExpressionAttribute`, `MdxJsxFlowElement`, and `MdxJsxTextElement` types
+that represents the supported nodes.
+It also exports `ToMarkdownOptions`, which represents the structure of the
+respective options.
 
 It also registers the node types with `@types/mdast`
 
@@ -493,8 +500,6 @@ abide by its terms.
 
 [micromark-extension-mdx-jsx]: https://github.com/micromark/micromark-extension-mdx-jsx
 
-[mdast-util-to-markdown-quote]: https://github.com/syntax-tree/mdast-util-to-markdown#optionsquote
-
 [mdast-util-to-markdown-fences]: https://github.com/syntax-tree/mdast-util-to-markdown#optionsfences
 
 [mdast-util-to-markdown-resourcelink]: https://github.com/syntax-tree/mdast-util-to-markdown#optionsresourcelink

test.js

@@ -1652,20 +1652,6 @@ test('mdast -> markdown', (t) => {
     'should serialize value attributes'
   )
 
-  t.deepEqual(
-    toMarkdown(
-      {
-        type: 'mdxJsxFlowElement',
-        name: 'x',
-        attributes: [{type: 'mdxJsxAttribute', name: 'y', value: 'z'}],
-        children: []
-      },
-      {extensions: [mdxJsxToMarkdown()], quote: "'"}
-    ),
-    "<x y='z'/>\n",
-    'should serialize value attributes honoring `quote`'
-  )
-
   t.deepEqual(
     toMarkdown(
       {
@@ -1850,5 +1836,36 @@ test('mdast -> markdown', (t) => {
     'should not serialize code as indented'
   )
 
+  t.deepEqual(
+    toMarkdown(
+      {
+        type: 'mdxJsxFlowElement',
+        name: 'x',
+        attributes: [{type: 'mdxJsxAttribute', name: 'y', value: 'z'}],
+        children: []
+      },
+      {extensions: [mdxJsxToMarkdown({quote: "'"})]}
+    ),
+    "<x y='z'/>\n",
+    'should support `options.quote` to quote attribute values'
+  )
+
+  t.throws(
+    () => {
+      toMarkdown(
+        {
+          type: 'mdxJsxFlowElement',
+          name: 'x',
+          attributes: [],
+          children: []
+        },
+        // @ts-expect-error: runtime exception.
+        {extensions: [mdxJsxToMarkdown({quote: '!'})]}
+      )
+    },
+    /Cannot serialize attribute values with `!` for `options.quote`, expected `"`, or `'`/,
+    'should crash on an unclosed text jsx (agnostic)'
+  )
+
   t.end()
 })