feat: support JSRuleDefinition type (#19604)

lumirlumir · web-flow · commit 90228e5d5767 · 2025-04-09T12:11:25.000-04:00
* feat: support `JSRuleDefinition` type

* wip: remove `Rule.RuleModule` from test

* wip: create more tests

* wip: move `JSRuleDefinition` types to top-level export
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -1262,6 +1262,29 @@ export namespace Rule {
 	}
 }
 
+export type JSRuleDefinitionTypeOptions = {
+	RuleOptions: unknown[];
+	MessageIds: string;
+	ExtRuleDocs: Record<string, unknown>;
+};
+
+export type JSRuleDefinition<
+	Options extends Partial<JSRuleDefinitionTypeOptions> = {},
+> = RuleDefinition<
+	// Language specific type options (non-configurable)
+	{
+		LangOptions: Linter.LanguageOptions;
+		Code: SourceCode;
+		Visitor: Rule.NodeListener;
+		Node: ESTree.Node;
+	} & Required<
+		// Rule specific type options (custom)
+		Options &
+			// Rule specific type options (defaults)
+			Omit<JSRuleDefinitionTypeOptions, keyof Options>
+	>
+>;
+
 // #region Linter
 
 export class Linter {
diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -31,6 +31,7 @@ import {
 	Linter,
 	loadESLint,
 	Rule,
+	JSRuleDefinition,
 	RuleTester,
 	Scope,
 	SourceCode,
@@ -52,7 +53,7 @@ import {
 	StaticBlock,
 	WhileStatement,
 } from "estree";
-import { Language, RuleDefinition } from "@eslint/core";
+import { Language, RuleDefinition, SettingsConfig } from "@eslint/core";
 
 const SOURCE = `var foo = bar;`;
 
@@ -809,6 +810,93 @@ type DeprecatedRuleContextKeys =
 	},
 });
 
+// All options optional - JSRuleDefinition and JSRuleDefinition<{}>
+// should be the same type.
+(rule1: JSRuleDefinition, rule2: JSRuleDefinition<{}>) => {
+	rule1 satisfies typeof rule2;
+	rule2 satisfies typeof rule1;
+};
+
+// Type restrictions should be enforced
+(): JSRuleDefinition<{
+	RuleOptions: [string, number];
+	MessageIds: "foo" | "bar";
+	ExtRuleDocs: { foo: string; bar: number };
+}> => ({
+	meta: {
+		messages: {
+			foo: "FOO",
+
+			// @ts-expect-error Wrong type for message ID
+			bar: 42,
+		},
+		docs: {
+			foo: "FOO",
+
+			// @ts-expect-error Wrong type for declared property
+			bar: "BAR",
+
+			// @ts-expect-error Wrong type for predefined property
+			description: 42,
+		},
+	},
+	create({ options }) {
+		// Types for rule options
+		options[0] satisfies string;
+		options[1] satisfies number;
+
+		return {};
+	},
+});
+
+// Undeclared properties should produce an error
+(): JSRuleDefinition<{
+	MessageIds: "foo" | "bar";
+	ExtRuleDocs: { foo: number; bar: string };
+}> => ({
+	meta: {
+		messages: {
+			foo: "FOO",
+
+			// Declared message ID is not required
+			// bar: "BAR",
+
+			// @ts-expect-error Undeclared message ID is not allowed
+			baz: "BAZ",
+		},
+		docs: {
+			foo: 42,
+
+			// Declared property is not required
+			// bar: "BAR",
+
+			// @ts-expect-error Undeclared property key is not allowed
+			baz: "BAZ",
+
+			// Predefined property is allowed
+			description: "Lorem ipsum",
+		},
+	},
+	create() {
+		return {};
+	},
+});
+
+(): JSRuleDefinition => ({
+	create(context) {
+		context.cwd satisfies string; // $ExpectType string
+		context.filename satisfies string; // $ExpectType string
+		context.id satisfies string; // $ExpectType string
+		context.languageOptions satisfies Linter.LanguageOptions; // $ExpectType LanguageOptions
+		context.options satisfies unknown[]; // $ExpectType unknown[]
+		context.physicalFilename satisfies string; // $ExpectType string
+		context.settings satisfies SettingsConfig; // $ExpectType SettingsConfig
+		context.sourceCode satisfies SourceCode; // $ExpectType SourceCode
+
+		return {};
+	},
+});
+
 // #endregion
 
 // #region Linter
