Refactor code-style

Author: wooorm

index.d.ts

@@ -1,23 +1,35 @@
-import type {Literal} from 'nlcst'
+import type {Data, Literal} from 'nlcst'
+
+// Expose runtime code.
+export {emoticonModifier} from './lib/index.js'
 
 /**
  * Emoticon node.
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface Emoticon extends Literal {
+  /**
+   * Node type of emoticon node.
+   */
   type: 'EmoticonNode'
+
+  /**
+   * Data associated by the ecosystem.
+   */
+  data?: EmoticonData | undefined
 }
 
+/**
+ * Emoticon node data.
+ */
+export interface EmoticonData extends Data {}
+
+// Register node type.
 declare module 'nlcst' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface RootContentMap {
     emoticon: Emoticon
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
   interface SentenceContentMap {
     emoticon: Emoticon
   }
 }
-
-export {emoticonModifier} from './lib/index.js'

lib/index.js

@@ -1,12 +1,12 @@
 /**
  * @typedef {import('nlcst').Sentence} Sentence
  * @typedef {import('nlcst').SentenceContent} SentenceContent
- * @typedef {import('../complex-types.js').Emoticon} Emoticon
+ * @typedef {import('../index.js').Emoticon} Emoticon
  */
 
+import {emoticon} from 'emoticon'
 import {toString} from 'nlcst-to-string'
 import {modifyChildren} from 'unist-util-modify-children'
-import {emoticon} from 'emoticon'
 
 // Magic numbers.
 //

package.json

@@ -43,7 +43,7 @@
     "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "is-hidden": "^2.0.0",
-    "parse-english": "^6.0.0",
+    "parse-english": "^7.0.0",
     "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
@@ -80,6 +80,14 @@
   },
   "xo": {
     "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      },
       {
         "files": "test/**/*.js",
         "rules": {

readme.md

@@ -111,7 +111,7 @@ Merge emoticons in a `SentenceNode` into `EmoticonNode`s.
 
 ###### Returns
 
-Nothing (`void`).
+Nothing (`undefined`).
 
 ### `Emoticon`
 
@@ -147,7 +147,7 @@ import {visit} from 'unist-util-visit'
 /** @type {import('nlcst').Root} */
 const tree = getNodeSomeHow()
 
-visit(tree, (node) => {
+visit(tree, function (node) {
   // `node` can now be a `Emoticon` node.
 })
 ```

test/index.js

@@ -1,6 +1,5 @@
 /**
  * @typedef {import('nlcst').Root} Root
- * @typedef {import('../complex-types.js').Emoticon} Emoticon
  */
 
 import assert from 'node:assert/strict'
@@ -11,29 +10,20 @@ import {emoticon} from 'emoticon'
 import {isHidden} from 'is-hidden'
 import {toString} from 'nlcst-to-string'
 import {emoticonModifier} from '../index.js'
-import * as mod from '../index.js'
 
 const parser = new ParseEnglish()
 parser.tokenizeSentencePlugins.unshift(emoticonModifier)
 
-test('emoticonModifier', async () => {
-  assert.deepEqual(
-    Object.keys(mod).sort(),
-    ['emoticonModifier'],
-    'should expose the public api'
-  )
+test('emoticonModifier', async function (t) {
+  await t.test('should expose the public api', async function () {
+    assert.deepEqual(Object.keys(await import('../index.js')).sort(), [
+      'emoticonModifier'
+    ])
+  })
+})
 
+test('fixtures', async function (t) {
   const root = new URL('fixtures/', import.meta.url)
-
-  assert.throws(
-    () => {
-      // @ts-expect-error runtime.
-      emoticonModifier({})
-    },
-    /Missing children in `parent`/,
-    'should throw when not given a parent'
-  )
-
   const files = await fs.readdir(root)
   let index = -1
 
@@ -42,30 +32,39 @@ test('emoticonModifier', async () => {
 
     if (isHidden(file)) continue
 
-    /** @type {Root} */
-    const tree = JSON.parse(String(await fs.readFile(new URL(file, root))))
     const name = file.split('.').slice(0, -1).join('.')
-    const input = toString(tree)
 
-    assert.deepEqual(parser.parse(input), tree, name)
+    await t.test(name, async function () {
+      /** @type {Root} */
+      const tree = JSON.parse(String(await fs.readFile(new URL(file, root))))
+      const input = toString(tree)
+
+      assert.deepEqual(parser.parse(input), tree)
+    })
   }
 })
 
-test('emoticons', () => {
+test('emoticons', async function (t) {
   let index = -1
 
   while (++index < emoticon.length) {
     const list = emoticon[index].emoticons
     let offset = -1
 
     while (++offset < list.length) {
-      const tree = parser.parse('Who doesn’t like ' + list[offset] + '?')
-      /** @type {Emoticon} */
-      // @ts-expect-error: fine.
-      const node = tree.children[0].children[0].children[6]
+      const value = list[offset]
+
+      await t.test(value, async function () {
+        const tree = parser.parse('Who doesn’t like ' + value + '?')
+        const paragraph = tree.children[0]
+        assert(paragraph.type === 'ParagraphNode')
+        const sentence = paragraph.children[0]
+        assert(sentence.type === 'SentenceNode')
+        const node = sentence.children[6]
+        assert(node.type === 'EmoticonNode')
 
-      assert.strictEqual(node.type, 'EmoticonNode', list[offset] + ' type')
-      assert.strictEqual(node.value, list[offset], list[offset] + ' value')
+        assert.equal(node.value, value)
+      })
     }
   }
 })