chore (labs/compiler, labs/ssr, localize-tools): update parse5/tools (#…

…4175) Bumping `@parse5/tools` up so we can benefit from this easier import: ```ts // new... import {Element} from '@parse5/tools'; // previously... import {DefaultTreeAdapterMap} from 'parse5'; type Element = DefaultTreeAdapterMap['element']; ```
lit · Sep 3, 2023 · 84bb052 · 84bb052
1 parent c9f12f6
commit 84bb052
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 46 deletions.
diff --git a/.changeset/swift-badgers-suffer.md b/.changeset/swift-badgers-suffer.md
@@ -0,0 +1,7 @@
+---
+'@lit/localize-tools': patch
+'@lit-labs/compiler': patch
+'@lit-labs/ssr': patch
+---
+
+Update parse5/tools to simplify importing of node types from the default tree adapter
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/labs/compiler/package.json b/packages/labs/compiler/package.json
@@ -103,7 +103,7 @@
     }
   },
   "dependencies": {
-    "@parse5/tools": "^0.2.0",
+    "@parse5/tools": "^0.3.0",
     "lit-html": "^2.7.5",
     "parse5": "^7.1.2",
     "typescript": "~5.2.0"

diff --git a/packages/labs/ssr/package.json b/packages/labs/ssr/package.json
@@ -209,7 +209,7 @@
     "@lit-labs/ssr-client": "^1.1.0",
     "@lit-labs/ssr-dom-shim": "^1.1.0",
     "@lit/reactive-element": "^1.6.0",
-    "@parse5/tools": "^0.1.0",
+    "@parse5/tools": "^0.3.0",
     "@types/node": "^16.0.0",
     "enhanced-resolve": "^5.10.0",
     "lit": "^2.7.0",

diff --git a/packages/labs/ssr/src/lib/util/parse5-utils.ts b/packages/labs/ssr/src/lib/util/parse5-utils.ts
@@ -4,11 +4,16 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-import {DefaultTreeAdapterMap} from 'parse5';
-import {traverse, replaceWith, isElementNode} from '@parse5/tools';
+import {
+  traverse,
+  replaceWith,
+  isElementNode,
+  Element,
+  Node,
+} from '@parse5/tools';
 
-export function removeFakeRootElements(node: DefaultTreeAdapterMap['node']) {
-  const fakeRootElements: DefaultTreeAdapterMap['element'][] = [];
+export function removeFakeRootElements(node: Node) {
+  const fakeRootElements: Element[] = [];
 
   traverse(node, {
     'pre:node': (node) => {

diff --git a/packages/localize-tools/package.json b/packages/localize-tools/package.json
@@ -137,6 +137,7 @@
     "jsonschema": "^1.4.0",
     "lit": "^2.7.0",
     "minimist": "^1.2.5",
+    "@parse5/tools": "^0.3.0",
     "parse5": "^7.1.1",
     "source-map-support": "^0.5.19",
     "typescript": "^4.7.4"

diff --git a/packages/localize-tools/src/program-analysis.ts b/packages/localize-tools/src/program-analysis.ts
@@ -6,6 +6,7 @@
 
 import ts from 'typescript';
 import * as parse5 from 'parse5';
+import {ChildNode, ParentNode, TextNode, CommentNode} from '@parse5/tools';
 import {ProgramMessage, Placeholder} from './messages.js';
 import {createDiagnostic} from './typescript.js';
 import {
@@ -514,15 +515,13 @@ function replaceHtmlWithPlaceholders(
 ): Array<string | Omit<Placeholder, 'index'>> {
   const components: Array<string | Omit<Placeholder, 'index'>> = [];
 
-  const traverse = (node: parse5.DefaultTreeAdapterMap['childNode']): void => {
+  const traverse = (node: ChildNode): void => {
     if (node.nodeName === '#text') {
-      const text = (node as parse5.DefaultTreeAdapterMap['textNode']).value;
+      const text = (node as TextNode).value;
       components.push(text);
     } else if (node.nodeName === '#comment') {
       components.push({
-        untranslatable: serializeComment(
-          node as parse5.DefaultTreeAdapterMap['commentNode']
-        ),
+        untranslatable: serializeComment(node as CommentNode),
       });
     } else {
       const {open, close} = serializeOpenCloseTags(node);
@@ -551,19 +550,17 @@ function replaceHtmlWithPlaceholders(
  *
  *   <b class="red">foo</b> --> {open: '<b class="red">, close: '</b>'}
  */
-function serializeOpenCloseTags(
-  node: parse5.DefaultTreeAdapterMap['childNode']
-): {
+function serializeOpenCloseTags(node: ChildNode): {
   open: string;
   close: string;
 } {
-  const withoutChildren: parse5.DefaultTreeAdapterMap['childNode'] = {
+  const withoutChildren: ChildNode = {
     ...node,
     childNodes: [],
   };
   const fakeParent = {
     childNodes: [withoutChildren],
-  } as parse5.DefaultTreeAdapterMap['parentNode'];
+  } as ParentNode;
   const serialized = parse5.serialize(fakeParent);
   const lastLt = serialized.lastIndexOf('<');
   const open = serialized.slice(0, lastLt);
@@ -578,12 +575,10 @@ function serializeOpenCloseTags(
  *
  *   {data: "foo"} --> "<!-- foo -->"
  */
-function serializeComment(
-  comment: parse5.DefaultTreeAdapterMap['commentNode']
-): string {
+function serializeComment(comment: CommentNode): string {
   return parse5.serialize({
     childNodes: [comment],
-  } as parse5.DefaultTreeAdapterMap['parentNode']);
+  } as ParentNode);
 }
 
 /**