Update @types/hast, @types/mdast, utilities

Author: wooorm

lib/footer.js

@@ -57,6 +57,7 @@ export function footer(state) {
         backReference.children.push({
           type: 'element',
           tagName: 'sup',
+          properties: {},
           children: [{type: 'text', value: String(referenceIndex)}]
         })
       }

lib/handlers/footnote.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {import('hast').Element} Element
- * @typedef {import('mdast').Footnote} Footnote
+ * @typedef {import('mdast').Node} Node
  * @typedef {import('../state.js').State} State
  */
 
@@ -17,7 +17,7 @@ import {footnoteReference} from './footnote-reference.js'
  *
  * @param {State} state
  *   Info passed around.
- * @param {Footnote} node
+ * @param {Node} node
  *   mdast node.
  * @returns {Element}
  *   hast node.
@@ -33,6 +33,7 @@ export function footnote(state, node) {
   footnoteById[identifier] = {
     type: 'footnoteDefinition',
     identifier,
+    // @ts-expect-error: to do: remove this.
     children: [{type: 'paragraph', children: node.children}],
     position: node.position
   }

lib/handlers/table.js

@@ -45,7 +45,7 @@ export function table(state, node) {
 
     const start = pointStart(node.children[1])
     const end = pointEnd(node.children[node.children.length - 1])
-    if (start.line && end.line) body.position = {start, end}
+    if (start && end) body.position = {start, end}
     tableContent.push(body)
   }
 

lib/state.js

@@ -444,11 +444,6 @@ function applyData(from, to) {
 export function one(state, node, parent) {
   const type = node && node.type
 
-  // Fail on non-nodes.
-  if (!type) {
-    throw new Error('Expected node, got `' + node + '`')
-  }
-
   if (own.call(state.handlers, type)) {
     return state.handlers[type](state, node, parent)
   }

package.json

@@ -35,23 +35,23 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/hast": "^2.0.0",
-    "@types/mdast": "^3.0.0",
-    "mdast-util-definitions": "^5.0.0",
-    "micromark-util-sanitize-uri": "^1.1.0",
+    "@types/hast": "^3.0.0",
+    "@types/mdast": "^4.0.0",
+    "mdast-util-definitions": "^6.0.0",
+    "micromark-util-sanitize-uri": "^2.0.0",
     "trim-lines": "^3.0.0",
-    "unist-util-generated": "^2.0.0",
-    "unist-util-position": "^4.0.0",
-    "unist-util-visit": "^4.0.0"
+    "unist-util-generated": "^3.0.0",
+    "unist-util-position": "^5.0.0",
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "hast-util-to-html": "^8.0.4",
     "hastscript": "^7.0.0",
-    "mdast-util-from-markdown": "^1.0.0",
-    "mdast-util-gfm": "^2.0.0",
-    "micromark-extension-gfm": "^2.0.0",
+    "mdast-util-from-markdown": "^2.0.0",
+    "mdast-util-gfm": "^3.0.0",
+    "micromark-extension-gfm": "^3.0.0",
     "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",

test/core.js

@@ -11,14 +11,10 @@ test('toHast', () => {
     'should expose the public api'
   )
 
-  assert.throws(
-    () => {
-      // @ts-expect-error runtime.
-      toHast({type: 'bar', children: [true]})
-    },
-    /Expected node, got `true`/,
-    'should throw on non-nodes'
-  )
+  assert.throws(() => {
+    // @ts-expect-error runtime.
+    toHast({type: 'bar', children: [true]})
+  }, 'should throw on non-nodes')
 
   assert.deepEqual(
     toHast({
@@ -65,8 +61,8 @@ test('toHast', () => {
       properties: {},
       children: [{type: 'text', value: 'foxtrot'}],
       position: {
-        start: {line: 2, column: 3, offset: null},
-        end: {line: 2, column: 12, offset: null}
+        start: {line: 2, column: 3, offset: undefined},
+        end: {line: 2, column: 12, offset: undefined}
       }
     },
     'should patch `position`s when given'
@@ -92,14 +88,14 @@ test('toHast', () => {
           properties: {},
           children: [{type: 'text', value: 'golf\n'}],
           position: {
-            start: {line: 2, column: 3, offset: null},
-            end: {line: 2, column: 12, offset: null}
+            start: {line: 2, column: 3, offset: undefined},
+            end: {line: 2, column: 12, offset: undefined}
           }
         }
       ],
       position: {
-        start: {line: 2, column: 3, offset: null},
-        end: {line: 2, column: 12, offset: null}
+        start: {line: 2, column: 3, offset: undefined},
+        end: {line: 2, column: 12, offset: undefined}
       }
     },
     'should patch `position`s on `pre` and `code`'
@@ -120,8 +116,8 @@ test('toHast', () => {
       properties: {},
       children: [{type: 'text', value: 'foxtrot'}],
       position: {
-        start: {line: 2, column: 3, offset: null},
-        end: {line: 2, column: 12, offset: null}
+        start: {line: 2, column: 3, offset: undefined},
+        end: {line: 2, column: 12, offset: undefined}
       }
     },
     'should patch `position`s when given'
@@ -147,14 +143,14 @@ test('toHast', () => {
           properties: {},
           children: [{type: 'text', value: 'golf\n'}],
           position: {
-            start: {line: 2, column: 3, offset: null},
-            end: {line: 2, column: 12, offset: null}
+            start: {line: 2, column: 3, offset: undefined},
+            end: {line: 2, column: 12, offset: undefined}
           }
         }
       ],
       position: {
-        start: {line: 2, column: 3, offset: null},
-        end: {line: 2, column: 12, offset: null}
+        start: {line: 2, column: 3, offset: undefined},
+        end: {line: 2, column: 12, offset: undefined}
       }
     },
     'should patch `position`s on `pre` and `code`'

test/footnote-mixed.js

@@ -11,6 +11,7 @@ test('footnote', () => {
         type: 'paragraph',
         children: [
           {type: 'text', value: 'alpha'},
+          // @ts-expect-error: to do: remove.
           {type: 'footnote', children: [{type: 'text', value: 'bravo'}]}
         ]
       },
@@ -33,6 +34,7 @@ test('footnote', () => {
   assert(mdast, 'expected node')
 
   assert.deepEqual(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(mdast),
     `<p>alpha<sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <p>charlie<sup><a href="#user-content-fn-x" id="user-content-fnref-x" data-footnote-ref aria-describedby="footnote-label">2</a></sup></p>

test/footnote.js

@@ -9,10 +9,12 @@ import {toHast} from '../index.js'
 test('footnote', () => {
   let tree = toHast({
     type: 'root',
+    // @ts-expect-error: to do: remove `footnote`s.
     children: [{type: 'footnote', children: [{type: 'text', value: 'alpha'}]}]
   })
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>
@@ -39,11 +41,13 @@ test('footnote', () => {
         type: 'paragraph',
         children: [{type: 'footnoteReference', identifier: '1'}]
       },
+      // @ts-expect-error: to do: remove `footnote`s.
       {type: 'footnote', children: [{type: 'text', value: 'charlie'}]}
     ]
   })
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <sup><a href="#user-content-fn-2" id="user-content-fnref-2" data-footnote-ref aria-describedby="footnote-label">2</a></sup>
@@ -83,6 +87,7 @@ test('footnote', () => {
   })
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>
@@ -112,6 +117,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<table>
 <thead>
@@ -153,6 +159,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<table>
 <thead>
@@ -183,6 +190,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p>Call<sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup><sup><a href="#user-content-fn-1" id="user-content-fnref-1-2" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>
@@ -204,6 +212,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Voetnoten</h2>
@@ -225,6 +234,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#fn-1" id="fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>
@@ -246,6 +256,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h1 class="sr-only" id="footnote-label">Footnotes</h1>
@@ -267,6 +278,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p><sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref aria-describedby="footnote-label">1</a></sup></p>
 <section data-footnotes class="footnotes"><h2 id="footnote-label">Footnotes</h2>
@@ -290,6 +302,7 @@ test('footnote', () => {
   )
   assert(tree, 'expected node')
   assert.equal(
+    // @ts-expect-error: to do: remove when `to-html` is released.
     toHtml(tree),
     `<p>a<sup><a href="#user-content-fn-__proto__" id="user-content-fnref-__proto__" data-footnote-ref aria-describedby="footnote-label">1</a></sup> b<sup><a href="#user-content-fn-__proto__" id="user-content-fnref-__proto__-2" data-footnote-ref aria-describedby="footnote-label">1</a></sup> c<sup><a href="#user-content-fn-constructor" id="user-content-fnref-constructor" data-footnote-ref aria-describedby="footnote-label">2</a></sup></p>
 <section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>