Use ESM

Author: wooorm

.gitignore

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

.prettierignore

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

index.js

@@ -1,16 +1,11 @@
-'use strict'
-
-var Parser = require('parse5/lib/parser')
-var pos = require('unist-util-position')
-var visit = require('unist-util-visit')
-var fromParse5 = require('hast-util-from-parse5')
-var toParse5 = require('hast-util-to-parse5')
-var voids = require('html-void-elements')
-var ns = require('web-namespaces')
-var zwitch = require('zwitch')
-var xtend = require('xtend')
-
-module.exports = wrap
+import Parser from 'parse5/lib/parser/index.js'
+import {pointStart, pointEnd} from 'unist-util-position'
+import {visit} from 'unist-util-visit'
+import {fromParse5} from 'hast-util-from-parse5'
+import {toParse5} from 'hast-util-to-parse5'
+import {htmlVoidElements} from 'html-void-elements'
+import {webNamespaces} from 'web-namespaces'
+import {zwitch} from 'zwitch'
 
 var inTemplateMode = 'IN_TEMPLATE_MODE'
 var dataState = 'DATA_STATE'
@@ -22,18 +17,18 @@ var doctypeToken = 'DOCTYPE_TOKEN'
 
 var parseOptions = {sourceCodeLocationInfo: true, scriptingEnabled: false}
 
