Refactor to move implementation to lib/

Author: wooorm

index.js

@@ -1,105 +1,6 @@
 /**
- * @typedef {import('unist').Node} Node
- * @typedef {import('unist-util-visit').Test} Test
- *
- * @callback KeyFunction
- *   Function called with every added node (`Node`) to calculate the key to
- *   index on.
- * @param {Node} node
- *   Node to calculate a key for.
- * @returns {unknown}
- *   Key to index on.
- *   Can be anything that can be used as a key in a `Map`.
+ * @typedef {import('./lib/index.js').KeyFunction} KeyFunction
+ * @typedef {import('./lib/index.js').Test} Test
  */
 
-import {visit} from 'unist-util-visit'
-
-export class Index {
-  /**
-   * Create a mutable index data structure, that maps property values or
-   * computed keys, to nodes.
-   *
-   * If `tree` is given, the index is initialized with all nodes, optionally
-   * filtered by `test`.
-   *
-   * @param {string|KeyFunction} prop
-   *   Field (`string`) to look up in each node to find keys or function called
-   *   with each node to calculate keys.
-   * @param {Node} [tree]
-   *   Tree to index.
-   * @param {Test} [test]
-   *   `is`-compatible test.
-   */
-  constructor(prop, tree, test) {
-    /** @type {Map<unknown, Array<Node>>} */
-    this.index = new Map()
-    /** @type {KeyFunction} */
-    // @ts-expect-error: Looks indexable.
-    this.key = typeof prop === 'string' ? (node) => node[prop] : prop
-
-    if (tree) {
-      visit(tree, test, (node) => {
-        this.add(node)
-      })
-    }
-  }
-
-  /**
-   * Get nodes by `key`.
-   *
-   * @param {unknown} key
-   *   Key to retrieve.
-   *   Can be anything that can be used as a key in a `Map`.
-   * @returns {Array<Node>}
-   *   List of zero or more nodes.
-   */
-  get(key) {
-    return this.index.get(key) || []
-  }
-
-  /**
-   * Add `node` to the index (if not already present).
-   *
-   * @param {Node} node
-   *   Node to index.
-   * @returns
-   *   Current instance.
-   */
-  add(node) {
-    const key = this.key(node)
-    let nodes = this.index.get(key)
-
-    if (!nodes) {
-      nodes = []
-      this.index.set(key, nodes)
-    }
-
-    if (!nodes.includes(node)) {
-      nodes.push(node)
-    }
-
-    return this
-  }
-
-  /**
-   * Remove `node` from the index (if present).
-   *
-   * @param {Node} node
-   *   Node to remove.
-   * @returns
-   *   Current instance.
-   */
-  remove(node) {
-    const key = this.key(node)
-    const nodes = this.index.get(key)
-
-    if (nodes) {
-      const pos = nodes.indexOf(node)
-      if (pos !== -1) {
-        nodes.splice(pos, 1)
-      }
-    }
-
-    return this
-  }
-}
+export {Index} from './lib/index.js'

lib/index.js

@@ -0,0 +1,105 @@
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('unist-util-visit').Test} Test
+ *
+ * @callback KeyFunction
+ *   Function called with every added node (`Node`) to calculate the key to
+ *   index on.
+ * @param {Node} node
+ *   Node to calculate a key for.
+ * @returns {unknown}
+ *   Key to index on.
+ *   Can be anything that can be used as a key in a `Map`.
+ */
+
+import {visit} from 'unist-util-visit'
+
+export class Index {
+  /**
+   * Create a mutable index data structure, that maps property values or
+   * computed keys, to nodes.
+   *
+   * If `tree` is given, the index is initialized with all nodes, optionally
+   * filtered by `test`.
+   *
+   * @param {string|KeyFunction} prop
+   *   Field (`string`) to look up in each node to find keys or function called
+   *   with each node to calculate keys.
+   * @param {Node} [tree]
+   *   Tree to index.
+   * @param {Test} [test]
+   *   `is`-compatible test.
+   */
+  constructor(prop, tree, test) {
+    /** @type {Map<unknown, Array<Node>>} */
+    this.index = new Map()
+    /** @type {KeyFunction} */
+    // @ts-expect-error: Looks indexable.
+    this.key = typeof prop === 'string' ? (node) => node[prop] : prop
+
+    if (tree) {
+      visit(tree, test, (node) => {
+        this.add(node)
+      })
+    }
+  }
+
+  /**
+   * Get nodes by `key`.
+   *
+   * @param {unknown} key
+   *   Key to retrieve.
+   *   Can be anything that can be used as a key in a `Map`.
+   * @returns {Array<Node>}
+   *   List of zero or more nodes.
+   */
+  get(key) {
+    return this.index.get(key) || []
+  }
+
+  /**
+   * Add `node` to the index (if not already present).
+   *
+   * @param {Node} node
+   *   Node to index.
+   * @returns
+   *   Current instance.
+   */
+  add(node) {
+    const key = this.key(node)
+    let nodes = this.index.get(key)
+
+    if (!nodes) {
+      nodes = []
+      this.index.set(key, nodes)
+    }
+
+    if (!nodes.includes(node)) {
+      nodes.push(node)
+    }
+
+    return this
+  }
+
+  /**
+   * Remove `node` from the index (if present).
+   *
+   * @param {Node} node
+   *   Node to remove.
+   * @returns
+   *   Current instance.
+   */
+  remove(node) {
+    const key = this.key(node)
+    const nodes = this.index.get(key)
+
+    if (nodes) {
+      const pos = nodes.indexOf(node)
+      if (pos !== -1) {
+        nodes.splice(pos, 1)
+      }
+    }
+
+    return this
+  }
+}

package.json

@@ -37,6 +37,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
+    "lib/",
     "index.d.ts",
     "index.js"
   ],

test.js

@@ -1,7 +1,5 @@
 /**
- * @typedef {import('./index.js').Node} Node
- * @typedef {import('./index.js').KeyFunction} KeyFunction
- * @typedef {import('./index.js').Test} Test
+ * @typedef {import('unist').Node} Node
  * @typedef {Node & {id: number}} IdNode
  */