Use ESM

Author: wooorm

.gitignore

@@ -1,6 +1,5 @@
-.DS_Store
-*.log
-.nyc_output/
 coverage/
 node_modules/
+.DS_Store
+*.log
 yarn.lock

.prettierignore

@@ -1,3 +1,2 @@
 coverage/
-*.json
 *.md

from-markdown.js

@@ -1,2 +1,74 @@
-exports.fromMarkdown = require('./from-markdown.js')
-exports.toMarkdown = require('./to-markdown.js')
+import defaultListItem from 'mdast-util-to-markdown/lib/handle/list-item.js'
+
+export const gfmTaskListItemFromMarkdown = {
+  exit: {
+    taskListCheckValueChecked: exitCheck,
+    taskListCheckValueUnchecked: exitCheck,
+    paragraph: exitParagraphWithTaskListItem
+  }
+}
+
+export const gfmTaskListItemToMarkdown = {
+  unsafe: [{atBreak: true, character: '-', after: '[:|-]'}],
+  handlers: {listItem: listItemWithTaskListItem}
+}
+
+function exitCheck(token) {
+  // We’re always in a paragraph, in a list item.
+  this.stack[this.stack.length - 2].checked =
+    token.type === 'taskListCheckValueChecked'
+}
+
+function exitParagraphWithTaskListItem(token) {
+  var parent = this.stack[this.stack.length - 2]
+  var node = this.stack[this.stack.length - 1]
+  var siblings = parent.children
+  var head = node.children[0]
+  var index = -1
+  var firstParaghraph
+
+  if (
+    parent &&
+    parent.type === 'listItem' &&
+    typeof parent.checked === 'boolean' &&
+    head &&
+    head.type === 'text'
+  ) {
+    while (++index < siblings.length) {
+      if (siblings[index].type === 'paragraph') {
+        firstParaghraph = siblings[index]
+        break
+      }
+    }
+
+    if (firstParaghraph === node) {
+      // Must start with a space or a tab.
+      head.value = head.value.slice(1)
+
+      if (head.value.length === 0) {
+        node.children.shift()
+      } else {
+        head.position.start.column++
+        head.position.start.offset++
+        node.position.start = Object.assign({}, head.position.start)
+      }
+    }
+  }
+
+  this.exit(token)
+}
+
+function listItemWithTaskListItem(node, parent, context) {
+  var value = defaultListItem(node, parent, context)
+  var head = node.children[0]
+
+  if (typeof node.checked === 'boolean' && head && head.type === 'paragraph') {
+    value = value.replace(/^(?:[*+-]|\d+\.)([\r\n]| {1,3})/, check)
+  }
+
+  return value
+
+  function check($0) {
+    return $0 + '[' + (node.checked ? 'x' : ' ') + '] '
+  }
+}

index.js

@@ -29,37 +29,32 @@
   "contributors": [
     "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
-    "from-markdown.js",
-    "index.js",
-    "to-markdown.js"
+    "index.js"
   ],
   "dependencies": {
     "mdast-util-to-markdown": "~0.6.0"
   },
   "devDependencies": {
+    "c8": "^7.7.3",
     "mdast-util-from-markdown": "^0.8.0",
     "micromark-extension-gfm-task-list-item": "^0.3.0",
-    "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
     "tape": "^5.0.0",
-    "unist-util-remove-position": "^3.0.0",
-    "xo": "^0.38.0"
+    "unist-util-remove-position": "^4.0.0",
+    "xo": "^0.39.0"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test.js",
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js",
     "test": "npm run format && npm run test-coverage"
   },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
-  },
   "prettier": {
     "tabWidth": 2,
     "useTabs": false,
@@ -70,8 +65,9 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
+      "no-var": "off",
+      "prefer-arrow-callback": "off",
       "unicorn/prefer-includes": "off"
     }
   },

package.json

