Use ESM

Author: wooorm

.gitignore

@@ -1,8 +1,5 @@
 .DS_Store
 *.log
-.nyc_output/
 coverage/
 node_modules/
-nlcst-affix-emoticon-modifier.js
-nlcst-affix-emoticon-modifier.min.js
 yarn.lock

.prettierignore

@@ -1,5 +1,2 @@
 coverage/
-nlcst-affix-emoticon-modifier.js
-nlcst-affix-emoticon-modifier.min.js
-*.json
 *.md

index.js

@@ -1,16 +1,14 @@
-'use strict'
+import {modifyChildren} from 'unist-util-modify-children'
 
-var modifier = require('unist-util-modify-children')
-
-module.exports = modifier(mergeAffixEmoticon)
+export const affixEmoticonModifier = modifyChildren(mergeAffixEmoticon)
 
 // Merge emoticons into an `EmoticonNode`.
 function mergeAffixEmoticon(child, index, parent) {
   var siblings = parent.children
   var children = child.children
   var childIndex = -1
 
-  if (children && children.length && index) {
+  if (children && children.length > 0 && index) {
     while (++childIndex < children.length) {
       if (children[childIndex].type === 'EmoticonNode') {
         siblings[index - 1].children = [].concat(

package.json

@@ -22,16 +22,19 @@
   "contributors": [
     "Titus Wormer <[email protected]> (https://wooorm.com)"
   ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "index.js",
   "files": [
     "index.js"
   ],
   "dependencies": {
-    "unist-util-modify-children": "^1.0.0"
+    "unist-util-modify-children": "^3.0.0"
   },
   "devDependencies": {
-    "browserify": "^17.0.0",
-    "nlcst-emoji-modifier": "^4.0.0",
-    "nlcst-emoticon-modifier": "^1.0.0",
+    "c8": "^7.0.0",
+    "nlcst-emoji-modifier": "^5.0.0",
+    "nlcst-emoticon-modifier": "^2.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^9.0.0",
@@ -40,23 +43,14 @@
     "tape": "^5.0.0",
     "tinyify": "^3.0.0",
     "unified": "^9.0.0",
-    "unist-util-remove-position": "^3.0.0",
-    "xo": "^0.38.0"
+    "unist-util-remove-position": "^4.0.0",
+    "xo": "^0.39.0"
   },
   "scripts": {
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "build-bundle": "browserify . -s nlcstAffixEmoticonModifier -o nlcst-affix-emoticon-modifier.js",
-    "build-mangle": "browserify . -s nlcstAffixEmoticonModifier -o nlcst-affix-emoticon-modifier.min.js -p tinyify",
-    "build": "npm run build-bundle && npm run build-mangle",
-    "test-api": "node test",
-    "test-coverage": "nyc --reporter lcov tape test/index.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/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,
@@ -68,12 +62,9 @@
   },
   "xo": {
     "prettier": true,
-    "esnext": false,
-    "ignore": [
-      "nlcst-affix-emoticon-modifier.js"
-    ],
     "rules": {
-      "unicorn/explicit-length-check": "off"
+      "no-var": "off",
+      "prefer-arrow-callback": "off"
     }
   },
   "remarkConfig": {

readme.md

@@ -16,6 +16,9 @@ the previous sentence, after a terminal marker.  :unamused:
 
 ## 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
@@ -25,47 +28,52 @@ npm install nlcst-affix-emoticon-modifier
 ## Use
 
 ```js
-var affixEmoticon = require('nlcst-affix-emoticon-modifier')
-var emoticon = require('nlcst-emoticon-modifier')
-var inspect = require('unist-util-inspect')
-var english = require('parse-english')()
+import {affixEmoticonModifier} from 'nlcst-affix-emoticon-modifier'
+import {emoticonModifier} from 'nlcst-emoticon-modifier'
+import {inspect} from 'unist-util-inspect'
+import {ParseEnglish} from 'parse-english'
+
+var english = new ParseEnglish()
 
-english.useFirst('tokenizeSentence', emoticon)
-english.useFirst('tokenizeParagraph', affixEmoticon)
+english.useFirst('tokenizeSentence', emoticonModifier)
+english.useFirst('tokenizeParagraph', affixEmoticonModifier)
 
 console.log(inspect(english.parse('Hey. :) How is it going?')))
 ```
 
 Yields:
 
 ```txt
-RootNode[1]
-└─ ParagraphNode[3]
-   ├─ SentenceNode[4]
-   │  ├─ WordNode[1]
-   │  │  └─ TextNode: 'Hey'
-   │  ├─ PunctuationNode: '.'
-   │  ├─ WhiteSpaceNode: ' '
-   │  └─ EmoticonNode: ':)'
-   ├─ WhiteSpaceNode: ' '
-   └─ SentenceNode[8]
-      ├─ WordNode[1]
-      │  └─ TextNode: 'How'
-      ├─ WhiteSpaceNode: ' '
-      ├─ WordNode[1]
-      │  └─ TextNode: 'is'
-      ├─ WhiteSpaceNode: ' '
-      ├─ WordNode[1]
-      │  └─ TextNode: 'it'
-      ├─ WhiteSpaceNode: ' '
-      ├─ WordNode[1]
-      │  └─ TextNode: 'going'
-      └─ PunctuationNode: '?'
+RootNode[1] (1:1-1:25, 0-24)
+└─0 ParagraphNode[3] (1:1-1:25, 0-24)
+    ├─0 SentenceNode[4] (1:1-1:8, 0-7)
+    │   ├─0 WordNode[1] (1:1-1:4, 0-3)
+    │   │   └─0 TextNode "Hey" (1:1-1:4, 0-3)
+    │   ├─1 PunctuationNode "." (1:4-1:5, 3-4)
+    │   ├─2 WhiteSpaceNode " " (1:5-1:6, 4-5)
+    │   └─3 EmoticonNode ":)" (1:6-1:8, 5-7)
+    ├─1 WhiteSpaceNode " " (1:8-1:9, 7-8)
+    └─2 SentenceNode[8] (1:9-1:25, 8-24)
+        ├─0 WordNode[1] (1:9-1:12, 8-11)
+        │   └─0 TextNode "How" (1:9-1:12, 8-11)
+        ├─1 WhiteSpaceNode " " (1:12-1:13, 11-12)
+        ├─2 WordNode[1] (1:13-1:15, 12-14)
+        │   └─0 TextNode "is" (1:13-1:15, 12-14)
+        ├─3 WhiteSpaceNode " " (1:15-1:16, 14-15)
+        ├─4 WordNode[1] (1:16-1:18, 15-17)
+        │   └─0 TextNode "it" (1:16-1:18, 15-17)
+        ├─5 WhiteSpaceNode " " (1:18-1:19, 17-18)
+        ├─6 WordNode[1] (1:19-1:24, 18-23)
+        │   └─0 TextNode "going" (1:19-1:24, 18-23)
+        └─7 PunctuationNode "?" (1:24-1:25, 23-24)
 ```
 
 ## API
 
-### `affixEmoticon(paragraph)`
+This package exports the following identifiers: `affixEmoticonModifier`.
+There is no default export.
+
+### `affixEmoticonModifier(paragraph)`
 
 Merge affix emoticons (`EmoticonNode`) into the previous sentence.
 

test/index.js

@@ -1,20 +1,25 @@
-'use strict'
+import fs from 'fs'
+import path from 'path'
+import test from 'tape'
+import unified from 'unified'
+import english from 'retext-english'
+import {emojiModifier} from 'nlcst-emoji-modifier'
+import {emoticonModifier} from 'nlcst-emoticon-modifier'
+import {removePosition} from 'unist-util-remove-position'
+import {affixEmoticonModifier} from '../index.js'
 
-var test = require('tape')
-var unified = require('unified')
-var english = require('retext-english')
-var emojiModifier = require('nlcst-emoji-modifier')
-var emoticonModifier = require('nlcst-emoticon-modifier')
-var remove = require('unist-util-remove-position')
+var lollipop = JSON.parse(
+  String(fs.readFileSync(path.join('test', 'fixtures', 'lollipop.json')))
+)
 
-var lollipop = require('./fixtures/lollipop')
-var smile = require('./fixtures/smile')
-var modifier = require('..')
+var smile = JSON.parse(
+  String(fs.readFileSync(path.join('test', 'fixtures', 'smile.json')))
+)
 
-test('nlcst-affix-emoticon-modifier()', function (t) {
+test('affixEmoticonModifier()', function (t) {
   t.throws(
     function () {
-      modifier({})
+      affixEmoticonModifier({})
     },
     /Missing children in `parent`/,
     'should throw when not given a parent'
@@ -28,7 +33,7 @@ test('nlcst-affix-emoticon-modifier()', function (t) {
 
   t.deepEqual(
     process('Lol! :lollipop: That’s cool.', true),
-    remove(lollipop, true),
+    removePosition(lollipop, true),
     'should merge at sentence-start (1, positionless)'
   )
 
@@ -40,7 +45,7 @@ test('nlcst-affix-emoticon-modifier()', function (t) {
 
   t.deepEqual(
     process('Lol! :) That’s cool.', true),
-    remove(smile, true),
+    removePosition(smile, true),
     'should merge at sentence-start (2, positionless)'
   )
 
@@ -62,5 +67,5 @@ function process(fixture, positionless) {
 function plugin() {
   this.Parser.prototype.useFirst('tokenizeSentence', emojiModifier)
   this.Parser.prototype.useFirst('tokenizeSentence', emoticonModifier)
-  this.Parser.prototype.useFirst('tokenizeParagraph', modifier)
+  this.Parser.prototype.useFirst('tokenizeParagraph', affixEmoticonModifier)
 }