Change to expose functions

micromark · Jun 25, 2023 · 6da41ea · 6da41ea
1 parent 2f4630f
commit 6da41ea
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 31 deletions.
diff --git a/dev/lib/html.js b/dev/lib/html.js
@@ -2,26 +2,28 @@
  * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
  */
 
-// To do: next major: expose function to make extension.
-
 /**
- * Extension for `micromark` that can be passed in `htmlExtensions` to
- * support GFM task list items when serializing to HTML.
+ * Create an HTML extension for `micromark` to support GFM task list items when
+ * serializing to HTML.
  *
- * @type {HtmlExtension}
+ * @returns {HtmlExtension}
+ *   Extension for `micromark` that can be passed in `htmlExtensions` to
+ *   support GFM task list items when serializing to HTML.
  */
-export const gfmTaskListItemHtml = {
-  enter: {
-    taskListCheck() {
-      this.tag('<input type="checkbox" disabled="" ')
-    }
-  },
-  exit: {
-    taskListCheck() {
-      this.tag('/>')
+export function gfmTaskListItemHtml() {
+  return {
+    enter: {
+      taskListCheck() {
+        this.tag('<input type="checkbox" disabled="" ')
+      }
     },
-    taskListCheckValueChecked() {
-      this.tag('checked="" ')
+    exit: {
+      taskListCheck() {
+        this.tag('/>')
+      },
+      taskListCheckValueChecked() {
+        this.tag('checked="" ')
+      }
     }
   }
 }
diff --git a/dev/lib/syntax.js b/dev/lib/syntax.js
@@ -17,16 +17,18 @@ import {types} from 'micromark-util-symbol/types.js'
 
 const tasklistCheck = {tokenize: tokenizeTasklistCheck}
 
-// To do: next major: expose function to make extension.
-
 /**
- * Extension for `micromark` that can be passed in `extensions`, to
- * enable GFM task list items syntax.
+ * Create an HTML extension for `micromark` to support GFM task list items
+ * syntax.
  *
- * @type {Extension}
+ * @returns {Extension}
+ *   Extension for `micromark` that can be passed in `extensions`, to enable
+ *   GFM task list items syntax.
  */
-export const gfmTaskListItem = {
-  text: {[codes.leftSquareBracket]: tasklistCheck}
+export function gfmTaskListItem() {
+  return {
+    text: {[codes.leftSquareBracket]: tasklistCheck}
+  }
 }
 
 /**

diff --git a/readme.md b/readme.md
@@ -83,8 +83,8 @@ import {
 } from 'micromark-extension-gfm-task-list-item'
 
 const output = micromark('* [x] a\n* [ ] b', {
-  extensions: [gfmTaskListItem],
-  htmlExtensions: [gfmTaskListItemHtml]
+  extensions: [gfmTaskListItem()],
+  htmlExtensions: [gfmTaskListItemHtml()]
 })
 
 console.log(output)

diff --git a/test/index.js b/test/index.js
@@ -22,8 +22,8 @@ test('markdown -> html (micromark)', async function (t) {
   await t.test('should not support laziness (1)', async function () {
     assert.deepEqual(
       micromark('*\n    [x]', {
-        extensions: [gfmTaskListItem],
-        htmlExtensions: [gfmTaskListItemHtml]
+        extensions: [gfmTaskListItem()],
+        htmlExtensions: [gfmTaskListItemHtml()]
       }),
       '<ul>\n<li>[x]</li>\n</ul>'
     )
@@ -32,8 +32,8 @@ test('markdown -> html (micromark)', async function (t) {
   await t.test('should not support laziness (2)', async function () {
     assert.deepEqual(
       micromark('*\n[x]', {
-        extensions: [gfmTaskListItem],
-        htmlExtensions: [gfmTaskListItemHtml]
+        extensions: [gfmTaskListItem()],
+        htmlExtensions: [gfmTaskListItemHtml()]
       }),
       '<ul>\n<li></li>\n</ul>\n<p>[x]</p>'
     )
@@ -62,8 +62,8 @@ test('fixtures', async function (t) {
       const input = String(await fs.readFile(new URL(d, base)))
       const expected = String(await fs.readFile(new URL(name + '.html', base)))
       let actual = micromark(controlPictures(input), {
-        extensions: [gfmTaskListItem],
-        htmlExtensions: [gfmTaskListItemHtml]
+        extensions: [gfmTaskListItem()],
+        htmlExtensions: [gfmTaskListItemHtml()]
       })
 
       if (actual && !/\n$/.test(actual)) {