Add quote option

Related-to: GH-12.

Author: wooorm

index.d.ts

@@ -8,6 +8,17 @@ import type {
 
 export {directiveFromMarkdown, directiveToMarkdown} from './lib/index.js'
 
+/**
+ * Configuration.
+ */
+export interface ToMarkdownOptions {
+  /**
+   * Preferred quote to use around attribute values
+   * (default: the `quote` used by `mdast-util-to-markdown` for titles).
+   */
+  quote?: '"' | "'" | null | undefined
+}
+
 /**
  * Fields shared by directives.
  */

lib/index.js

@@ -1,5 +1,5 @@
 /**
- * @import {Directives, LeafDirective, TextDirective} from 'mdast-util-directive'
+ * @import {Directives, LeafDirective, TextDirective, ToMarkdownOptions} from 'mdast-util-directive'
  * @import {
  *   CompileContext,
  *   Extension as FromMarkdownExtension,
@@ -22,9 +22,10 @@ import {visitParents} from 'unist-util-visit-parents'
 
 const own = {}.hasOwnProperty
 
-const shortcut = /^[^\t\n\r "#'.<=>`}]+$/
+/** @type {Readonly<ToMarkdownOptions>} */
+const emptyOptions = {}
 
-handleDirective.peek = peekDirective
+const shortcut = /^[^\t\n\r "#'.<=>`}]+$/
 
 /**
  * Create an extension for `mdast-util-from-markdown` to enable directives in
@@ -80,10 +81,16 @@ export function directiveFromMarkdown() {
  * Create an extension for `mdast-util-to-markdown` to enable directives in
  * markdown.
  *
+ * @param {Readonly<ToMarkdownOptions> | null | undefined} [options]
+ *   Configuration (optional).
  * @returns {ToMarkdownExtension}
  *   Extension for `mdast-util-to-markdown` to enable directives.
  */
-export function directiveToMarkdown() {
+export function directiveToMarkdown(options) {
+  const settings = options || emptyOptions
+
+  handleDirective.peek = peekDirective
+
   return {
     handlers: {
       containerDirective: handleDirective,
@@ -108,6 +115,156 @@ export function directiveToMarkdown() {
       {atBreak: true, character: ':', after: ':'}
     ]
   }
+
+  /**
+   * @type {ToMarkdownHandle}
+   * @param {Directives} node
+   */
+  function handleDirective(node, _, state, info) {
+    const tracker = state.createTracker(info)
+    const sequence = fence(node)
+    const exit = state.enter(node.type)
+    let value = tracker.move(sequence + (node.name || ''))
+    /** @type {LeafDirective | Paragraph | TextDirective | undefined} */
+    let label
+
+    if (node.type === 'containerDirective') {
+      const head = (node.children || [])[0]
+      label = inlineDirectiveLabel(head) ? head : undefined
+    } else {
+      label = node
+    }
+
+    if (label && label.children && label.children.length > 0) {
+      const exit = state.enter('label')
+      /** @type {ConstructName} */
+      const labelType = `${node.type}Label`
+      const subexit = state.enter(labelType)
+      value += tracker.move('[')
+      value += tracker.move(
+        state.containerPhrasing(label, {
+          ...tracker.current(),
+          before: value,
+          after: ']'
+        })
+      )
+      value += tracker.move(']')
+      subexit()
+      exit()
+    }
+
+    value += tracker.move(attributes(node, state))
+
+    if (node.type === 'containerDirective') {
+      const head = (node.children || [])[0]
+      let shallow = node
+
+      if (inlineDirectiveLabel(head)) {
+        shallow = Object.assign({}, node, {children: node.children.slice(1)})
+      }
+
+      if (shallow && shallow.children && shallow.children.length > 0) {
+        value += tracker.move('\n')
+        value += tracker.move(state.containerFlow(shallow, tracker.current()))
+      }
+
+      value += tracker.move('\n' + sequence)
+    }
+
+    exit()
+    return value
+  }
+
+  /**
+   * @param {Directives} node
+   * @param {State} state
+   * @returns {string}
+   */
+  function attributes(node, state) {
+    // If the alternative is less common than `quote`, switch.
+    const appliedQuote = settings.quote || state.options.quote || '"'
+    const subset =
+      node.type === 'textDirective'
+        ? [appliedQuote]
+        : [appliedQuote, '\n', '\r']
+    const attributes = node.attributes || {}
+    /** @type {Array<string>} */
+    const values = []
+    /** @type {string | undefined} */
+    let classesFull
+    /** @type {string | undefined} */
+    let classes
+    /** @type {string | undefined} */
+    let id
+    /** @type {string} */
+    let key
+
+    for (key in attributes) {
+      if (
+        own.call(attributes, key) &&
+        attributes[key] !== undefined &&
+        attributes[key] !== null
+      ) {
+        const value = String(attributes[key])
+
+        if (key === 'id') {
+          id = shortcut.test(value) ? '#' + value : quoted('id', value)
+        } else if (key === 'class') {
+          const list = value.split(/[\t\n\r ]+/g)
+          /** @type {Array<string>} */
+          const classesFullList = []
+          /** @type {Array<string>} */
+          const classesList = []
+          let index = -1
+
+          while (++index < list.length) {
+            ;(shortcut.test(list[index]) ? classesList : classesFullList).push(
+              list[index]
+            )
+          }
+
+          classesFull =
+            classesFullList.length > 0
+              ? quoted('class', classesFullList.join(' '))
+              : ''
+          classes = classesList.length > 0 ? '.' + classesList.join('.') : ''
+        } else {
+          values.push(quoted(key, value))
+        }
+      }
+    }
+
+    if (classesFull) {
+      values.unshift(classesFull)
+    }
+
+    if (classes) {
+      values.unshift(classes)
+    }
+
+    if (id) {
+      values.unshift(id)
+    }
+
+    return values.length > 0 ? '{' + values.join(' ') + '}' : ''
+
+    /**
+     * @param {string} key
+     * @param {string} value
+     * @returns {string}
+     */
+    function quoted(key, value) {
+      return (
+        key +
+        (value
+          ? '=' +
+            appliedQuote +
+            stringifyEntitiesLight(value, {subset}) +
+            appliedQuote
+          : '')
+      )
+    }
+  }
 }
 
 /**
@@ -276,154 +433,11 @@ function exit(token) {
   this.exit(token)
 }
 
-/**
- * @type {ToMarkdownHandle}
- * @param {Directives} node
- */
-function handleDirective(node, _, state, info) {
-  const tracker = state.createTracker(info)
-  const sequence = fence(node)
-  const exit = state.enter(node.type)
-  let value = tracker.move(sequence + (node.name || ''))
-  /** @type {LeafDirective | Paragraph | TextDirective | undefined} */
-  let label
-
-  if (node.type === 'containerDirective') {
-    const head = (node.children || [])[0]
-    label = inlineDirectiveLabel(head) ? head : undefined
-  } else {
-    label = node
-  }
-
-  if (label && label.children && label.children.length > 0) {
-    const exit = state.enter('label')
-    /** @type {ConstructName} */
-    const labelType = `${node.type}Label`
-    const subexit = state.enter(labelType)
-    value += tracker.move('[')
-    value += tracker.move(
-      state.containerPhrasing(label, {
-        ...tracker.current(),
-        before: value,
-        after: ']'
-      })
-    )
-    value += tracker.move(']')
-    subexit()
-    exit()
-  }
-
-  value += tracker.move(attributes(node, state))
-
-  if (node.type === 'containerDirective') {
-    const head = (node.children || [])[0]
-    let shallow = node
-
-    if (inlineDirectiveLabel(head)) {
-      shallow = Object.assign({}, node, {children: node.children.slice(1)})
-    }
-
-    if (shallow && shallow.children && shallow.children.length > 0) {
-      value += tracker.move('\n')
-      value += tracker.move(state.containerFlow(shallow, tracker.current()))
-    }
-
-    value += tracker.move('\n' + sequence)
-  }
-
-  exit()
-  return value
-}
-
 /** @type {ToMarkdownHandle} */
 function peekDirective() {
   return ':'
 }
 
-/**
- * @param {Directives} node
- * @param {State} state
- * @returns {string}
- */
-function attributes(node, state) {
-  const quote = state.options.quote || '"'
-  const subset = node.type === 'textDirective' ? [quote] : [quote, '\n', '\r']
-  const attributes = node.attributes || {}
-  /** @type {Array<string>} */
-  const values = []
-  /** @type {string | undefined} */
-  let classesFull
-  /** @type {string | undefined} */
-  let classes
-  /** @type {string | undefined} */
-  let id
-  /** @type {string} */
-  let key
-
-  for (key in attributes) {
-    if (
-      own.call(attributes, key) &&
-      attributes[key] !== undefined &&
-      attributes[key] !== null
-    ) {
-      const value = String(attributes[key])
-
-      if (key === 'id') {
-        id = shortcut.test(value) ? '#' + value : quoted('id', value)
-      } else if (key === 'class') {
-        const list = value.split(/[\t\n\r ]+/g)
-        /** @type {Array<string>} */
-        const classesFullList = []
-        /** @type {Array<string>} */
-        const classesList = []
-        let index = -1
-
-        while (++index < list.length) {
-          ;(shortcut.test(list[index]) ? classesList : classesFullList).push(
-            list[index]
-          )
-        }
-
-        classesFull =
-          classesFullList.length > 0
-            ? quoted('class', classesFullList.join(' '))
-            : ''
-        classes = classesList.length > 0 ? '.' + classesList.join('.') : ''
-      } else {
-        values.push(quoted(key, value))
-      }
-    }
-  }
-
-  if (classesFull) {
-    values.unshift(classesFull)
-  }
-
-  if (classes) {
-    values.unshift(classes)
-  }
-
-  if (id) {
-    values.unshift(id)
-  }
-
-  return values.length > 0 ? '{' + values.join(' ') + '}' : ''
-
-  /**
-   * @param {string} key
-   * @param {string} value
-   * @returns {string}
-   */
-  function quoted(key, value) {
-    return (
-      key +
-      (value
-        ? '=' + quote + stringifyEntitiesLight(value, {subset}) + quote
-        : '')
-    )
-  }
-}
-
 /**
  * @param {Nodes} node
  * @returns {node is Paragraph & {data: {directiveLabel: true}}}