fix: forward traversal step.args to visitors (#20253)

jaymarvelz · web-flow · commit 15f5c7c168d0 · 2025-10-31T16:22:27.000+01:00
diff --git a/lib/linter/source-code-traverser.js b/lib/linter/source-code-traverser.js
@@ -17,8 +17,9 @@ const vk = require("eslint-visitor-keys");
 //-----------------------------------------------------------------------------
 
 /**
- * @import { ESQueryParsedSelector } from "./esquery.js";
  * @import { Language, SourceCode } from "@eslint/core";
+ * @import { ESQueryOptions } from "esquery";
+ * @import { ESQueryParsedSelector } from "./esquery.js";
  * @import { SourceCodeVisitor } from "./source-code-visitor.js";
  */
 
@@ -47,11 +48,10 @@ class ESQueryHelper {
 	 * Creates a new instance.
 	 * @param {SourceCodeVisitor} visitor The visitor containing the functions to call.
 	 * @param {ESQueryOptions} esqueryOptions `esquery` options for traversing custom nodes.
-	 * @returns {NodeEventGenerator} new instance
 	 */
 	constructor(visitor, esqueryOptions) {
 		/**
-		 * The emitter to use during traversal.
+		 * The visitor to use during traversal.
 		 * @type {SourceCodeVisitor}
 		 */
 		this.visitor = visitor;
@@ -288,7 +288,10 @@ class SourceCodeTraverser {
 									false,
 								)
 								.forEach(selector => {
-									visitor.callSync(selector, step.target);
+									visitor.callSync(
+										selector,
+										...(step.args ?? [step.target]),
+									);
 								});
 							currentAncestry.unshift(step.target);
 						} else {
@@ -300,7 +303,10 @@ class SourceCodeTraverser {
 									true,
 								)
 								.forEach(selector => {
-									visitor.callSync(selector, step.target);
+									visitor.callSync(
+										selector,
+										...(step.args ?? [step.target]),
+									);
 								});
 						}
 					} catch (err) {
diff --git a/tests/lib/linter/source-code-traverser.js b/tests/lib/linter/source-code-traverser.js
@@ -232,6 +232,47 @@ describe("SourceCodeTraverser", () => {
 			);
 		});
 
+		it("should pass step.args to visitor", () => {
+			const dummyParent = { type: "Parent", value: 0 };
+			const dummyNode = { type: "Foo", value: 1 };
+			const sourceCode = {
+				ast: dummyNode,
+				visitorKeys: vk.KEYS,
+				*traverse() {
+					yield {
+						kind: STEP_KIND_VISIT,
+						target: dummyNode,
+						phase: 1,
+						args: [dummyNode, dummyParent],
+					};
+					yield {
+						kind: STEP_KIND_VISIT,
+						target: dummyNode,
+						phase: 2,
+						args: [dummyNode, dummyParent],
+					};
+				},
+			};
+
+			traverser.traverseSync(sourceCode, visitor);
+
+			assert(visitor.callSync.calledTwice);
+			assert(
+				visitor.callSync.firstCall.calledWith(
+					"Foo",
+					dummyNode,
+					dummyParent,
+				),
+			);
+			assert(
+				visitor.callSync.secondCall.calledWith(
+					"Foo:exit",
+					dummyNode,
+					dummyParent,
+				),
+			);
+		});
+
 		it("should use provided steps instead of source code traverse", () => {
 			// Create a source code object with normal traverse behavior
 			const fooNode = { type: "Foo", value: 1 };
