Update types and tests for changes in parse5

Author: wooorm

lib/index.js

@@ -12,15 +12,16 @@
  * @typedef {Parent['children'][number]} Child
  * @typedef {Element['children'][number]} ElementChild
  * @typedef {Child|Root} Node
- * @typedef {import('parse5').Document} P5Document
- * @typedef {import('parse5').DocumentType} P5Doctype
- * @typedef {import('parse5').CommentNode} P5Comment
- * @typedef {import('parse5').TextNode} P5Text
- * @typedef {import('parse5').Element} P5Element
- * @typedef {import('parse5').ElementLocation} P5ElementLocation
- * @typedef {import('parse5').Location} P5Location
- * @typedef {import('parse5').Attribute} P5Attribute
- * @typedef {import('parse5').Node} P5Node
+ * @typedef {import('parse5').DefaultTreeAdapterMap} DefaultTreeAdapterMap
+ * @typedef {DefaultTreeAdapterMap['document']} P5Document
+ * @typedef {DefaultTreeAdapterMap['documentFragment']} P5Fragment
+ * @typedef {DefaultTreeAdapterMap['commentNode']} P5Comment
+ * @typedef {DefaultTreeAdapterMap['textNode']} P5Text
+ * @typedef {DefaultTreeAdapterMap['element']} P5Element
+ * @typedef {import('parse5/dist/common/token.js').ElementLocation} P5ElementLocation
+ * @typedef {import('parse5/dist/common/token.js').Location} P5Location
+ * @typedef {import('parse5/dist/common/token.js').Attribute} P5Attribute
+ * @typedef {DefaultTreeAdapterMap['node']} P5Node
  *
  * @typedef {'html'|'svg'} Space
  *
