🤖 Merge PR DefinitelyTyped#74468 Add types for html-parse-stringify by @gasp

Author: gasp

types/html-parse-stringify/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/html-parse-stringify/html-parse-stringify-tests.ts

@@ -0,0 +1,52 @@
+import { ASTNode, CommentNode, parse, ParseOptions, stringify, TagNode, TextNode } from "html-parse-stringify";
+
+// Test parse function
+const ast: ASTNode[] = parse("<div class=\"oh\"><p>hi</p></div>");
+
+// Test parse with options
+const astWithOpts: ASTNode[] = parse("<div><my-component></my-component></div>", {
+    components: {
+        "my-component": true,
+    },
+});
+
+// Test stringify function
+const htmlString: string = stringify(ast);
+
+// Test roundtrip
+const ast2: ASTNode[] = parse("<p>hello</p>");
+const html2: string = stringify(ast2);
+
+// Test node type narrowing
+for (const node of ast) {
+    if (node.type === "tag") {
+        const tagNode: TagNode = node;
+        const name: string = tagNode.name;
+        const attrs: { [key: string]: string } = tagNode.attrs;
+        const isVoid: boolean = tagNode.voidElement;
+        const children: ASTNode[] = tagNode.children;
+    } else if (node.type === "text") {
+        const textNode: TextNode = node;
+        const content: string = textNode.content;
+    } else if (node.type === "comment") {
+        const commentNode: CommentNode = node;
+        const comment: string = commentNode.comment;
+    } else if (node.type === "component") {
+        const name: string = node.name;
+        const attrs: { [key: string]: string } = node.attrs;
+    }
+}
+
+// Test with complex HTML
+const complexAst = parse(`
+    <div id="main" class="container">
+        <h1>Title</h1>
+        <!-- A comment -->
+        <p>Some <strong>bold</strong> text</p>
+        <img src="image.jpg" />
+    </div>
+`);
+
+// Test roundtrip
+const original = "<div><p>test</p></div>";
+const roundtrip: string = stringify(parse(original));

types/html-parse-stringify/index.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Attributes object for a tag node.
+ */
+export interface Attributes {
+    [key: string]: string;
+}
+
+/**
+ * A tag node in the AST.
+ */
+export interface TagNode {
+    type: "tag";
+    name: string;
+    attrs: Attributes;
+    voidElement: boolean;
+    children: ASTNode[];
+}
+
+/**
+ * A text node in the AST.
+ */
+export interface TextNode {
+    type: "text";
+    content: string;
+}
+
+/**
+ * A comment node in the AST.
+ */
+export interface CommentNode {
+    type: "comment";
+    comment: string;
+}
+
+/**
+ * A component node in the AST.
+ * Similar to tag but children are ignored during parsing.
+ */
+export interface ComponentNode {
+    type: "component";
+    name: string;
+    attrs: Attributes;
+    voidElement: boolean;
+    children: ASTNode[];
+}
+
+/**
+ * Any AST node type.
+ */
+export type ASTNode = TagNode | TextNode | CommentNode | ComponentNode;
+
+/**
+ * Options for parsing HTML.
+ */
+export interface ParseOptions {
+    /**
+     * Object of registered component names whose children will be ignored
+     * when generating the AST.
+     */
+    components?: {
+        [componentName: string]: boolean | object;
+    };
+}
+
+/**
+ * Parses a string of HTML into an AST.
+ *
+ * @param html - The HTML string to parse
+ * @param options - Parse options
+ * @returns An array of AST nodes
+ *
+ * @example
+ * ```javascript
+ * var HTML = require('html-parse-stringify');
+ * var ast = HTML.parse('<div class="oh"><p>hi</p></div>');
+ * ```
+ */
+export function parse(html: string, options?: ParseOptions): ASTNode[];
+
+/**
+ * Stringifies an AST back to HTML.
+ *
+ * @param ast - The AST to stringify
+ * @returns The HTML string
+ *
+ * @example
+ * ```javascript
+ * var HTML = require('html-parse-stringify');
+ * var html = HTML.stringify(ast);
+ * ```
+ */
+export function stringify(ast: ASTNode[]): string;

types/html-parse-stringify/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/html-parse-stringify",
+    "version": "3.0.9999",
+    "projects": [
+        "https://github.com/henrikjoreteg/html-parse-stringify"
+    ],
+    "devDependencies": {
+        "@types/html-parse-stringify": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "gaspard",
+            "githubUsername": "gasp"
+        }
+    ]
+}

types/html-parse-stringify/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "html-parse-stringify-tests.ts"
+    ]
+}