🤖 Merge PR DefinitelyTyped#72705 feat(esrecurse): add types by @hkleungai

Author: hkleungai

types/esrecurse/.npmignore

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

types/esrecurse/esrecurse-tests.ts

@@ -0,0 +1,74 @@
+import { visit, Visitor } from "esrecurse";
+
+// Mock AST node for testing
+const mockAst = {
+    type: "Program",
+    body: [
+        { type: "Literal", value: 42 },
+        {
+            type: "TestExpression",
+            argument: { type: "Literal", value: 20 },
+            extended: true,
+        },
+    ],
+};
+
+{
+    // $ExpectType Visitor
+    let visitor = new Visitor();
+    // $ExpectType void
+    visitor.visit(mockAst);
+
+    // $ExpectType Visitor
+    visitor = new Visitor(null, {
+        fallback: "iteration",
+        childVisitorKeys: { TestExpression: ["argument"] },
+    });
+    // $ExpectType void
+    visitor.visit(mockAst);
+
+    // $ExpectType Visitor
+    visitor = new Visitor();
+    visitor["Literal"] = (node: any) => {
+        node.value;
+    };
+    // $ExpectType void
+    visitor.visit(mockAst);
+}
+
+{
+    class DerivedVisitor extends Visitor {
+        constructor() {
+            super(null);
+        }
+
+        Literal(node: any) {
+            node.value;
+        }
+    }
+    // $ExpectType DerivedVisitor
+    const derivedVisitor = new DerivedVisitor();
+    // $ExpectType void
+    derivedVisitor.visit(mockAst);
+}
+
+{
+    const objectVisitor = {
+        Literal: (node: any) => {
+            // $ExpectType any
+            node.value;
+        },
+    };
+
+    // $ExpectType void
+    visit(mockAst, objectVisitor);
+
+    // $ExpectType void
+    visit(mockAst, objectVisitor, {
+        fallback: (node: any) => Object.keys(node).filter((key) => key !== "parent"),
+        childVisitorKeys: { TestExpression: ["argument"] },
+    });
+
+    // $ExpectType void
+    visit(mockAst, new Visitor(), { fallback: "iteration" });
+}

types/esrecurse/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Options for the Visitor constructor and visit function.
+ */
+interface VisitorOptions {
+    /**
+     * Fallback strategy for unknown node types.
+     * @default 'iteration'
+     */
+    fallback?: "iteration" | ((node: any) => string[]);
+
+    /**
+     * Custom keys for child nodes by node type.
+     * @default {}
+     */
+    childVisitorKeys?: Record<string, string[]>;
+}
+
+/**
+ * A visitor class for recursively traversing ECMAScript AST.
+ */
+declare class Visitor {
+    /**
+     * Creates a new Visitor instance.
+     * @param options Configuration options for the visitor.
+     */
+    constructor(visitor?: Visitor | null, options?: VisitorOptions | null);
+
+    /**
+     * Visits a node, invoking the appropriate handler.
+     * @param node The AST node to visit.
+     */
+    visit(node: any): void;
+
+    /**
+     * Visits the children of a node based on childVisitorKeys.
+     * @param node The AST node whose children to visit.
+     */
+    visitChildren(node: any): void;
+
+    /**
+     * Dynamically defined methods for specific node types (e.g., Literal, Program).
+     * @param node The AST node to process.
+     */
+    [nodeType: string]: ((node: any) => void) | undefined;
+}
+
+/**
+ * Visits an AST node with the specified visitor.
+ * @param ast The AST node to traverse.
+ * @param visitor A visitor instance or visitor object.
+ * @param options Configuration options for the traversal.
+ */
+declare function visit(
+    ast: any,
+    visitor?: Visitor | Record<string, (node: any) => void> | null,
+    options?: VisitorOptions,
+): void;
+
+export { visit, Visitor, type VisitorOptions };

types/esrecurse/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/esrecurse",
+    "version": "4.3.9999",
+    "projects": [
+        "https://github.com/estools/esrecurse"
+    ],
+    "devDependencies": {
+        "@types/esrecurse": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Jimmy Leung",
+            "githubUsername": "hkleungai"
+        }
+    ]
+}

types/esrecurse/tsconfig.json

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