Change to expose functions

Author: wooorm

lib/index.js

@@ -11,29 +11,35 @@
 import {ok as assert} from 'devlop'
 import {defaultHandlers} from 'mdast-util-to-markdown'
 
-// To do: next major: replace exports with functions.
-
 /**
- * Extension for `mdast-util-from-markdown` to enable GFM task list items.
+ * Create an extension for `mdast-util-from-markdown` to enable GFM task
+ * list items in markdown.
  *
- * @type {FromMarkdownExtension}
+ * @returns {FromMarkdownExtension}
+ *   Extension for `mdast-util-from-markdown` to enable GFM task list items.
  */
-export const gfmTaskListItemFromMarkdown = {
-  exit: {
-    taskListCheckValueChecked: exitCheck,
-    taskListCheckValueUnchecked: exitCheck,
-    paragraph: exitParagraphWithTaskListItem
+export function gfmTaskListItemFromMarkdown() {
+  return {
+    exit: {
+      taskListCheckValueChecked: exitCheck,
+      taskListCheckValueUnchecked: exitCheck,
+      paragraph: exitParagraphWithTaskListItem
+    }
   }
 }
 
 /**
- * Extension for `mdast-util-to-markdown` to enable GFM task list items.
+ * Create an extension for `mdast-util-to-markdown` to enable GFM task list
+ * items in markdown.
  *
- * @type {ToMarkdownExtension}
+ * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable GFM task list items.
  */
-export const gfmTaskListItemToMarkdown = {
-  unsafe: [{atBreak: true, character: '-', after: '[:|-]'}],
-  handlers: {listItem: listItemWithTaskListItem}
+export function gfmTaskListItemToMarkdown() {
+  return {
+    unsafe: [{atBreak: true, character: '-', after: '[:|-]'}],
+    handlers: {listItem: listItemWithTaskListItem}
+  }
 }
 
 /**

readme.md

@@ -17,8 +17,8 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`gfmTaskListItemFromMarkdown`](#gfmtasklistitemfrommarkdown)
-    *   [`gfmTaskListItemToMarkdown`](#gfmtasklistitemtomarkdown)
+    *   [`gfmTaskListItemFromMarkdown()`](#gfmtasklistitemfrommarkdown)
+    *   [`gfmTaskListItemToMarkdown()`](#gfmtasklistitemtomarkdown)
 *   [HTML](#html)
 *   [Syntax](#syntax)
 *   [Syntax tree](#syntax-tree)
@@ -193,15 +193,25 @@ This package exports the identifiers
 [`gfmTaskListItemToMarkdown`][api-gfm-task-list-item-to-markdown].
 There is no default export.
 
-### `gfmTaskListItemFromMarkdown`
+### `gfmTaskListItemFromMarkdown()`
 
-Extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
-to enable GFM task lists ([`FromMarkdownExtension`][frommarkdownextension]).
+Create an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
+to enable GFM task list items in markdown.
 
-### `gfmTaskListItemToMarkdown`
+###### Returns
 
-Extension for [`mdast-util-to-markdown`][mdast-util-to-markdown]
-to enable GFM task lists ([`ToMarkdownExtension`][tomarkdownextension]).
+Extension for `mdast-util-from-markdown` to enable GFM task list items
+([`FromMarkdownExtension`][frommarkdownextension]).
+
+### `gfmTaskListItemToMarkdown()`
+
+Create an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to
+enable GFM task list items in markdown.
+
+###### Returns
+
+Extension for `mdast-util-to-markdown` to enable GFM task list items
+([`ToMarkdownExtension`][tomarkdownextension]).
 
 ## HTML
 

test.js

@@ -23,7 +23,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     assert.deepEqual(
       fromMarkdown('* [x] a', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       }),
       {
         type: 'root',
@@ -82,7 +82,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('*\n  [x] after a blank line', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -119,7 +119,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('* [x]\ttab', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -153,7 +153,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('* [x]: definition\n  [x] tasklist', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -197,7 +197,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('[x] tasklist', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -216,7 +216,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('* [x] *b*', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -255,7 +255,7 @@ test('gfmTaskListItemFromMarkdown', async function (t) {
     async function () {
       const tree = fromMarkdown('* [x] a\n\n  b', {
         extensions: [gfmTaskListItem()],
-        mdastExtensions: [gfmTaskListItemFromMarkdown]
+        mdastExtensions: [gfmTaskListItemFromMarkdown()]
       })
 
       removePosition(tree, {force: true})
@@ -297,7 +297,7 @@ test('gfmTaskListItemToMarkdown', async function (t) {
             {type: 'paragraph', children: [{type: 'text', value: 'a'}]}
           ]
         },
-        {extensions: [gfmTaskListItemToMarkdown]}
+        {extensions: [gfmTaskListItemToMarkdown()]}
       ),
       '* [x] a\n'
     )
@@ -313,7 +313,7 @@ test('gfmTaskListItemToMarkdown', async function (t) {
             {type: 'paragraph', children: [{type: 'text', value: 'b'}]}
           ]
         },
-        {extensions: [gfmTaskListItemToMarkdown]}
+        {extensions: [gfmTaskListItemToMarkdown()]}
       ),
       '* [ ] b\n'
     )
@@ -328,7 +328,7 @@ test('gfmTaskListItemToMarkdown', async function (t) {
             {type: 'paragraph', children: [{type: 'text', value: 'c'}]}
           ]
         },
-        {extensions: [gfmTaskListItemToMarkdown]}
+        {extensions: [gfmTaskListItemToMarkdown()]}
       ),
       '* c\n'
     )
@@ -353,7 +353,7 @@ test('gfmTaskListItemToMarkdown', async function (t) {
               {type: 'paragraph', children: [{type: 'text', value: 'e'}]}
             ]
           },
-          {extensions: [gfmTaskListItemToMarkdown]}
+          {extensions: [gfmTaskListItemToMarkdown()]}
         ),
         '* [d]: definition\n\n  e\n'
       )