Use ESM

Author: wooorm

index.js

@@ -1,2 +1 @@
-'use strict'
-module.exports = require('./lib')
+export {toXml} from './lib/index.js'

lib/all.js

@@ -1,11 +1,7 @@
-'use strict'
-
-var one = require('./one')
-
-module.exports = all
+import {one} from './one.js'
 
 // Serialize all children of `parent`.
-function all(parent, config) {
+export function all(parent, config) {
   var children = (parent && parent.children) || []
   var index = -1
   var results = []

lib/cdata.js

@@ -1,13 +1,9 @@
-'use strict'
-
-var escape = require('./util-escape')
-
-module.exports = serializeCdataSection
+import {escape} from './util-escape.js'
 
 var unsafe = /]]>/g
 var subset = ['>']
 
 // Serialize a CDATA section.
-function serializeCdataSection(node) {
+export function cdata(node) {
   return '<![CDATA[' + escape(node.value, subset, unsafe) + ']]>'
 }

lib/comment.js

@@ -1,10 +1,6 @@
-'use strict'
-
-var escape = require('./util-escape')
-
-module.exports = serializeComment
+import {escape} from './util-escape.js'
 
 // Serialize a comment.
-function serializeComment(node) {
+export function comment(node) {
   return '<!--' + escape(node.value, ['-']) + '-->'
 }

lib/doctype.js

@@ -1,12 +1,8 @@
-'use strict'
-
-var name = require('./name')
-var value = require('./value')
-
-module.exports = serializeDocumentType
+import {name} from './name.js'
+import {value} from './value.js'
 
 // Serialize a document type.
-function serializeDocumentType(node, config) {
+export function doctype(node, config) {
   var nodeName = name(node.name)
   var pub = node.public
   var sys = node.system

lib/element.js

@@ -1,13 +1,11 @@
-'use strict'
+import {all} from './all.js'
+import {name} from './name.js'
+import {value} from './value.js'
 
-var all = require('./all')
-var name = require('./name')
-var value = require('./value')
-
-module.exports = serializeElement
+var own = {}.hasOwnProperty
 
 // Serialize an element.
-function serializeElement(node, config) {
+export function element(node, config) {
   var nodeName = name(node.name)
   var content = all(node, config)
   var attributes = node.attributes || {}
@@ -17,10 +15,12 @@ function serializeElement(node, config) {
   var result
 
   for (key in attributes) {
-    result = attributes[key]
+    if (own.call(attributes, key)) {
+      result = attributes[key]
 
-    if (result !== null && result !== undefined) {
-      attrs.push(name(key) + '=' + value(result, config))
+      if (result !== null && result !== undefined) {
+        attrs.push(name(key) + '=' + value(result, config))
+      }
     }
   }
 

lib/index.js

@@ -1,14 +1,10 @@
-'use strict'
-
-var one = require('./one')
-
-module.exports = toXml
+import {one} from './one.js'
 
 var quotationMark = '"'
 var apostrophe = "'"
 
 // Serialize the given node.
-function toXml(node, options) {
+export function toXml(node, options) {
   var settings = options || {}
   var quote = settings.quote || quotationMark
   var alternative = quote === quotationMark ? apostrophe : quotationMark
@@ -34,7 +30,7 @@ function toXml(node, options) {
     dangerous: settings.allowDangerousXml,
     close: settings.closeEmptyElements,
     tight: settings.tightClose,
-    quote: quote,
+    quote,
     alternative: smart ? alternative : null
   })
 }

lib/instruction.js

@@ -1,15 +1,11 @@
-'use strict'
-
-var name = require('./name')
-var escape = require('./util-escape')
-
-module.exports = serializeProcessingInstruction
+import {escape} from './util-escape.js'
+import {name} from './name.js'
 
 var unsafe = /\?>/g
 var subset = ['>']
 
 // Serialize a processing instruction.
-function serializeProcessingInstruction(node) {
+export function instruction(node) {
   var nodeName = name(node.name) || 'x'
   var result = escape(node.value, subset, unsafe)
   return '<?' + nodeName + (result ? ' ' + result : '') + '?>'

lib/name.js

@@ -1,11 +1,7 @@
-'use strict'
-
-var escape = require('./util-escape')
-
-module.exports = serializeName
+import {escape} from './util-escape.js'
 
 var subset = ['\t', '\n', ' ', '"', '&', "'", '/', '<', '=', '>']
 
-function serializeName(value) {
+export function name(value) {
   return escape(value, subset)
 }

lib/one.js

@@ -1,22 +1,27 @@
-'use strict'
-
-module.exports = one
+import {all} from './all.js'
+import {element} from './element.js'
+import {text} from './text.js'
+import {comment} from './comment.js'
+import {doctype} from './doctype.js'
+import {instruction} from './instruction.js'
+import {cdata} from './cdata.js'
+import {raw} from './raw.js'
 
 var own = {}.hasOwnProperty
 
 var handlers = {}
 
-handlers.root = require('./all')
-handlers.element = require('./element')
-handlers.text = require('./text')
-handlers.comment = require('./comment')
-handlers.doctype = require('./doctype')
-handlers.instruction = require('./instruction')
-handlers.cdata = require('./cdata')
-handlers.raw = require('./raw')
+handlers.root = all
+handlers.element = element
+handlers.text = text
+handlers.comment = comment
+handlers.doctype = doctype
+handlers.instruction = instruction
+handlers.cdata = cdata
+handlers.raw = raw
 
 // Serialize one node.
-function one(node, config) {
+export function one(node, config) {
   var type = node && node.type
 
   if (!type) {

lib/raw.js

@@ -1,10 +1,6 @@
-'use strict'
-
-var text = require('./text')
-
-module.exports = serializeRaw
+import {text} from './text.js'
 
 // Serialize raw.
-function serializeRaw(node, config) {
+export function raw(node, config) {
   return config.dangerous ? node.value : text(node, config)
 }

lib/text.js

@@ -1,12 +1,8 @@
-'use strict'
-
-var escape = require('./util-escape')
-
-module.exports = serializeText
+import {escape} from './util-escape.js'
 
 var subset = ['&', '<']
 
 // Serialize a text.
-function serializeText(node) {
+export function text(node) {
   return escape(node.value, subset)
 }

lib/util-escape.js

@@ -1,18 +1,14 @@
-'use strict'
-
-var entities = require('stringify-entities/light')
-
-module.exports = escape
+import {stringifyEntitiesLight} from 'stringify-entities'
 
 var noncharacter = /[\u0000-\u0008\u000B\u000C\u000E-\u001F]/g
 
-function escape(value, subset, unsafe) {
+export function escape(value, subset, unsafe) {
   var result = clean(value)
 
   return unsafe ? result.replace(unsafe, encode) : encode(result)
 
   function encode($0) {
-    return entities($0, {subset: subset})
+    return stringifyEntitiesLight($0, {subset})
   }
 }
 

lib/value.js

@@ -1,11 +1,7 @@
-'use strict'
+import {ccount} from 'ccount'
+import {escape} from './util-escape.js'
 
-var ccount = require('ccount')
-var escape = require('./util-escape')
-
-module.exports = serializeValue
-
-function serializeValue(value, config) {
+export function value(value, config) {
   var primary = config.quote
   var secondary = config.alternative
   var result = String(value)

package.json

@@ -21,34 +21,35 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
+  "types": "types/",
   "files": [
-    "lib",
-    "index.js",
-    "types/index.d.ts"
+    "lib/",
+    "types/index.d.ts",
+    "index.js"
   ],
-  "types": "types",
   "dependencies": {
     "@types/xast": "^1.0.0",
-    "ccount": "^1.0.0",
-    "stringify-entities": "^3.1.0"
+    "ccount": "^2.0.0",
+    "stringify-entities": "^4.0.0"
   },
   "devDependencies": {
-    "dtslint": "^4.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",
-    "unist-builder": "^2.0.0",
+    "unist-builder": "^3.0.0",
     "xastscript": "^2.0.0",
-    "xo": "^0.38.0"
+    "xo": "^0.39.0"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . --write --loglevel warn && xo --fix",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test/index.js",
-    "test-types": "dtslint types",
-    "test": "npm run format && npm run test-coverage && npm run test-types"
+    "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,19 +61,14 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
-      "unicorn/prefer-includes": "off",
-      "unicorn/prefer-number-properties": "off",
-      "guard-for-in": "off",
-      "no-control-regex": "off"
-    }
-  },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
+      "no-control-regex": "off",
+      "no-var": "off",
+      "prefer-arrow-callback": "off"
+    },
+    "ignore": [
+      "types/"
+    ]
   },
   "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,9 +24,9 @@ npm install xast-util-to-xml
 ## Use
 
 ```js
-var u = require('unist-builder')
-var x = require('xastscript')
-var toXml = require('xast-util-to-xml')
+import {u} from 'unist-builder'
+import {x} from 'xastscript'
+import {toXml} from 'xast-util-to-xml'
 
 var tree = u('root', [
   u('instruction', {name: 'xml'}, 'version="1.0" encoding="utf-8"'),
@@ -61,6 +64,9 @@ Yields:
 
 ## API
 
+This package exports the following identifiers: `toXml`.
+There is no default export.
+
 ### `toXml(tree[, options])`
 
 Serialize the given **[xast][]** *[tree][]* (or list of nodes).