fix: correct Rule typings (#20199)

jaymarvelz · web-flow · commit b165d471be60 · 2025-10-23T12:17:16.000+02:00
* fix: correct `Rule` typings * fix: further typing improvements * Revert "fix: further typing improvements" This reverts commit 0a5aae4. * test: add type test * test: ensure `JSRuleDefinition#create` returns a `RuleListener`
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -640,16 +640,16 @@ export namespace Rule {
 			LangOptions: Linter.LanguageOptions;
 			Code: SourceCode;
 			RuleOptions: any[];
-			Visitor: NodeListener;
+			Visitor: RuleListener;
 			Node: JSSyntaxElement;
 			MessageIds: string;
 			ExtRuleDocs: {};
 		}> {
-		create(context: RuleContext): NodeListener;
+		create(context: RuleContext): RuleListener;
 	}
 
 	type NodeTypes = ESTree.Node["type"];
-	interface NodeListener extends RuleVisitor {
+	interface NodeListener {
 		ArrayExpression?:
 			| ((node: ESTree.ArrayExpression & NodeParentExtension) => void)
 			| undefined;
@@ -1124,6 +1124,16 @@ export namespace Rule {
 
 		onCodePathSegmentEnd?(segment: CodePathSegment, node: Node): void;
 
+		onUnreachableCodePathSegmentStart?(
+			segment: CodePathSegment,
+			node: Node,
+		): void;
+
+		onUnreachableCodePathSegmentEnd?(
+			segment: CodePathSegment,
+			node: Node,
+		): void;
+
 		onCodePathSegmentLoop?(
 			fromSegment: CodePathSegment,
 			toSegment: CodePathSegment,
@@ -1222,7 +1232,7 @@ export type JSRuleDefinition<
 	{
 		LangOptions: Linter.LanguageOptions;
 		Code: SourceCode;
-		Visitor: Rule.NodeListener;
+		Visitor: Rule.RuleListener;
 		Node: JSSyntaxElement;
 	},
 	Options
diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -807,6 +807,8 @@ rule = {
 			},
 			onCodePathSegmentStart(segment, node) {},
 			onCodePathSegmentEnd(segment, node) {},
+			onUnreachableCodePathSegmentStart(segment, node) {},
+			onUnreachableCodePathSegmentEnd(segment, node) {},
 			onCodePathSegmentLoop(fromSegment, toSegment, node) {},
 			IfStatement(node) {
 				node.parent;
@@ -969,6 +971,27 @@ type DeprecatedRuleContextKeys =
 	},
 });
 
+(): JSRuleDefinition => ({
+	create() {
+		return {
+			onCodePathStart(codePath, node) {},
+			onCodePathSegmentStart(segment, node) {},
+			onCodePathSegmentLoop(fromSegment, toSegment, node) {},
+			Program(node) {},
+			"Program:exit"(node) {},
+		} satisfies Rule.RuleListener;
+	},
+});
+
+(): JSRuleDefinition => ({
+	// @ts-expect-error invalid return type
+	create() {
+		return {
+			foo: null,
+		};
+	},
+});
+
 // #endregion
 
 // #region Linter
