Change to expose functions

Author: wooorm

lib/index.js

@@ -13,24 +13,32 @@
 import {ok as assert} from 'devlop'
 
 /**
- * Extension for `mdast-util-from-markdown` to enable MDX ESM.
+ * Create an extension for `mdast-util-from-markdown` to enable MDX.js ESM in
+ * markdown.
  *
- * When using the syntax extension with `addResult`, nodes will have a
- * `data.estree` field set to an ESTree `Program` node.
+ * When using the micromark syntax extension with `addResult`, nodes will have
+ * a `data.estree` field set to an ESTree [`Program`][program] node.
  *
- * @type {FromMarkdownExtension}
+ * @returns {FromMarkdownExtension}
+ *   Extension for `mdast-util-from-markdown` to enable MDX.js ESM.
  */
-export const mdxjsEsmFromMarkdown = {
-  enter: {mdxjsEsm: enterMdxjsEsm},
-  exit: {mdxjsEsm: exitMdxjsEsm, mdxjsEsmData: exitMdxjsEsmData}
+export function mdxjsEsmFromMarkdown() {
+  return {
+    enter: {mdxjsEsm: enterMdxjsEsm},
+    exit: {mdxjsEsm: exitMdxjsEsm, mdxjsEsmData: exitMdxjsEsmData}
+  }
 }
 
 /**
- * Extension for `mdast-util-to-markdown` to enable MDX ESM.
+ * Create an extension for `mdast-util-to-markdown` to enable MDX.js ESM in
+ * markdown.
  *
- * @type {ToMarkdownExtension}
+ * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable MDX.js ESM.
  */
-export const mdxjsEsmToMarkdown = {handlers: {mdxjsEsm: handleMdxjsEsm}}
+export function mdxjsEsmToMarkdown() {
+  return {handlers: {mdxjsEsm: handleMdxjsEsm}}
+}
 
 /**
  * @this {CompileContext}

readme.md

@@ -17,8 +17,8 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`mdxjsEsmFromMarkdown`](#mdxjsesmfrommarkdown)
-    *   [`mdxjsEsmToMarkdown`](#mdxjsesmtomarkdown)
+    *   [`mdxjsEsmFromMarkdown()`](#mdxjsesmfrommarkdown)
+    *   [`mdxjsEsmToMarkdown()`](#mdxjsesmtomarkdown)
     *   [`MdxjsEsm`](#mdxjsesm)
     *   [`MdxjsEsmHast`](#mdxjsesmhast)
 *   [HTML](#html)
@@ -105,12 +105,12 @@ const doc = await fs.readFile('example.mdx')
 
 const tree = fromMarkdown(doc, {
   extensions: [mdxjsEsm({acorn, addResult: true})],
-  mdastExtensions: [mdxjsEsmFromMarkdown]
+  mdastExtensions: [mdxjsEsmFromMarkdown()]
 })
 
 console.log(tree)
 
-const out = toMarkdown(tree, {extensions: [mdxjsEsmToMarkdown]})
+const out = toMarkdown(tree, {extensions: [mdxjsEsmToMarkdown()]})
 
 console.log(out)
 ```
@@ -178,18 +178,28 @@ This package exports the identifiers
 [`mdxjsEsmToMarkdown`][api-mdxjs-esm-to-markdown].
 There is no default export.
 
-### `mdxjsEsmFromMarkdown`
+### `mdxjsEsmFromMarkdown()`
 
-Extension for [`mdast-util-from-markdown`][mdast-util-from-markdown] to enable
-MDX ESM.
+Create an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
+to enable MDX.js ESM in markdown.
 
 When using the [micromark syntax extension][extension] with `addResult`, nodes
 will have a `data.estree` field set to an ESTree [`Program`][program] node.
 
-### `mdxjsEsmToMarkdown`
+###### Returns
 
-Extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to enable MDX
-ESM.
+Extension for `mdast-util-from-markdown` to enable MDX.js ESM
+([`FromMarkdownExtension`][from-markdown-extension]).
+
+### `mdxjsEsmToMarkdown()`
+
+Create an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown]
+to enable MDX.js ESM in markdown.
+
+###### Returns
+
+Extension for `mdast-util-to-markdown` to enable MDX.js ESM
+([`ToMarkdownExtension`][to-markdown-extension]).
 
 ### `MdxjsEsm`
 
@@ -412,6 +422,10 @@ abide by its terms.
 
 [mdx]: https://mdxjs.com
 
+[from-markdown-extension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
+
+[to-markdown-extension]: https://github.com/syntax-tree/mdast-util-to-markdown#options
+
 [dfn-flow-content]: #flowcontent-mdxjs-esm
 
 [api-mdxjs-esm-from-markdown]: #mdxjsesmfrommarkdown

test.js

@@ -16,12 +16,12 @@ test('core', async function (t) {
   })
 })
 
-test('mdxjsEsmFromMarkdown', async function (t) {
+test('mdxjsEsmFromMarkdown()', async function (t) {
   await t.test('should support ESM', async function () {
     assert.deepEqual(
       fromMarkdown('import a from "b"\nexport var c = ""\n\nd', {
         extensions: [mdxjsEsm({acorn})],
-        mdastExtensions: [mdxjsEsmFromMarkdown]
+        mdastExtensions: [mdxjsEsmFromMarkdown()]
       }),
       {
         type: 'root',
@@ -65,7 +65,7 @@ test('mdxjsEsmFromMarkdown', async function (t) {
     async function () {
       let tree = fromMarkdown('import a from "b"\nexport var c = ""\n\nd', {
         extensions: [mdxjsEsm({acorn, addResult: true})],
-        mdastExtensions: [mdxjsEsmFromMarkdown]
+        mdastExtensions: [mdxjsEsmFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -206,7 +206,7 @@ test('mdxjsEsmFromMarkdown', async function (t) {
   )
 })
 
-test('mdxjsEsmToMarkdown', async function (t) {
+test('mdxjsEsmToMarkdown()', async function (t) {
   await t.test('should serialize ESM', async function () {
     assert.deepEqual(
       toMarkdown(
@@ -217,7 +217,7 @@ test('mdxjsEsmToMarkdown', async function (t) {
             {type: 'paragraph', children: [{type: 'text', value: 'd'}]}
           ]
         },
-        {extensions: [mdxjsEsmToMarkdown]}
+        {extensions: [mdxjsEsmToMarkdown()]}
       ),
       'import a from "b"\nexport var c = ""\n\nd\n'
     )
@@ -234,7 +234,7 @@ test('mdxjsEsmToMarkdown', async function (t) {
             {type: 'paragraph', children: [{type: 'text', value: 'd'}]}
           ]
         },
-        {extensions: [mdxjsEsmToMarkdown]}
+        {extensions: [mdxjsEsmToMarkdown()]}
       ),
       '\n\nd\n'
     )