Change to expose functions

Author: wooorm

lib/index.js

@@ -10,8 +10,6 @@
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  */
 
-// To do: next major: expose functions.
-
 /**
  * List of constructs that occur in phrasing (paragraphs, headings), but cannot
  * contain strikethrough.
@@ -34,30 +32,38 @@ const constructsWithoutStrikethrough = [
 handleDelete.peek = peekDelete
 
 /**
- * Extension for `mdast-util-from-markdown` to enable GFM strikethrough.
+ * Create an extension for `mdast-util-from-markdown` to enable GFM
+ * strikethrough in markdown.
  *
- * @type {FromMarkdownExtension}
+ * @returns {FromMarkdownExtension}
+ *   Extension for `mdast-util-from-markdown` to enable GFM strikethrough.
  */
-export const gfmStrikethroughFromMarkdown = {
-  canContainEols: ['delete'],
-  enter: {strikethrough: enterStrikethrough},
-  exit: {strikethrough: exitStrikethrough}
+export function gfmStrikethroughFromMarkdown() {
+  return {
+    canContainEols: ['delete'],
+    enter: {strikethrough: enterStrikethrough},
+    exit: {strikethrough: exitStrikethrough}
+  }
 }
 
 /**
- * Extension for `mdast-util-to-markdown` to enable GFM strikethrough.
+ * Create an extension for `mdast-util-to-markdown` to enable GFM
+ * strikethrough in markdown.
  *
- * @type {ToMarkdownExtension}
+ * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable GFM strikethrough.
  */
-export const gfmStrikethroughToMarkdown = {
-  unsafe: [
-    {
-      character: '~',
-      inConstruct: 'phrasing',
-      notInConstruct: constructsWithoutStrikethrough
-    }
-  ],
-  handlers: {delete: handleDelete}
+export function gfmStrikethroughToMarkdown() {
+  return {
+    unsafe: [
+      {
+        character: '~',
+        inConstruct: 'phrasing',
+        notInConstruct: constructsWithoutStrikethrough
+      }
+    ],
+    handlers: {delete: handleDelete}
+  }
 }
 
 /**

readme.md

@@ -17,8 +17,8 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`gfmStrikethroughFromMarkdown`](#gfmstrikethroughfrommarkdown)
-    *   [`gfmStrikethroughToMarkdown`](#gfmstrikethroughtomarkdown)
+    *   [`gfmStrikethroughFromMarkdown()`](#gfmstrikethroughfrommarkdown)
+    *   [`gfmStrikethroughToMarkdown()`](#gfmstrikethroughtomarkdown)
 *   [HTML](#html)
 *   [Syntax](#syntax)
 *   [Syntax tree](#syntax-tree)
@@ -106,12 +106,12 @@ const doc = await fs.readFile('example.md')
 
 const tree = fromMarkdown(doc, {
   extensions: [gfmStrikethrough()],
-  mdastExtensions: [gfmStrikethroughFromMarkdown]
+  mdastExtensions: [gfmStrikethroughFromMarkdown()]
 })
 
 console.log(tree)
 
-const out = toMarkdown(tree, {extensions: [gfmStrikethroughToMarkdown]})
+const out = toMarkdown(tree, {extensions: [gfmStrikethroughToMarkdown()]})
 
 console.log(out)
 ```
@@ -148,15 +148,25 @@ This package exports the identifiers
 [`gfmStrikethroughToMarkdown`][api-gfm-strikethrough-to-markdown].
 There is no default export.
 
-### `gfmStrikethroughFromMarkdown`
+### `gfmStrikethroughFromMarkdown()`
 
-Extension for [`mdast-util-from-markdown`][mdast-util-from-markdown] to enable
-GFM strikethrough ([`FromMarkdownExtension`][from-markdown-extension]).
+Create an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
+to enable GFM strikethrough in markdown.
 
-### `gfmStrikethroughToMarkdown`
+###### Returns
 
-Extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to enable
-GFM strikethrough ([`ToMarkdownExtension`][to-markdown-extension]).
+Extension for `mdast-util-from-markdown` to enable GFM strikethrough
+([`FromMarkdownExtension`][from-markdown-extension]).
+
+### `gfmStrikethroughToMarkdown()`
+
+Create an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to
+enable GFM strikethrough in markdown.
+
+###### Returns
+
+Extension for `mdast-util-to-markdown` to enable GFM strikethrough
+([`ToMarkdownExtension`][to-markdown-extension]).
 
 ## HTML
 

test.js

@@ -18,11 +18,11 @@ test('core', async function (t) {
   })
 })
 
-test('gfmStrikethroughFromMarkdown', async function (t) {
+test('gfmStrikethroughFromMarkdown()', async function (t) {
   await t.test('should support strikethrough', async function () {
     const tree = fromMarkdown('a ~~b~~ c.', {
       extensions: [gfmStrikethrough()],
-      mdastExtensions: [gfmStrikethroughFromMarkdown]
+      mdastExtensions: [gfmStrikethroughFromMarkdown()]
     })
 
     removePosition(tree, {force: true})
@@ -45,7 +45,7 @@ test('gfmStrikethroughFromMarkdown', async function (t) {
   await t.test('should support strikethrough w/ eols', async function () {
     const tree = fromMarkdown('a ~~b\nc~~ d.', {
       extensions: [gfmStrikethrough()],
-      mdastExtensions: [gfmStrikethroughFromMarkdown]
+      mdastExtensions: [gfmStrikethroughFromMarkdown()]
     })
 
     removePosition(tree, {force: true})
@@ -66,7 +66,7 @@ test('gfmStrikethroughFromMarkdown', async function (t) {
   })
 })
 
-test('gfmStrikethroughToMarkdown', async function (t) {
+test('gfmStrikethroughToMarkdown()', async function (t) {
   await t.test('should serialize strikethrough', async function () {
     assert.deepEqual(
       toMarkdown(
@@ -78,7 +78,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
             {type: 'text', value: ' c.'}
           ]
         },
-        {extensions: [gfmStrikethroughToMarkdown]}
+        {extensions: [gfmStrikethroughToMarkdown()]}
       ),
       'a ~~b~~ c.\n'
     )
@@ -95,7 +95,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
             {type: 'text', value: ' d.'}
           ]
         },
-        {extensions: [gfmStrikethroughToMarkdown]}
+        {extensions: [gfmStrikethroughToMarkdown()]}
       ),
       'a ~~b\nc~~ d.\n'
     )
@@ -116,7 +116,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
               }
             ]
           },
-          {extensions: [gfmStrikethroughToMarkdown]}
+          {extensions: [gfmStrikethroughToMarkdown()]}
         ),
         '[](~a)\n'
       )
@@ -138,7 +138,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
               }
             ]
           },
-          {extensions: [gfmStrikethroughToMarkdown]}
+          {extensions: [gfmStrikethroughToMarkdown()]}
         ),
         '[link text](~a)\n'
       )
@@ -159,7 +159,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
             }
           ]
         },
-        {extensions: [gfmStrikethroughToMarkdown]}
+        {extensions: [gfmStrikethroughToMarkdown()]}
       ),
       '[][~a]\n'
     )
@@ -181,7 +181,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
               }
             ]
           },
-          {extensions: [gfmStrikethroughToMarkdown]}
+          {extensions: [gfmStrikethroughToMarkdown()]}
         ),
         '[](# "~a")\n'
       )
@@ -206,7 +206,7 @@ test('gfmStrikethroughToMarkdown', async function (t) {
           },
           {
             quote: "'",
-            extensions: [gfmStrikethroughToMarkdown]
+            extensions: [gfmStrikethroughToMarkdown()]
           }
         ),
         "[](# '~a')\n"