Update @types/hast, utilities

Author: wooorm

lib/index.js

@@ -12,19 +12,18 @@
  * @typedef {import('unist').Point} Point
  *
  * @typedef {import('hast').Root} Root
- * @typedef {import('hast').DocType} Doctype
+ * @typedef {import('hast').Doctype} Doctype
  * @typedef {import('hast').Element} Element
  * @typedef {import('hast').Text} Text
  * @typedef {import('hast').Comment} Comment
- * @typedef {import('hast').Content} Content
+ * @typedef {import('hast').RootContent} RootContent
+ * @typedef {import('hast').Nodes} Nodes
  *
  * @typedef {import('mdast-util-to-hast').Raw} Raw
  */
 
 /**
- * @typedef {Root | Content} Node
- *
- * @typedef {{type: 'comment', value: {stitch: Node}}} Stitch
+ * @typedef {{type: 'comment', value: {stitch: Nodes}}} Stitch
  *
  * @typedef Options
  *   Configuration.
@@ -40,7 +39,7 @@
  *   Info passed around about the current state.
  * @property {Parser<DefaultTreeAdapterMap>} parser
  *   Current parser.
- * @property {(node: Node) => void} handle
+ * @property {(node: Nodes) => void} handle
  *   Add a hast node to the parser.
  * @property {boolean} stitches
  *   Whether there are stitches.
@@ -75,16 +74,16 @@ const parseOptions = {sourceCodeLocationInfo: true, scriptingEnabled: false}
  * Pass a hast tree through an HTML parser, which will fix nesting, and turn
  * raw nodes into actual nodes.
  *
- * @param {Node} tree
+ * @param {Nodes} tree
  *   Original hast tree to transform.
  * @param {Options | null | undefined} [options]
  *   Configuration.
- * @returns {Node}
+ * @returns {Nodes}
  *   Parsed again tree.
  */
 export function raw(tree, options) {
   const document = documentMode(tree)
-  /** @type {(node: Node, state: State) => void} */
+  /** @type {(node: Nodes, state: State) => void} */
   const one = zwitch('type', {
     handlers: {root, element, text, comment, doctype, raw: handleRaw},
     unknown
@@ -137,7 +136,7 @@ export function raw(tree, options) {
 /**
  * Transform all nodes
  *
- * @param {Array<Content>} nodes
+ * @param {Array<RootContent>} nodes
  *   hast content.
  * @param {State} state
  *   Info passed around about the current state.
@@ -247,7 +246,7 @@ function doctype(node, state) {
 /**
  * Transform a stitch.
  *
- * @param {Node} node
+ * @param {Nodes} node
  *   unknown node.
  * @param {State} state
  *   Info passed around about the current state.
@@ -258,7 +257,7 @@ function stitch(node, state) {
   // Mark that there are stitches, so we need to walk the tree and revert them.
   state.stitches = true
 
-  /** @type {Node} */
+  /** @type {Nodes} */
   const clone = cloneWithoutChildren(node)
 
   // Recurse, because to somewhat handle `[<x>]</x>` (where `[]` denotes the
@@ -382,7 +381,7 @@ function handleRaw(node, state) {
  *   Never.
  */
 function unknown(node_, state) {
-  const node = /** @type {Node} */ (node_)
+  const node = /** @type {Nodes} */ (node_)
 
   if (
     state.options.passThrough &&
@@ -406,7 +405,7 @@ function unknown(node_, state) {
  *
  * @param {State} state
  *   Info passed around about the current state.
- * @param {Point} point
+ * @param {Point | undefined} point
  *   Point.
  * @returns {void}
  *   Nothing.
@@ -479,18 +478,13 @@ function resetTokenizer(state, point) {
  *
  * @param {State} state
  *   Info passed around about the current state.
- * @param {Point} point
+ * @param {Point | undefined} point
  *   Point.
  * @returns {void}
  *   Nothing.
  */
 function setPoint(state, point) {
-  if (
-    point.line &&
-    point.column &&
-    point.offset !== null &&
-    point.offset !== undefined
-  ) {
+  if (point && point.offset !== undefined) {
     /** @type {Location} */
     const location = {
       startLine: point.line,
@@ -646,7 +640,7 @@ function endTag(node, state) {
 /**
  * Check if `node` represents a whole document or a fragment.
  *
- * @param {Node} node
+ * @param {Nodes} node
  *   hast node.
  * @returns {boolean}
  *   Whether this represents a whole document or a fragment.
@@ -663,7 +657,7 @@ function documentMode(node) {
 /**
  * Get a `parse5` location from a node.
  *
- * @param {Node | Stitch} node
+ * @param {Nodes | Stitch} node
  *   hast node.
  * @returns {Location}
  *   `parse5` location.
@@ -673,19 +667,23 @@ function createParse5Location(node) {
   const end = pointEnd(node)
 
   return {
-    startLine: start.line,
-    startCol: start.column,
     // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
-    startOffset: start.offset,
-    endLine: end.line,
-    endCol: end.column,
+    startLine: start?.line,
+    // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
+    startCol: start?.column,
+    // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
+    startOffset: start?.offset,
+    // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
+    endLine: end?.line,
+    // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
+    endCol: end?.column,
     // @ts-expect-error: could be `undefined` in hast, which `parse5` types don’t want.
-    endOffset: end.offset
+    endOffset: end?.offset
   }
 }
 
 /**
- * @template {Node} NodeType
+ * @template {Nodes} NodeType
  *   Node type.
  * @param {NodeType} node
  *   Node to clone.

package.json

@@ -34,31 +34,31 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/hast": "^2.0.0",
+    "@types/hast": "^3.0.0",
     "extend": "^3.0.0",
-    "hast-util-from-parse5": "^7.0.0",
-    "hast-util-to-parse5": "^7.0.0",
-    "html-void-elements": "^2.0.0",
-    "mdast-util-to-hast": "^12.0.0",
+    "hast-util-from-parse5": "^8.0.0",
+    "hast-util-to-parse5": "^8.0.0",
+    "html-void-elements": "^3.0.0",
+    "mdast-util-to-hast": "^13.0.0",
     "parse5": "^7.0.0",
-    "unist-util-position": "^4.0.0",
-    "unist-util-visit": "^4.0.0",
-    "vfile": "^5.0.0",
+    "unist-util-position": "^5.0.0",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.0",
     "web-namespaces": "^2.0.0",
     "zwitch": "^2.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "hast-util-to-html": "^8.0.0",
-    "hastscript": "^7.0.0",
-    "mdast-util-from-markdown": "^1.0.0",
+    "hastscript": "^8.0.0",
+    "mdast-util-from-markdown": "^2.0.0",
     "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
-    "unist-builder": "^3.0.0",
+    "unist-builder": "^4.0.0",
     "xo": "^0.55.0"
   },
   "scripts": {

test.js

@@ -859,6 +859,7 @@ test('integration', () => {
   assert.deepEqual(hast2, expected, 'should equal the fixture tree')
 
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(hast2),
     [
       '<p><i>Some title</i></p>',