Change to expose functions

Author: wooorm

lib/index.js

@@ -22,87 +22,93 @@ import {parseEntities} from 'parse-entities'
 import {stringifyEntitiesLight} from 'stringify-entities'
 import {visitParents} from 'unist-util-visit-parents'
 
-// To do: next major: expose functions.
-
 const own = {}.hasOwnProperty
 
 const shortcut = /^[^\t\n\r "#'.<=>`}]+$/
 
 handleDirective.peek = peekDirective
 
 /**
- * Extension for `mdast-util-from-markdown` to enable directives.
+ * Create an extension for `mdast-util-from-markdown` to enable directives in
+ * markdown.
  *
- * @type {FromMarkdownExtension}
+ * @returns {FromMarkdownExtension}
+ *   Extension for `mdast-util-from-markdown` to enable directives.
  */
-export const directiveFromMarkdown = {
-  canContainEols: ['textDirective'],
-  enter: {
-    directiveContainer: enterContainer,
-    directiveContainerAttributes: enterAttributes,
-    directiveContainerLabel: enterContainerLabel,
-
-    directiveLeaf: enterLeaf,
-    directiveLeafAttributes: enterAttributes,
-
-    directiveText: enterText,
-    directiveTextAttributes: enterAttributes
-  },
-  exit: {
-    directiveContainer: exit,
-    directiveContainerAttributeClassValue: exitAttributeClassValue,
-    directiveContainerAttributeIdValue: exitAttributeIdValue,
-    directiveContainerAttributeName: exitAttributeName,
-    directiveContainerAttributeValue: exitAttributeValue,
-    directiveContainerAttributes: exitAttributes,
-    directiveContainerLabel: exitContainerLabel,
-    directiveContainerName: exitName,
-
-    directiveLeaf: exit,
-    directiveLeafAttributeClassValue: exitAttributeClassValue,
-    directiveLeafAttributeIdValue: exitAttributeIdValue,
-    directiveLeafAttributeName: exitAttributeName,
-    directiveLeafAttributeValue: exitAttributeValue,
-    directiveLeafAttributes: exitAttributes,
-    directiveLeafName: exitName,
-
-    directiveText: exit,
-    directiveTextAttributeClassValue: exitAttributeClassValue,
-    directiveTextAttributeIdValue: exitAttributeIdValue,
-    directiveTextAttributeName: exitAttributeName,
-    directiveTextAttributeValue: exitAttributeValue,
-    directiveTextAttributes: exitAttributes,
-    directiveTextName: exitName
+export function directiveFromMarkdown() {
+  return {
+    canContainEols: ['textDirective'],
+    enter: {
+      directiveContainer: enterContainer,
+      directiveContainerAttributes: enterAttributes,
+      directiveContainerLabel: enterContainerLabel,
+
+      directiveLeaf: enterLeaf,
+      directiveLeafAttributes: enterAttributes,
+
+      directiveText: enterText,
+      directiveTextAttributes: enterAttributes
+    },
+    exit: {
+      directiveContainer: exit,
+      directiveContainerAttributeClassValue: exitAttributeClassValue,
+      directiveContainerAttributeIdValue: exitAttributeIdValue,
+      directiveContainerAttributeName: exitAttributeName,
+      directiveContainerAttributeValue: exitAttributeValue,
+      directiveContainerAttributes: exitAttributes,
+      directiveContainerLabel: exitContainerLabel,
+      directiveContainerName: exitName,
+
+      directiveLeaf: exit,
+      directiveLeafAttributeClassValue: exitAttributeClassValue,
+      directiveLeafAttributeIdValue: exitAttributeIdValue,
+      directiveLeafAttributeName: exitAttributeName,
+      directiveLeafAttributeValue: exitAttributeValue,
+      directiveLeafAttributes: exitAttributes,
+      directiveLeafName: exitName,
+
+      directiveText: exit,
+      directiveTextAttributeClassValue: exitAttributeClassValue,
+      directiveTextAttributeIdValue: exitAttributeIdValue,
+      directiveTextAttributeName: exitAttributeName,
+      directiveTextAttributeValue: exitAttributeValue,
+      directiveTextAttributes: exitAttributes,
+      directiveTextName: exitName
+    }
   }
 }
 
 /**
- * Extension for `mdast-util-to-markdown` to enable directives.
+ * Create an extension for `mdast-util-to-markdown` to enable directives in
+ * markdown.
  *
- * @type {ToMarkdownExtension}
+ * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable directives.
  */
-export const directiveToMarkdown = {
-  unsafe: [
-    {
-      character: '\r',
-      inConstruct: ['leafDirectiveLabel', 'containerDirectiveLabel']
-    },
-    {
-      character: '\n',
-      inConstruct: ['leafDirectiveLabel', 'containerDirectiveLabel']
-    },
-    {
-      before: '[^:]',
-      character: ':',
-      after: '[A-Za-z]',
-      inConstruct: ['phrasing']
-    },
-    {atBreak: true, character: ':', after: ':'}
-  ],
-  handlers: {
-    containerDirective: handleDirective,
-    leafDirective: handleDirective,
-    textDirective: handleDirective
+export function directiveToMarkdown() {
+  return {
+    unsafe: [
+      {
+        character: '\r',
+        inConstruct: ['leafDirectiveLabel', 'containerDirectiveLabel']
+      },
+      {
+        character: '\n',
+        inConstruct: ['leafDirectiveLabel', 'containerDirectiveLabel']
+      },
+      {
+        before: '[^:]',
+        character: ':',
+        after: '[A-Za-z]',
+        inConstruct: ['phrasing']
+      },
+      {atBreak: true, character: ':', after: ':'}
+    ],
+    handlers: {
+      containerDirective: handleDirective,
+      leafDirective: handleDirective,
+      textDirective: handleDirective
+    }
   }
 }
 

readme.md

@@ -19,8 +19,8 @@ such).
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`directiveFromMarkdown`](#directivefrommarkdown)
-    *   [`directiveToMarkdown`](#directivetomarkdown)
+    *   [`directiveFromMarkdown()`](#directivefrommarkdown)
+    *   [`directiveToMarkdown()`](#directivetomarkdown)
     *   [`ContainerDirective`](#containerdirective)
     *   [`Directives`](#directives)
     *   [`LeafDirective`](#leafdirective)
@@ -123,12 +123,12 @@ const doc = await fs.readFile('example.md')
 
 const tree = fromMarkdown(doc, {
   extensions: [directive()],
-  mdastExtensions: [directiveFromMarkdown]
+  mdastExtensions: [directiveFromMarkdown()]
 })
 
 console.log(tree)
 
-const out = toMarkdown(tree, {extensions: [directiveToMarkdown]})
+const out = toMarkdown(tree, {extensions: [directiveToMarkdown()]})
 
 console.log(out)
 ```
@@ -167,19 +167,29 @@ This package exports the identifiers
 [`directiveToMarkdown`][api-directive-to-markdown].
 There is no default export.
 
-### `directiveFromMarkdown`
+### `directiveFromMarkdown()`
 
-Extension for [`mdast-util-from-markdown`][mdast-util-from-markdown] to enable
-directives ([`FromMarkdownExtension`][from-markdown-extension]).
+Create an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
+to enable directives in markdown.
 
-### `directiveToMarkdown`
+###### Returns
 
-Extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to enable
-directives ([`ToMarkdownExtension`][to-markdown-extension]).
+Extension for `mdast-util-from-markdown` to enable directives
+([`FromMarkdownExtension`][from-markdown-extension]).
+
+### `directiveToMarkdown()`
+
+Create an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown]
+to enable directives in markdown.
 
 There are no options, but passing [`options.quote`][quote] to
 `mdast-util-to-markdown` is honored for attributes.
 
+###### Returns
+
+Extension for `mdast-util-to-markdown` to enable directives
+([`ToMarkdownExtension`][to-markdown-extension]).
+
 ### `ContainerDirective`
 
 Directive in flow content (such as in the root document, or block quotes),