Refactor code-style

*   Add more docs to JSDoc
*   Replace dependency

Author: wooorm

lib/index.js

@@ -1,30 +1,55 @@
 /**
- * @typedef {import('mdast').Root|import('mdast').Content} Node
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
  * @typedef {import('mdast').Paragraph} Paragraph
  */
 
-import {remove} from 'unist-util-remove'
+/**
+ * @typedef {Content | Root} Node
+ */
+
+import {visit} from 'unist-util-visit'
 
 /**
  * Remove empty paragraphs in `tree`.
  *
  * @template {Node} Tree
+ *   Node type.
  * @param {Tree} tree
+ *   Tree to change.
  * @returns {Tree extends Paragraph ? Tree | null : Tree}
+ *   Changed tree, or `null` if it was an empty paragraph.
  */
 export function squeezeParagraphs(tree) {
-  /**
-   * @param {Node} node
-   * @returns {boolean}
-   */
-  const filter = (node) =>
-    Boolean(
-      node.type === 'paragraph' &&
-        node.children.every(
-          (node) => node.type === 'text' && /^\s*$/.test(node.value)
-        )
-    )
+  if (emptyParagraph(tree)) {
+    // @ts-expect-error: it’s an empty paragraph.
+    return null
+  }
+
+  visit(tree, function (node, index, parent) {
+    if (index !== null && parent && emptyParagraph(node)) {
+      parent.children.splice(index, 1)
+      return index
+    }
+  })
 
-  // @ts-expect-error: `remove` can’t narrow the above test.
-  return remove(tree, {cascade: false}, filter)
+  // @ts-expect-error: it’s not an empty paragraph.
+  return tree
+}
+
+/**
+ * Check if a node is an empty paragraph.
+ *
+ * @param {Node} node
+ *   Node to check.
+ * @returns {boolean}
+ *   Whether `node` was an empty paragraph.
+ */
+function emptyParagraph(node) {
+  return (
+    node.type === 'paragraph' &&
+    node.children.every(
+      (child) => child.type === 'text' && /^\s*$/.test(child.value)
+    )
+  )
 }

package.json

@@ -41,7 +41,7 @@
   ],
   "dependencies": {
     "@types/mdast": "^3.0.0",
-    "unist-util-remove": "^3.0.0"
+    "unist-util-visit": "^4.0.0"
   },
   "devDependencies": {
     "@types/tape": "^4.0.0",

test.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Paragraph} Paragraph
  */
 
 import test from 'tape'
@@ -39,5 +40,12 @@ test((t) => {
       ])
     ])
   )
+
+  t.deepEqual(
+    squeezeParagraphs(/** @type {Paragraph} */ (u('paragraph', []))),
+    null,
+    'should return `null` for empty paragraphs'
+  )
+
   t.end()
 })