-function wrap(tree, file, options) {
+export function raw(tree, file, options) {
   var parser = new Parser(parseOptions)
   var one = zwitch('type', {
     handlers: {
-      root: root,
-      element: element,
-      text: text,
-      comment: comment,
-      doctype: doctype,
-      raw: raw
+      root,
+      element,
+      text,
+      comment,
+      doctype,
+      raw: handleRaw
     },
-    unknown: unknown
+    unknown
   })
   var stitches
   var tokenizer
@@ -81,14 +76,14 @@ function wrap(tree, file, options) {
       nodeName: 'template',
       tagName: 'template',
       attrs: [],
-      namespaceURI: ns.html,
+      namespaceURI: webNamespaces.html,
       childNodes: []
     }
     var mock = {
       nodeName: 'documentmock',
       tagName: 'documentmock',
       attrs: [],
-      namespaceURI: ns.html,
+      namespaceURI: webNamespaces.html,
       childNodes: []
     }
     var doc = {nodeName: '#document-fragment', childNodes: []}
@@ -143,11 +138,11 @@ function wrap(tree, file, options) {
 
   function element(node) {
     resetTokenizer()
-    parser._processToken(startTag(node), ns.html)
+    parser._processToken(startTag(node), webNamespaces.html)
 
     all(node.children)
 
-    if (voids.indexOf(node.tagName) < 0) {
+    if (!htmlVoidElements.includes(node.tagName)) {
       resetTokenizer()
       parser._processToken(endTag(node))
     }
@@ -184,8 +179,8 @@ function wrap(tree, file, options) {
     })
   }
 
-  function raw(node) {
-    var start = pos.start(node)
+  function handleRaw(node) {
+    var start = pointStart(node)
     var line = start.line || 1
     var column = start.column || 1
     var offset = start.offset || 0
@@ -242,7 +237,7 @@ function wrap(tree, file, options) {
     // Recurse, because to somewhat handle `[<x>]</x>` (where `[]` denotes the
     // passed through node).
     if (node.children) {
-      clone.children = wrap(
+      clone.children = raw(
         {type: 'root', children: node.children},
         file,
         options
@@ -280,14 +275,14 @@ function wrap(tree, file, options) {
 function startTag(node) {
   var location = createParse5Location(node)
 
-  location.startTag = xtend(location)
+  location.startTag = Object.assign({}, location)
 
   return {
     type: startTagToken,
     tagName: node.tagName,
     selfClosing: false,
     attrs: attributes(node),
-    location: location
+    location
   }
 }
 
@@ -302,13 +297,13 @@ function attributes(node) {
 function endTag(node) {
   var location = createParse5Location(node)
 
-  location.endTag = xtend(location)
+  location.endTag = Object.assign({}, location)
 
   return {
     type: endTagToken,
     tagName: node.tagName,
     attrs: [],
-    location: location
+    location
   }
 }
 
@@ -323,8 +318,8 @@ function documentMode(node) {
 }
 
 function createParse5Location(node) {
-  var start = pos.start(node)
-  var end = pos.end(node)
+  var start = pointStart(node)
+  var end = pointEnd(node)
 
   return {
     startLine: start.line,

package.json

@@ -24,56 +24,45 @@
     "Titus Wormer <[email protected]> (https://wooorm.com)",
     "Christian Murphy <[email protected]>"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
+  "types": "types/index.d.ts",
   "files": [
-    "index.js",
-    "types/index.d.ts"
+    "types/index.d.ts",
+    "index.js"
   ],
-  "types": "types/index.d.ts",
   "dependencies": {
     "@types/hast": "^2.0.0",
-    "hast-util-from-parse5": "^6.0.0",
-    "hast-util-to-parse5": "^6.0.0",
-    "html-void-elements": "^1.0.0",
+    "hast-util-from-parse5": "^7.0.0",
+    "hast-util-to-parse5": "^7.0.0",
+    "html-void-elements": "^2.0.0",
     "parse5": "^6.0.0",
-    "unist-util-position": "^3.0.0",
-    "unist-util-visit": "^2.0.0",
+    "unist-util-position": "^4.0.0",
+    "unist-util-visit": "^3.0.0",
     "vfile": "^4.0.0",
-    "web-namespaces": "^1.0.0",
-    "xtend": "^4.0.0",
-    "zwitch": "^1.0.0"
+    "web-namespaces": "^2.0.0",
+    "zwitch": "^2.0.0"
   },
   "devDependencies": {
-    "browserify": "^17.0.0",
-    "dtslint": "^4.0.0",
-    "hastscript": "^6.0.0",
-    "nyc": "^15.0.0",
+    "c8": "^7.0.0",
+    "hastscript": "^7.0.0",
     "prettier": "^2.0.0",
     "rehype-stringify": "^8.0.0",
     "remark-cli": "^9.0.0",
     "remark-parse": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
     "remark-rehype": "^8.0.0",
     "tape": "^5.0.0",
-    "tinyify": "^3.0.0",
     "unified": "^9.0.0",
-    "unist-builder": "^2.0.0",
-    "xo": "^0.38.0"
+    "unist-builder": "^3.0.0",
+    "xo": "^0.39.0"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "build-bundle": "browserify index.js -s hastUtilRaw -o hast-util-raw.js",
-    "build-mangle": "browserify index.js -s hastUtilRaw -o hast-util-raw.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-types": "dtslint types",
-    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
-  },
-  "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,
@@ -85,12 +74,12 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
-      "unicorn/prefer-includes": "off"
+      "no-var": "off",
+      "prefer-arrow-callback": "off"
     },
-    "ignores": [
-      "hast-util-raw.js"
+    "ignore": [
+      "types/"
     ]
   },
   "remarkConfig": {

readme.md

@@ -22,6 +22,9 @@ If you’re working with [**remark**][remark] and/or
 
 ## 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
@@ -31,8 +34,8 @@ npm install hast-util-raw
 ## Use
 
 ```js
-var h = require('hastscript')
-var raw = require('hast-util-raw')
+import {h} from 'hastscript'
+import {raw} from 'hast-util-raw'
 
 var tree = h('div', [h('h1', ['Foo ', h('h2', 'Bar'), ' Baz'])])
 
@@ -61,6 +64,9 @@ Yields:
 
 ## API
 
+This package exports the following identifiers: `raw`.
+There is no default export.
+
 ### `raw(tree[, file][, options])`
 
 Given a [**hast**][hast] [*tree*][tree] and an optional [vfile][] (for

test.js

@@ -1,13 +1,11 @@
-'use strict'
-
-var test = require('tape')
-var u = require('unist-builder')
-var h = require('hastscript')
-var unified = require('unified')
-var parse = require('remark-parse')
-var remark2rehype = require('remark-rehype')
-var stringify = require('rehype-stringify')
-var raw = require('.')
+import test from 'tape'
+import {u} from 'unist-builder'
+import {h} from 'hastscript'
+import unified from 'unified'
+import remarkParse from 'remark-parse'
+import remarkRehype from 'remark-rehype'
+import rehypeStringify from 'rehype-stringify'
+import {raw} from './index.js'
 
 test('raw', function (t) {
   t.throws(
@@ -63,7 +61,7 @@ test('raw', function (t) {
   t.deepEqual(
     raw(u('root', [u('doctype', {name: 'html'}), h('html', {lang: 'en'}, [])])),
     u('root', {data: {quirksMode: false}}, [
-      u('doctype', {name: 'html', public: null, system: null}),
+      u('doctype'),
       h('html', {lang: 'en'}, [h('head'), h('body')])
     ]),
     'should pass documents through (#2)'
@@ -268,8 +266,8 @@ test('raw', function (t) {
 
 test('integration', function (t) {
   unified()
-    .use(parse)
-    .use(remark2rehype, {allowDangerousHtml: true})
+    .use(remarkParse)
+    .use(remarkRehype, {allowDangerousHtml: true})
     .use(function () {
       return raw
     })
@@ -628,7 +626,7 @@ test('integration', function (t) {
         )
       }
     })
-    .use(stringify)
+    .use(rehypeStringify)
     .process(
       [
         '<i>Some title</i>',