Use ESM

Author: wooorm

.gitignore

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

.prettierignore

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

index.js

@@ -1,15 +1,11 @@
-'use strict'
+export var pointStart = point('start')
+export var pointEnd = point('end')
 
-module.exports = position
-
-position.start = factory('start')
-position.end = factory('end')
-
-function position(node) {
-  return {start: position.start(node), end: position.end(node)}
+export function position(node) {
+  return {start: pointStart(node), end: pointEnd(node)}
 }
 
-function factory(type) {
+function point(type) {
   point.displayName = type
 
   return point
@@ -20,7 +16,7 @@ function factory(type) {
     return {
       line: point.line || null,
       column: point.column || null,
-      offset: isNaN(point.offset) ? null : point.offset
+      offset: point.offset > -1 ? point.offset : null
     }
   }
 }

package.json

@@ -22,33 +22,25 @@
   "contributors": [
     "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
     "index.js"
   ],
   "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"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "build-bundle": "browserify . -s unistUtilPosition -o unist-util-position.js",
-    "build-mangle": "browserify . -s unistUtilPosition -o unist-util-position.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,
@@ -60,13 +52,11 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
     "rules": {
-      "unicorn/prefer-number-properties": "off"
-    },
-    "ignores": [
-      "unist-util-position.js"
-    ]
+      "import/no-mutable-exports": "off",
+      "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,18 +24,18 @@ npm install unist-util-position
 ## Use
 
 ```js
-var remark = require('remark')
-var position = require('unist-util-position')
+import remark from 'remark'
+import {position, pointStart, pointEnd} from 'unist-util-position'
 
 var tree = remark().parse('# foo\n\n* bar\n')
 
 console.log(position(tree))
-console.log(position.start(tree))
-console.log(position.end(tree))
+console.log(pointStart(tree))
+console.log(pointEnd(tree))
 
 console.log(position())
-console.log(position.start())
-console.log(position.end())
+console.log(pointStart())
+console.log(pointEnd())
 ```
 
 Yields:
@@ -48,14 +51,18 @@ Yields:
 
 ## API
 
+This package exports the following identifiers: `position`, `pointStart`, and
+`pointEnd`.
+There is no default export.
+
 ### `position(node?)`
 
 Get the positional info of `node` ([`Node?`][node]).
 Returns [`Position`][position].
 
-### `position.start(node?)`
+### `pointStart(node?)`
 
-### `position.end(node?)`
+### `pointEnd(node?)`
 
 Get the start or end points in the positional info of `node` ([`Node?`][node]).
 Returns [`Point`][point].

test.js

@@ -1,7 +1,5 @@
-'use strict'
-
-var test = require('tape')
-var position = require('.')
+import test from 'tape'
+import {position, pointStart, pointEnd} from './index.js'
 
 var properties = {
   position: {
@@ -19,8 +17,6 @@ var noPosition = {}
 var generated = {line: null, column: null, offset: null}
 
 test('unist-util-position', function (t) {
-  var sides = ['start', 'end']
-
   t.test('position', function (t) {
     t.same(
       position(properties),
@@ -55,35 +51,60 @@ test('unist-util-position', function (t) {
     t.end()
   })
 
-  // eslint-disable-next-line unicorn/no-array-for-each
-  sides.forEach(function (side) {
-    t.test('position.' + side, function (t) {
-      var fn = position[side]
+  t.test('pointStart', function (t) {
+    t.same(
+      pointStart(properties),
+      properties.position.start,
+      'should get a side'
+    )
+
+    t.same(
+      pointStart(noFields),
+      generated,
+      'should return an empty point without fields'
+    )
+
+    t.same(
+      pointStart(noPoints),
+      generated,
+      'should return an empty point without points'
+    )
+
+    t.same(
+      pointStart(noPosition),
+      generated,
+      'should return an empty point without position'
+    )
+
+    t.same(pointStart(), generated, 'should return an empty point without node')
+
+    t.end()
+  })
 
-      t.same(fn(properties), properties.position[side], 'should get a side')
+  t.test('pointEnd', function (t) {
+    t.same(pointEnd(properties), properties.position.end, 'should get a side')
 
-      t.same(
-        fn(noFields),
-        generated,
-        'should return an empty point without fields'
-      )
+    t.same(
+      pointEnd(noFields),
+      generated,
+      'should return an empty point without fields'
+    )
 
-      t.same(
-        fn(noPoints),
-        generated,
-        'should return an empty point without points'
-      )
+    t.same(
+      pointEnd(noPoints),
+      generated,
+      'should return an empty point without points'
+    )
 
-      t.same(
-        fn(noPosition),
-        generated,
-        'should return an empty point without position'
-      )
+    t.same(
+      pointEnd(noPosition),
+      generated,
+      'should return an empty point without position'
+    )
 
-      t.same(fn(), generated, 'should return an empty point without node')
+    t.same(pointEnd(), generated, 'should return an empty point without node')
 
-      t.end()
-    })
+    t.end()
   })
 
   t.end()