@@ -19,6 +19,9 @@ You probably shouldn’t use this package directly, but instead use
 
 ## Install
 
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
+Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
+
 [npm][]:
 
 ```sh
@@ -129,13 +132,13 @@ brevity):
 
 ## API
 
-### `taskListItem.fromMarkdown`
+This package exports the following identifier: `gfmTaskListItemFromMarkdown`,
+`gfmTaskListItemToMarkdown`.
+There is no default export.
 
-### `taskListItem.toMarkdown`
+### `gfmTaskListItemFromMarkdown`
 
-> Note: the separate extensions are also available at
-> `mdast-util-gfm-task-list-item/from-markdown` and
-> `mdast-util-gfm-task-list-item/to-markdown`.
+### `gfmTaskListItemToMarkdown`
 
 Support task list items.
 The exports are extensions, respectively

readme.md

@@ -1,15 +1,18 @@
-var test = require('tape')
-var fromMarkdown = require('mdast-util-from-markdown')
-var toMarkdown = require('mdast-util-to-markdown')
-var removePosition = require('unist-util-remove-position')
-var syntax = require('micromark-extension-gfm-task-list-item')
-var taskListItem = require('.')
+import test from 'tape'
+import fromMarkdown from 'mdast-util-from-markdown'
+import toMarkdown from 'mdast-util-to-markdown'
+import {removePosition} from 'unist-util-remove-position'
+import gfmTaskListItem from 'micromark-extension-gfm-task-list-item'
+import {
+  gfmTaskListItemFromMarkdown,
+  gfmTaskListItemToMarkdown
+} from './index.js'
 
 test('markdown -> mdast', function (t) {
   t.deepEqual(
     fromMarkdown('* [x] a', {
-      extensions: [syntax],
-      mdastExtensions: [taskListItem.fromMarkdown]
+      extensions: [gfmTaskListItem],
+      mdastExtensions: [gfmTaskListItemFromMarkdown]
     }),
     {
       type: 'root',
@@ -66,8 +69,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('*\n  [x] after a blank line', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0].children[0],
@@ -88,8 +91,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('* [x]\ttab', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0].children[0],
@@ -105,8 +108,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('* [x]: definition\n  [x] tasklist', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0].children[0],
@@ -131,8 +134,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('[x] tasklist', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0],
@@ -143,8 +146,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('* [x] *b*', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0].children[0],
@@ -165,8 +168,8 @@ test('markdown -> mdast', function (t) {
   t.deepEqual(
     removePosition(
       fromMarkdown('* [x] a\n\n  b', {
-        extensions: [syntax],
-        mdastExtensions: [taskListItem.fromMarkdown]
+        extensions: [gfmTaskListItem],
+        mdastExtensions: [gfmTaskListItemFromMarkdown]
       }),
       true
     ).children[0].children[0],
@@ -199,7 +202,7 @@ test('mdast -> markdown', function (t) {
         checked: true,
         children: [{type: 'paragraph', children: [{type: 'text', value: 'a'}]}]
       },
-      {extensions: [taskListItem.toMarkdown]}
+      {extensions: [gfmTaskListItemToMarkdown]}
     ),
     '*   [x] a\n',
     'should serialize a checked list item'
@@ -212,7 +215,7 @@ test('mdast -> markdown', function (t) {
         checked: false,
         children: [{type: 'paragraph', children: [{type: 'text', value: 'b'}]}]
       },
-      {extensions: [taskListItem.toMarkdown]}
+      {extensions: [gfmTaskListItemToMarkdown]}
     ),
     '*   [ ] b\n',
     'should serialize an unchecked list item'
@@ -224,7 +227,7 @@ test('mdast -> markdown', function (t) {
         type: 'listItem',
         children: [{type: 'paragraph', children: [{type: 'text', value: 'c'}]}]
       },
-      {extensions: [taskListItem.toMarkdown]}
+      {extensions: [gfmTaskListItemToMarkdown]}
     ),
     '*   c\n',
     'should serialize an normal list item'
@@ -245,7 +248,7 @@ test('mdast -> markdown', function (t) {
           {type: 'paragraph', children: [{type: 'text', value: 'e'}]}
         ]
       },
-      {extensions: [taskListItem.toMarkdown]}
+      {extensions: [gfmTaskListItemToMarkdown]}
     ),
     '*   [d]: definition\n\n    e\n',
     'should ignore `checked` if the head is not a paragraph'