Update @types/mdast

Author: wooorm

lib/index.js

@@ -1,16 +1,13 @@
 /**
- * @typedef {import('mdast').Parent} MdastParent
- * @typedef {import('mdast').Content} Content
+ * @typedef {import('mdast').Parents} Parents
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').Root} Root
  */
 
 /**
- * @typedef {Root | Content} Node
- * @typedef {Extract<Node, MdastParent>} Parent
- *
  * @typedef Info
  *   Extra info.
- * @property {Parent} parent
+ * @property {Parents} parent
  *   Parent of the section.
  * @property {number} start
  *   Index of `start` in `parent`.
@@ -19,15 +16,15 @@
  *
  * @callback Handler
  *   Callback called when a section is found.
- * @param {Node} start
+ * @param {Nodes} start
  *   Start of section.
- * @param {Array<Node>} between
+ * @param {Array<Nodes>} between
  *   Nodes between `start` and `end`.
- * @param {Node} end
+ * @param {Nodes} end
  *   End of section.
  * @param {Info} info
  *   Extra info.
- * @returns {Array<Node | null | undefined> | null | undefined | void}
+ * @returns {Array<Nodes | null | undefined> | null | undefined | void}
  *   Results.
  *
  *   If nothing is returned, nothing will be changed.
@@ -42,7 +39,7 @@ import {visit} from 'unist-util-visit'
  * Search `tree` for a start and end comments matching `name` and change their
  * “section” with `handler`.
  *
- * @param {Node} node
+ * @param {Nodes} node
  *   Tree to search.
  * @param {string} name
  *   Comment name to look for.
@@ -54,9 +51,9 @@ import {visit} from 'unist-util-visit'
 export function zone(node, name, handler) {
   /** @type {number | undefined} */
   let level
-  /** @type {Node | undefined} */
+  /** @type {Nodes | undefined} */
   let marker
-  /** @type {Parent | undefined} */
+  /** @type {Parents | undefined} */
   let scope
 
   visit(node, (node, index, parent) => {
@@ -65,7 +62,7 @@ export function zone(node, name, handler) {
       info && info.name === name ? info.attributes.match(/(start|end)\b/) : null
     const type = match ? match[0] : undefined
 
-    if (parent && index !== null && type) {
+    if (parent && index !== undefined && type) {
       if (!scope && type === 'start') {
         level = 0
         marker = node
@@ -93,7 +90,7 @@ export function zone(node, name, handler) {
           if (nodes) {
             // Ensure no empty nodes are inserted.
             // This could be the case if `end` is in `nodes` but no `end` node exists.
-            /** @type {Array<Node>} */
+            /** @type {Array<Nodes>} */
             const result = []
             let offset = -1
 

package.json

@@ -36,10 +36,10 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/mdast": "^3.0.0",
-    "@types/unist": "^2.0.0",
+    "@types/mdast": "^4.0.0",
+    "@types/unist": "^3.0.0",
     "mdast-comment-marker": "^2.0.0",
-    "unist-util-visit": "^4.0.0"
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",

test/index.js

@@ -36,12 +36,16 @@ test('zone', async () => {
     /** @type {{default: (tree: Root) => void}} */
     const mod = await import(new URL(folder + '/index.js', root).href)
     const check = mod.default
-    const tree = fromMarkdown(
-      await fs.readFile(new URL(folder + '/input.md', root))
+    // To do: remove cast when `from-markdown` is released.
+    const tree = /** @type {Root} */ (
+      fromMarkdown(await fs.readFile(new URL(folder + '/input.md', root)))
     )
 
     check(tree)
 
-    assert.equal(toMarkdown(tree), expected, folder)
+    // @ts-expect-error: remove cast when `to-markdown` is released.
+    const result = toMarkdown(tree)
+
+    assert.equal(result, expected, folder)
   }
 })