Use @types/nlcst

Author: wooorm

.gitignore

@@ -1,6 +1,7 @@
-.DS_Store
-*.d.ts
-*.log
 coverage/
 node_modules/
+.DS_Store
+index.d.ts
+test/**/*.d.ts
+*.log
 yarn.lock

complex-types.d.ts

@@ -0,0 +1,11 @@
+import type {Literal} from 'nlcst'
+
+export interface Emoticon extends Literal {
+  type: 'EmoticonNode'
+}
+
+declare module 'nlcst' {
+  interface SentenceContentMap {
+    emoticon: Emoticon
+  }
+}

index.js

@@ -1,15 +1,13 @@
 /**
- * @typedef {import('unist').Node} Node
- * @typedef {import('unist').Literal<string>} Literal
- * @typedef {import('unist').Parent} Parent
+ * @typedef {import('nlcst').Sentence} Sentence
+ * @typedef {import('nlcst').SentenceContent} SentenceContent
+ * @typedef {import('./complex-types').Emoticon} Emoticon
  */
 
 import {toString} from 'nlcst-to-string'
 import {modifyChildren} from 'unist-util-modify-children'
 import {emoticon} from 'emoticon'
 
-export const emoticonModifier = modifyChildren(mergeEmoticons)
-
 // Magic numbers.
 //
 // Emoticons are treated by a parser as multiple nodes.
@@ -30,13 +28,17 @@ const end = []
 
 unpack()
 
+export const emoticonModifier =
+  /** @type {(node: Sentence) => void} */
+  // @ts-expect-error: To do: make types in `unist-util-modify-children` smart.
+  (modifyChildren(mergeEmoticons))
+
 /**
  * Merge emoticons into an `EmoticonNode`.
  *
- * @param {Node} child
+ * @param {SentenceContent} child
  * @param {number} index
- * @param {Parent} parent
- *
+ * @param {Sentence} parent
  */
 function mergeEmoticons(child, index, parent) {
   // Check if `child`s first character could be used to start an emoticon.
@@ -59,7 +61,7 @@ function mergeEmoticons(child, index, parent) {
         end.includes(value.charAt(value.length - 1)) &&
         emoticons.includes(value)
       ) {
-        /** @type {Literal} */
+        /** @type {Emoticon} */
         const emoticonNode = {type: 'EmoticonNode', value}
 
         if (child.position && node.position) {

package.json

@@ -27,10 +27,12 @@
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
+    "complex-types.d.ts",
     "index.d.ts",
     "index.js"
   ],
   "dependencies": {
+    "@types/nlcst": "^1.0.0",
     "@types/unist": "^2.0.0",
     "emoticon": "^4.0.0",
     "nlcst-to-string": "^3.0.0",
@@ -55,11 +57,11 @@
   },
   "scripts": {
     "prepack": "npm run build && npm run format",
-    "build": "rimraf \"{test/**,}*.d.ts\" && tsc && type-coverage",
+    "build": "rimraf \"test/**/*.d.ts\" \"index.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "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"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,

test/index.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('unist').Node} Node
- * @typedef {import('unist').Literal<string>} Literal
+ * @typedef {import('nlcst').Root} Root
+ * @typedef {import('../complex-types').Emoticon} Emoticon
  */
 
 import fs from 'node:fs'
@@ -40,16 +40,15 @@ test('nlcst-emoticon-modifier()', (t) => {
 
   const files = fs.readdirSync(root)
   let index = -1
-  /** @type {Node} */
-  let tree
-  /** @type {string} */
-  let name
 
   while (++index < files.length) {
     if (isHidden(files[index])) continue
 
-    tree = JSON.parse(String(fs.readFileSync(path.join(root, files[index]))))
-    name = path.basename(files[index], path.extname(files[index]))
+    /** @type {Root} */
+    const tree = JSON.parse(
+      String(fs.readFileSync(path.join(root, files[index])))
+    )
+    const name = path.basename(files[index], path.extname(files[index]))
 
     t.deepLooseEqual(position.parse(toString(tree)), tree, name)
     t.deepLooseEqual(
@@ -64,24 +63,20 @@ test('nlcst-emoticon-modifier()', (t) => {
 
 test('emoticons', (t) => {
   let index = -1
-  let offset = -1
-  /** @type {Array.<string>} */
-  let list
-  /** @type {Node} */
-  let tree
-  /** @type {Literal} */
-  let node
 
   while (++index < emoticon.length) {
-    list = emoticon[index].emoticons
-    offset = -1
+    const list = emoticon[index].emoticons
+    let offset = -1
 
     while (++offset < list.length) {
-      tree = position.runSync(
-        position.parse('Who doesn’t like ' + list[offset] + '?')
+      const tree = /** @type {Root} */ (
+        position.runSync(
+          position.parse('Who doesn’t like ' + list[offset] + '?')
+        )
       )
-      // @ts-expect-error: hush
-      node = tree.children[0].children[0].children[6]
+      /** @type {Emoticon} */
+      // @ts-expect-error: fine.
+      const node = tree.children[0].children[0].children[6]
 
       t.strictEqual(node.type, 'EmoticonNode', list[offset] + ' type')
       t.strictEqual(node.value, list[offset], list[offset] + ' value')