feat(eslint-plugin): expose rule name via RuleModule interface (#11616)

* feat: expose rule name on RuleModule interface

* fix: resolve type errors after adding name to RuleModule

* Update packages/utils/src/ts-eslint/Rule.ts

Co-authored-by: Josh Goldberg ✨ <[email protected]>

* Update packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars-eslint.test.ts

Co-authored-by: Josh Goldberg ✨ <[email protected]>

* fix: update rule name in no-unused-vars test to match definition

* refactor: add name property to RuleWithMeta

---------

Co-authored-by: Josh Goldberg ✨ <[email protected]>

Author: y-hsgw

packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars-eslint.test.ts

@@ -40,6 +40,7 @@ ruleTester.defineRule('use-every-a', {
     schema: [],
     type: 'problem',
   },
+  name: 'use-every-a',
 });
 
 /**

packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars.test.ts

@@ -32,6 +32,7 @@ ruleTester.defineRule('collect-unused-vars', {
     schema: [],
     type: 'problem',
   },
+  name: 'collect-unused-vars',
 });
 
 ruleTester.run('no-unused-vars', rule, {

packages/rule-tester/tests/RuleTester.test.ts

@@ -94,6 +94,7 @@ const NOOP_RULE: RuleModule<'error'> = {
     schema: [],
     type: 'problem',
   },
+  name: 'rule',
 };
 
 function windowsToPosixPath(p: string): string {
@@ -1108,6 +1109,7 @@ describe('RuleTester - hooks', () => {
       schema: [],
       type: 'problem',
     },
+    name: 'rule',
   };
 
   const ruleTester = new RuleTester();
@@ -1331,6 +1333,7 @@ describe('RuleTester - multipass fixer', () => {
         schema: [],
         type: 'problem',
       },
+      name: 'rule',
     };
 
     it('passes with no output', () => {
@@ -1416,6 +1419,7 @@ describe('RuleTester - multipass fixer', () => {
         schema: [],
         type: 'problem',
       },
+      name: 'rule',
     };
 
     it('passes with correct string output', () => {
@@ -1538,6 +1542,7 @@ describe('RuleTester - multipass fixer', () => {
         schema: [],
         type: 'problem',
       },
+      name: 'rule',
     };
 
     it('passes with correct array output', () => {
@@ -1644,6 +1649,7 @@ describe('RuleTester - run types', () => {
       ],
       type: 'suggestion',
     },
+    name: 'rule',
   };
 
   describe('infer from `rule` parameter', () => {

packages/rule-tester/tests/filename.test.ts

@@ -19,6 +19,7 @@ const rule = ESLintUtils.RuleCreator.withoutDocs({
     type: 'problem',
     hasSuggestions: true,
   },
+  name: 'rule',
   defaultOptions: [],
   create: context => ({
     Program(node): void {

packages/utils/src/eslint-utils/RuleCreator.ts

@@ -36,6 +36,7 @@ export interface RuleWithMeta<
   Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
   meta: RuleMetaData<MessageIds, Docs, Options>;
+  name: string;
 }
 
 export interface RuleWithMetaAndName<
@@ -76,6 +77,7 @@ export function RuleCreator<PluginDocs = unknown>(
           url: urlCreator(name),
         },
       },
+      name,
       ...rule,
     });
   };
@@ -89,6 +91,7 @@ function createRule<
   create,
   defaultOptions,
   meta,
+  name,
 }: Readonly<RuleWithMeta<Options, MessageIds, PluginDocs>>): RuleModule<
   MessageIds,
   Options,
@@ -101,6 +104,7 @@ function createRule<
     },
     defaultOptions,
     meta,
+    name,
   };
 }
 

packages/utils/src/ts-eslint/Rule.ts

@@ -735,6 +735,11 @@ export interface RuleModule<
    * Metadata about the rule
    */
   meta: RuleMetaData<MessageIds, Docs, Options>;
+
+  /**
+   * Rule name
+   */
+  name: string;
 }
 
 export type AnyRuleModule = RuleModule<string, readonly unknown[]>;