Use ESM

Author: wooorm

.gitignore

@@ -1,4 +1,3 @@
-.nyc_output/
 coverage/
 node_modules/
 *.log

.prettierignore

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

from-markdown.js

@@ -1,2 +1,46 @@
-exports.fromMarkdown = require('./from-markdown.js')
-exports.toMarkdown = require('./to-markdown.js')
+import mdxExpressionFromMarkdown from 'mdast-util-mdx-expression/from-markdown.js'
+import mdxExpressionToMarkdown from 'mdast-util-mdx-expression/to-markdown.js'
+import mdxJsxFromMarkdown from 'mdast-util-mdx-jsx/from-markdown.js'
+import mdxJsxToMarkdown from 'mdast-util-mdx-jsx/to-markdown.js'
+import mdxjsEsmFromMarkdown from 'mdast-util-mdxjs-esm/from-markdown.js'
+import mdxjsEsmToMarkdown from 'mdast-util-mdxjs-esm/to-markdown.js'
+
+var own = {}.hasOwnProperty
+
+export const mdxFromMarkdown = configure([
+  mdxExpressionFromMarkdown,
+  mdxJsxFromMarkdown,
+  mdxjsEsmFromMarkdown
+])
+
+function configure(extensions) {
+  var config = {canContainEols: []}
+  var index = -1
+
+  while (++index < extensions.length) {
+    extension(config, extensions[index])
+  }
+
+  return config
+}
+
+function extension(config, extension) {
+  var key
+  var left
+  var right
+
+  for (key in extension) {
+    left = own.call(config, key) ? config[key] : (config[key] = {})
+    right = extension[key]
+
+    if (key === 'canContainEols') {
+      config[key] = [].concat(left, right)
+    } else {
+      Object.assign(left, right)
+    }
+  }
+}
+
+export const mdxToMarkdown = {
+  extensions: [mdxExpressionToMarkdown, mdxJsxToMarkdown, mdxjsEsmToMarkdown]
+}

index.js

@@ -27,40 +27,34 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
-    "from-markdown.js",
-    "index.js",
-    "to-markdown.js"
+    "index.js"
   ],
   "dependencies": {
     "mdast-util-mdx-expression": "~0.1.0",
     "mdast-util-mdx-jsx": "~0.1.0",
-    "mdast-util-mdxjs-esm": "~0.1.0",
-    "mdast-util-to-markdown": "^0.6.1"
+    "mdast-util-mdxjs-esm": "~0.1.0"
   },
   "devDependencies": {
+    "c8": "^7.0.0",
     "mdast-util-from-markdown": "^0.8.0",
     "micromark-extension-mdx": "^0.2.0",
     "micromark-extension-mdxjs": "^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",
-    "xo": "^0.38.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,
@@ -71,8 +65,9 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
+      "no-var": "off",
+      "prefer-arrow-callback": "off",
       "guard-for-in": "off",
       "unicorn/prefer-optional-catch-binding": "off"
     }

package.json

@@ -28,6 +28,9 @@ Alternatively, the extensions can be used separately:
 
 ## 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
@@ -219,17 +222,17 @@ Which you can also put inline: {1+1}.
 
 ## API
 
-### `mdx.fromMarkdown`
+This package exports the following identifier: `mdxFromMarkdown`,
+`mdxToMarkdown`.
+There is no default export.
 
-### `mdx.toMarkdown`
+### `mdxFromMarkdown`
 
-> Note: the separate extensions are also available at
-> `mdast-util-mdx/from-markdown` and `mdast-util-mdx/to-markdown`.
+### `mdxToMarkdown`
 
 Support MDX (or MDX.js).
-The exports of `fromMarkdown` is an extension for
-[`mdast-util-from-markdown`][from-markdown].
-The export of `toMarkdown` is an extension for
+The exports are respectively an extension for
+[`mdast-util-from-markdown`][from-markdown] and
 [`mdast-util-to-markdown`][to-markdown].
 
 There are no options.

readme.md

@@ -1,16 +1,16 @@
-var test = require('tape')
-var fromMarkdown = require('mdast-util-from-markdown')
-var toMarkdown = require('mdast-util-to-markdown')
-var syntax = require('micromark-extension-mdxjs')
-var mdx = require('.')
+import test from 'tape'
+import fromMarkdown from 'mdast-util-from-markdown'
+import toMarkdown from 'mdast-util-to-markdown'
+import mdxjs from 'micromark-extension-mdxjs'
+import {mdxFromMarkdown, mdxToMarkdown} from './index.js'
 
 test('markdown -> mdast', function (t) {
   t.deepEqual(
     JSON.parse(
       JSON.stringify(
         fromMarkdown('import a from "b"', {
-          extensions: [syntax()],
-          mdastExtensions: [mdx.fromMarkdown]
+          extensions: [mdxjs()],
+          mdastExtensions: [mdxFromMarkdown]
         })
       )
     ),
@@ -94,8 +94,8 @@ test('markdown -> mdast', function (t) {
 
   t.deepEqual(
     fromMarkdown('<x/>', {
-      extensions: [syntax()],
-      mdastExtensions: [mdx.fromMarkdown]
+      extensions: [mdxjs()],
+      mdastExtensions: [mdxFromMarkdown]
     }),
     {
       type: 'root',
@@ -123,8 +123,8 @@ test('markdown -> mdast', function (t) {
     JSON.parse(
       JSON.stringify(
         fromMarkdown('{1 + 1}', {
-          extensions: [syntax()],
-          mdastExtensions: [mdx.fromMarkdown]
+          extensions: [mdxjs()],
+          mdastExtensions: [mdxFromMarkdown]
         })
       )
     ),
@@ -210,7 +210,7 @@ test('mdast -> markdown', function (t) {
   t.equal(
     toMarkdown(
       {type: 'mdxjsEsm', value: 'import a from "b"'},
-      {extensions: [mdx.toMarkdown]}
+      {extensions: [mdxToMarkdown]}
     ),
     'import a from "b"\n',
     'should support esm'
@@ -219,7 +219,7 @@ test('mdast -> markdown', function (t) {
   t.equal(
     toMarkdown(
       {type: 'mdxJsxFlowElement', name: 'x'},
-      {extensions: [mdx.toMarkdown]}
+      {extensions: [mdxToMarkdown]}
     ),
     '<x/>\n',
     'should support jsx'
@@ -228,7 +228,7 @@ test('mdast -> markdown', function (t) {
   t.deepEqual(
     toMarkdown(
       {type: 'mdxFlowExpression', value: '1 + 1'},
-      {extensions: [mdx.toMarkdown]}
+      {extensions: [mdxToMarkdown]}
     ),
     '{1 + 1}\n',
     'should support expressions'
@@ -241,7 +241,7 @@ test('mdast -> markdown', function (t) {
         url: 'tel:123',
         children: [{type: 'text', value: 'tel:123'}]
       },
-      {extensions: [mdx.toMarkdown]}
+      {extensions: [mdxToMarkdown]}
     ),
     '[tel:123](tel:123)\n',
     'should use link (resource) instead of link (auto)'