Use ESM

Author: wooorm

.gitignore

@@ -1,8 +1,5 @@
 .DS_Store
 *.log
-.nyc_output/
 coverage/
 node_modules/
-mdast-util-heading-range.js
-mdast-util-heading-range.min.js
 yarn.lock

.prettierignore

@@ -1,5 +1,2 @@
 coverage/
-mdast-util-heading-range.js
-mdast-util-heading-range.min.js
-*.json
 *.md

index.js

@@ -1,13 +1,8 @@
-'use strict'
-
-var toString = require('mdast-util-to-string')
-
-module.exports = headingRange
-
-var splice = [].splice
+import {toString} from 'mdast-util-to-string'
 
 // Search `node` with `options` and invoke `callback`.
-function headingRange(node, options, callback) {
+// eslint-disable-next-line complexity
+export function headingRange(node, options, callback) {
   var test = options
   var children = node.children
   var index = -1
@@ -36,7 +31,7 @@ function headingRange(node, options, callback) {
   }
 
   if (typeof test !== 'function') {
-    throw new Error(
+    throw new TypeError(
       'Expected `string`, `regexp`, or `function` for `test`, not `' +
         test +
         '`'
@@ -79,7 +74,7 @@ function headingRange(node, options, callback) {
       children[end],
       {
         parent: node,
-        start: start,
+        start,
         end: children[end] ? end : null
       }
     )
@@ -94,7 +89,7 @@ function headingRange(node, options, callback) {
         if (nodes[index]) result.push(nodes[index])
       }
 
-      splice.apply(children, [start, end - start + 1].concat(result))
+      children.splice(start, end - start + 1, ...result)
     }
   }
 }

package.json

@@ -24,37 +24,29 @@
     "Titus Wormer <[email protected]> (https://wooorm.com)",
     "Jake Teton-Landis <[email protected]>"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
     "index.js"
   ],
   "dependencies": {
-    "mdast-util-to-string": "^1.0.0"
+    "mdast-util-to-string": "^3.0.0"
   },
   "devDependencies": {
-    "browserify": "^17.0.0",
-    "nyc": "^15.0.0",
+    "c8": "^7.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
     "tape": "^5.0.0",
-    "tinyify": "^3.0.0",
-    "xo": "^0.38.0"
+    "xo": "^0.39.0"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "build-bundle": "browserify . -s mdastUtilHeadingRange -o mdast-util-heading-range.js",
-    "build-mangle": "browserify . -s mdastUtilHeadingRange -o mdast-util-heading-range.min.js -p tinyify",
-    "build": "npm run build-bundle && npm run build-mangle",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run build && npm run test-coverage"
-  },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
+    "test-api": "node test.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
+    "test": "npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -66,14 +58,10 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
-      "complexity": "off",
-      "unicorn/prefer-type-error": "off"
-    },
-    "ignores": [
-      "mdast-util-heading-range.js"
-    ]
+      "no-var": "off",
+      "prefer-arrow-callback": "off"
+    }
   },
   "remarkConfig": {
     "plugins": [

readme.md

@@ -12,6 +12,9 @@
 
 ## 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
@@ -33,9 +36,9 @@ Bar.
 And our script, `example.js`, looks as follows:
 
 ```js
-var vfile = require('to-vfile')
-var remark = require('remark')
-var heading = require('mdast-util-heading-range')
+import toVFile from 'to-vfile'
+import remark from 'remark'
+import {headingRange} from 'mdast-util-heading-range'
 
 remark()
   .use(plugin)
@@ -48,10 +51,10 @@ function plugin() {
   return transform
 
   function transform(tree) {
-    heading(tree, 'foo', mutate)
+    headingRange(tree, 'foo', handler)
   }
 
-  function mutate(start, nodes, end) {
+  function handler(start, nodes, end) {
     return [
       start,
       {type: 'paragraph', children: [{type: 'text', value: 'Qux.'}]},
@@ -73,10 +76,13 @@ Qux.
 
 ## API
 
-### `heading(tree, test|options, onrun)`
+This package exports the following identifiers: `headingRange`.
+There is no default export.
+
+### `headingRange(tree, test|options, handler)`
 
 Search `tree` ([`Node`][node]) and transform a section without affecting other
-parts with `onrun` ([`Function`][onrun]).
+parts with `handler` ([`Function`][handler]).
 A “section” is a heading that passes `test`, until the next heading of the same
 or lower depth, or the end of the document.
 If `ignoreFinalDefinitions: true`, final definitions “in” the section are
@@ -103,7 +109,7 @@ itself ([`Heading`][heading]) to check if it’s the one to look for.
 
 `Boolean?`, `true` if this is the heading to use.
 
-#### `function onrun(start, nodes, end?, scope)`
+#### `function handler(start, nodes, end?, scope)`
 
 Callback invoked when a range is found.
 
@@ -131,14 +137,14 @@ Extra info (`Object`):
 
 ## Security
 
-Improper use of `onrun` can open you up to a [cross-site scripting (XSS)][xss]
+Improper use of `handler` can open you up to a [cross-site scripting (XSS)][xss]
 attack as the value it returns is injected into the syntax tree.
 This can become a problem if the tree is later transformed to [**hast**][hast].
 The following example shows how a script is injected that could run when loaded
 in a browser.
 
 ```js
-function onrun(start, nodes, end) {
+function handler(start, nodes, end) {
   return [start, {type: 'html', value: 'alert(1)'}, end]
 }
 ```
@@ -153,7 +159,8 @@ Yields:
 # Baz
 ```
 
-Either do not use user input in `onrun` or use [`hast-util-santize`][sanitize].
+Either do not use user input in `handler` or use
+[`hast-util-santize`][sanitize].
 
 ## Related
 
@@ -218,7 +225,7 @@ abide by its terms.
 
 [node]: https://github.com/syntax-tree/unist#node
 
-[onrun]: #function-onrunstart-nodes-end-scope
+[handler]: #function-handlerstart-nodes-end-scope
 
 [heading]: https://github.com/syntax-tree/mdast#heading
 

test.js

@@ -1,27 +1,25 @@
-'use strict'
-
-var test = require('tape')
-var remark = require('remark')
-var heading = require('.')
+import test from 'tape'
+import remark from 'remark'
+import {headingRange} from './index.js'
 
 test('mdast-util-heading-range()', function (t) {
   t.plan(57)
 
-  t.equal(typeof heading, 'function', 'should be a function')
+  t.equal(typeof headingRange, 'function', 'should be a function')
 
   t.throws(
     function () {
-      heading({type: 'root', chilren: []}, null, function () {})
+      headingRange({type: 'root', chilren: []}, null, function () {})
     },
-    /^Error: Expected `string`, `regexp`, or `function` for `test`, not `null`$/,
+    /^TypeError: Expected `string`, `regexp`, or `function` for `test`, not `null`$/,
     'should throw when `null` is passed in'
   )
 
   t.throws(
     function () {
-      heading({type: 'root', chilren: []}, undefined, function () {})
+      headingRange({type: 'root', chilren: []}, undefined, function () {})
     },
-    /^Error: Expected `string`, `regexp`, or `function` for `test`, not `undefined`$/,
+    /^TypeError: Expected `string`, `regexp`, or `function` for `test`, not `undefined`$/,
     'should throw when `undefined` is passed in'
   )
 
@@ -121,7 +119,7 @@ test('mdast-util-heading-range()', function (t) {
   remark()
     .use(function () {
       return function (node) {
-        heading(node, 'foo', function () {
+        headingRange(node, 'foo', function () {
           return null
         })
       }
@@ -142,7 +140,7 @@ test('mdast-util-heading-range()', function (t) {
   remark()
     .use(function () {
       return function (node) {
-        heading(node, 'foo', function () {
+        headingRange(node, 'foo', function () {
           return []
         })
       }
@@ -163,7 +161,7 @@ test('mdast-util-heading-range()', function (t) {
   remark()
     .use(function () {
       return function (node) {
-        heading(node, 'foo', function (start, nodes, end) {
+        headingRange(node, 'foo', function (start, nodes, end) {
           return [start, {type: 'thematicBreak'}, end]
         })
       }
@@ -184,7 +182,7 @@ test('mdast-util-heading-range()', function (t) {
   remark()
     .use(function () {
       return function (node) {
-        heading(node, 'foo', function (start, nodes, end) {
+        headingRange(node, 'foo', function (start, nodes, end) {
           t.equal(nodes.length, 3)
 
           return [start].concat(nodes, end)
@@ -309,7 +307,7 @@ function process(t, value, options) {
   return remark()
     .use(function () {
       return function (node) {
-        heading(node, options, function (start, nodes, end, scope) {
+        headingRange(node, options, function (start, nodes, end, scope) {
           t.equal(typeof scope.start, 'number')
           t.assert(typeof scope.end === 'number' || scope.end === null)
           t.equal(scope.parent.type, 'root')