Use ESM

Author: wooorm

.gitignore

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

.prettierignore

@@ -1,5 +1,2 @@
 coverage/
-hast-util-assert.js
-hast-util-assert.min.js
-*.json
 *.md

index.js

@@ -1,83 +1,124 @@
-'use strict'
-
-var assert = require('assert')
-var zwitch = require('zwitch')
-var mapz = require('mapz')
-var unist = require('unist-util-assert')
-
-var hast = zwitch('type')
-
-exports = unist.wrap(hast)
-module.exports = exports
-
-exports.parent = unist.wrap(parent)
-exports.text = unist.text
-exports.void = unist.void
-exports.wrap = unist.wrap
-exports.all = mapz(exports, {key: 'children', indices: false})
-
-// Core interface.
-hast.invalid = unknown
-hast.unknown = unknown
-
-// Per-type handling.
-hast.handlers = {
-  root: unist.wrap(root),
-  element: unist.wrap(element),
-  doctype: unist.wrap(doctype),
-  comment: exports.text,
-  text: exports.text
+import nodeAssert from 'assert'
+import {zwitch} from 'zwitch'
+import {mapz} from 'mapz'
+import {
+  assert as unistAssert,
+  parent as unistParent,
+  literal as unistLiteral,
+  wrap,
+  _void
+} from 'unist-util-assert'
+
+/**
+ * Assert that `node` is a valid hast node.
+ * If `node` is a parent, all children will be asserted too.
+ *
+ * @param {unknown} [node]
+ * @param {Parent} [parent]
+ * @returns {asserts node is Node}
+ */
+export function assert(node, parent) {
+  return wrap(hast)(node, parent)
 }
 
+/**
+ * Assert that `node` is a valid hast parent.
+ *
+ * @param {unknown} [node]
+ * @param {Parent} [parent]
+ * @returns {asserts node is Parent}
+ */
+export function parent(node, parent) {
+  return wrap(assertParent)(node, parent)
+}
+
+/**
+ * Assert that `node` is a valid hast literal.
+ *
+ * @param {unknown} [node]
+ * @param {Parent} [parent]
+ * @returns {asserts node is Literal}
+ */
+export function literal(node, parent) {
+  return wrap(assertLiteral)(node, parent)
+}
+
+export {_void, wrap}
+
+var hast = zwitch('type', {
+  // Core interface.
+  unknown,
+  invalid: unknown,
+
+  // Per-type handling.
+  handlers: {
+    root: wrap(assertRoot),
+    element: wrap(assertElement),
+    doctype: wrap(assertDoctype),
+    comment: literal,
+    text: literal
+  }
+})
+
+var all = mapz(hast, {key: 'children', indices: false})
+
 function unknown(node, ancestor) {
-  unist(node, ancestor)
+  unistAssert(node, ancestor)
 }
 
-function parent(node) {
-  unist.parent(node)
-  exports.all(node)
+function assertParent(node) {
+  unistParent(node)
+  all(node)
 }
 
-function root(node, ancestor) {
-  parent(node)
+function assertLiteral(node) {
+  unistLiteral(node)
+  nodeAssert.strictEqual(
+    typeof node.value,
+    'string',
+    'literal should have a string `value`'
+  )
+}
 
-  assert.strictEqual(ancestor, undefined, '`root` should not have a parent')
+function assertRoot(node, ancestor) {
+  assertParent(node)
+  nodeAssert.strictEqual(ancestor, undefined, '`root` should not have a parent')
 }
 
-function element(node) {
-  parent(node)
+function assertElement(node) {
+  assertParent(node)
 
-  assert.strictEqual(
+  nodeAssert.strictEqual(
     typeof node.tagName,
     'string',
     '`element` should have a `tagName`'
   )
-  assert.notStrictEqual(
+  nodeAssert.notStrictEqual(
     node.tagName,
     '',
     '`element.tagName` should not be empty'
   )
 }
 
-function doctype(node) {
-  unist.void(node)
+function assertDoctype(node) {
+  _void(node)
 
-  assert.strictEqual(
+  nodeAssert.strictEqual(
     typeof node.name,
     'string',
     '`doctype` should have a `name`'
   )
 
   if (node.public !== null && node.public !== undefined) {
-    assert.strictEqual(
+    nodeAssert.strictEqual(
       typeof node.public,
       'string',
       '`doctype.public` should be `string`'
     )
   }
 
   if (node.system !== null && node.system !== undefined) {
-    assert.strictEqual(
+    nodeAssert.strictEqual(
       typeof node.system,
       'string',
       '`doctype.system` should be `string`'

package.json

@@ -23,32 +23,30 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
     "index.js"
   ],
   "dependencies": {
-    "mapz": "^1.0.0",
-    "unist-util-assert": "^2.0.0",
-    "zwitch": "^1.0.0"
+    "mapz": "^2.0.0",
+    "unist-util-assert": "^3.0.0",
+    "zwitch": "^2.0.0"
   },
   "devDependencies": {
-    "browserify": "^17.0.0",
-    "nyc": "^15.0.0",
+    "c8": "^7.0.0",
     "prettier": "^2.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 . --write --loglevel warn && xo --fix",
-    "build-bundle": "browserify . -s hastUtilAssert -o hast-util-assert.js",
-    "build-mangle": "browserify . -s hastUtilAssert -o hast-util-assert.min.js -p tinyify",
-    "build": "npm run build-bundle && npm run build-mangle",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test",
-    "test": "npm run format && npm run build && npm run test-coverage"
+    "test-api": "node test/index.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test/index.js",
+    "test": "npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -60,16 +58,10 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
-    "ignores": [
-      "hast-util-assert.js"
-    ]
-  },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
+    "rules": {
+      "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
@@ -21,7 +24,7 @@ npm install hast-util-assert
 ## Use
 
 ```js
-var assert = require('hast-util-assert')
+import {assert} from 'hast-util-assert'
 
 assert({type: 'root', children: []})
 assert({type: 'element', tagName: 'a', properties: {}, children: []})
@@ -36,14 +39,18 @@ assert({type: 'element', properties: {}, children: []})
 
 ## API
 
+This package exports the following identifiers: `assert`, `parent`, `literal`,
+`_void`, `wrap`.
+There is no default export.
+
 ### `assert(tree)`
 
 Assert that the given `tree` is a valid [**hast**][hast] [*tree*][tree].
 If `tree` is a [*parent*][parent], all [*children*][child] will be asserted as
 well.
 
-The `assert.parent`, `assert.text`, `assert.void`, and `assert.wrap`
-methods from [`unist-util-assert`][unist-util-assert] are also included.
+The `parent`, `literal`, `_void`, and `_wrap` methods from
+[`unist-util-assert`][unist-util-assert] are also included.
 
 ## Security
 

test/children.js

@@ -1,7 +1,5 @@
-'use strict'
-
-var test = require('tape')
-var assert = require('..')
+import test from 'tape'
+import {assert} from '../index.js'
 
 test('children', function (t) {
   t.throws(

test/comment.js

@@ -1,14 +1,12 @@
-'use strict'
-
-var test = require('tape')
-var assert = require('..')
+import test from 'tape'
+import {assert} from '../index.js'
 
 test('assert(comment)', function (t) {
   t.throws(
     function () {
       assert({type: 'comment'})
     },
-    /text should have `value`: `{ type: 'comment' }`$/,
+    /literal should have `value`: `{ type: 'comment' }`$/,
     'should throw if a `comment` doesn’t have a value'
   )
 

test/doctype.js

@@ -1,7 +1,5 @@
-'use strict'
-
-var test = require('tape')
-var assert = require('..')
+import test from 'tape'
+import {assert} from '../index.js'
 
 test('assert(doctype)', function (t) {
   t.throws(

test/element.js

@@ -1,7 +1,5 @@
-'use strict'
-
-var test = require('tape')
-var assert = require('..')
+import test from 'tape'
+import {assert} from '../index.js'
 
 test('assert(element)', function (t) {
   t.throws(

test/index.js

@@ -1,11 +1,10 @@
-'use strict'
-
 /* eslint-disable import/no-unassigned-import */
-require('./node')
-require('./children')
-require('./root')
-require('./element')
-require('./doctype')
-require('./text')
-require('./comment')
+import './node.js'
+import './parent.js'
+import './children.js'
+import './root.js'
+import './element.js'
+import './doctype.js'
+import './text.js'
+import './comment.js'
 /* eslint-enable import/no-unassigned-import */

test/node.js

@@ -1,7 +1,5 @@
-'use strict'
-
-var test = require('tape')
-var assert = require('..')
+import test from 'tape'
+import {assert} from '../index.js'
 
 test('node', function (t) {
   t.throws(

test/parent.js

@@ -0,0 +1,22 @@
+import test from 'tape'
+import {parent} from '../index.js'
+
+test('parent', function (t) {
+  t.throws(
+    function () {
+      parent()
+    },
+    /node should be an object: `undefined`$/,
+    'should throw if not given a node'
+  )
+
+  t.throws(
+    function () {
+      parent({type: 'x'})
+    },
+    /parent should have `children`/,
+    'should throw if not given a parent'
+  )
+
+  t.end()
+})