@@ -116,7 +117,6 @@ function transform(ctx, ast) {
   const result = fn(ctx, ast, children)
 
   if ('sourceCodeLocation' in ast && ast.sourceCodeLocation && ctx.file) {
-    // @ts-expect-error It’s fine.
     const position = createLocation(ctx, result, ast.sourceCodeLocation)
 
     if (position) {
@@ -297,6 +297,7 @@ function createLocation(ctx, node, location) {
 
       node.data = {
         position: {
+          // @ts-expect-error: assume not `undefined`.
           opening: position(location.startTag),
           closing: location.endTag ? position(location.endTag) : null,
           properties: props

package.json

@@ -34,7 +34,6 @@
   ],
   "dependencies": {
     "@types/hast": "^2.0.0",
-    "@types/parse5": "^6.0.0",
     "@types/unist": "^2.0.0",
     "hastscript": "^7.0.0",
     "property-information": "^6.0.0",
@@ -46,7 +45,7 @@
     "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "is-hidden": "^2.0.0",
-    "parse5": "^6.0.0",
+    "parse5": "^7.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^10.0.0",
     "remark-preset-wooorm": "^9.0.0",

readme.md

@@ -33,13 +33,13 @@ Say we have the following file, `example.html`:
 And our script, `example.js`, looks as follows:
 
 ```js
-import parse5 from 'parse5'
+import {parse} from 'parse5'
 import {readSync} from 'to-vfile'
 import {inspect} from 'unist-util-inspect'
 import {fromParse5} from 'hast-util-from-parse5'
 
 const file = readSync('example.html')
-const p5ast = parse5.parse(String(file), {sourceCodeLocationInfo: true})
+const p5ast = parse(String(file), {sourceCodeLocationInfo: true})
 const hast = fromParse5(p5ast, file)
 
 console.log(inspect(hast))

test/index.js

@@ -13,7 +13,7 @@ import path from 'node:path'
 import assert from 'node:assert'
 import test from 'tape'
 import {isHidden} from 'is-hidden'
-import parse5 from 'parse5'
+import {parse, parseFragment} from 'parse5'
 import {visit} from 'unist-util-visit'
 import {toVFile} from 'to-vfile'
 import {fromParse5} from '../index.js'
@@ -24,7 +24,7 @@ test('hast-util-from-parse5', (t) => {
   const file = toVFile({value: '<title>Hello!</title><h1>World!'})
 
   t.deepEqual(
-    fromParse5(parse5.parse(String(file))),
+    fromParse5(parse(String(file))),
     {
       type: 'root',
       children: [
@@ -68,7 +68,7 @@ test('hast-util-from-parse5', (t) => {
   )
 
   t.deepEqual(
-    fromParse5(parse5.parseFragment(String(file))),
+    fromParse5(parseFragment(String(file))),
     {
       type: 'root',
       children: [
@@ -91,10 +91,7 @@ test('hast-util-from-parse5', (t) => {
   )
 
   t.deepEqual(
-    fromParse5(
-      parse5.parse(String(file), {sourceCodeLocationInfo: true}),
-      file
-    ),
+    fromParse5(parse(String(file), {sourceCodeLocationInfo: true}), file),
     {
       type: 'root',
       children: [
@@ -168,7 +165,7 @@ test('hast-util-from-parse5', (t) => {
   )
 
   t.deepEqual(
-    fromParse5(parse5.parse(String(file)), file),
+    fromParse5(parse(String(file)), file),
     {
       type: 'root',
       children: [
@@ -227,16 +224,17 @@ test('hast-util-from-parse5', (t) => {
         nodeName: 'title',
         tagName: 'title',
         attrs: [],
+        // @ts-expect-error: fine.
         namespaceURI: 'http://www.w3.org/1999/xhtml',
         childNodes: [
           {
             nodeName: '#text',
             value: 'Hello!',
-            // @ts-expect-error runtime.
+            // @ts-expect-error: fine.
             sourceCodeLocation: {}
           }
         ],
-        // @ts-expect-error runtime.
+        // @ts-expect-error: fine.
         sourceCodeLocation: {
           startLine: 1,
           startCol: 1,
@@ -266,11 +264,12 @@ test('hast-util-from-parse5', (t) => {
         nodeName: 'p',
         tagName: 'p',
         attrs: [],
+        // @ts-expect-error: fine.
         namespaceURI: 'http://www.w3.org/1999/xhtml',
         childNodes: [
-          // @ts-expect-error runtime.
           {
             nodeName: '#text',
+            // @ts-expect-error: fine.
             value: 'Hello!',
             sourceCodeLocation: {
               startLine: 1,
@@ -282,7 +281,7 @@ test('hast-util-from-parse5', (t) => {
             }
           }
         ],
-        // @ts-expect-error runtime.
+        // @ts-expect-error: fine.
         sourceCodeLocation: {
           startLine: 1,
           startCol: 1,
@@ -315,7 +314,7 @@ test('hast-util-from-parse5', (t) => {
 
   t.deepEqual(
     fromParse5(
-      parse5.parseFragment(
+      parseFragment(
         [
           '<svg width="230" height="120" viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">',
           '<circle cx="60"  cy="60" r="50" fill="red"/>',
@@ -394,7 +393,7 @@ test('fixtures', (t) => {
    * @param {Options} options
    */
   function checkYesYes(t, options) {
-    const input = parse5.parse(String(options.file), {
+    const input = parse(String(options.file), {
       sourceCodeLocationInfo: true
     })
     const actual = fromParse5(input, {file: options.file, verbose: true})
@@ -418,7 +417,7 @@ test('fixtures', (t) => {
    * @param {Options} options
    */
   function checkNoYes(t, options) {
-    const input = parse5.parse(String(options.file))
+    const input = parse(String(options.file))
     const actual = fromParse5(input, {file: options.file, verbose: true})
     /** @type {Node} */
     const expected = JSON.parse(String(fs.readFileSync(options.out)))
@@ -434,7 +433,7 @@ test('fixtures', (t) => {
    * @param {Options} options
    */
   function checkYesNo(t, options) {
-    const input = parse5.parse(String(options.file), {
+    const input = parse(String(options.file), {
       sourceCodeLocationInfo: true
     })
     const actual = fromParse5(input)
@@ -452,7 +451,7 @@ test('fixtures', (t) => {
    * @param {Options} options
    */
   function checkNoNo(t, options) {
-    const input = parse5.parse(String(options.file))
+    const input = parse(String(options.file))
     const actual = fromParse5(input)
     /** @type {Node} */
     const expected = JSON.parse(String(fs.readFileSync(options.out)))