Oct 25, 2025 · Oct 25, 2025 · Nov 3, 2025 · Nov 3, 2025 · Nov 3, 2025 · Nov 18, 2025
diff --git a/packages/rule-tester/src/RuleTester.ts b/packages/rule-tester/src/RuleTester.ts
  defineRule(name: string, rule: AnyRuleModule): void {
    this.#rules[name] = {
      ...rule,
      name,
      // Create a wrapper rule that freezes the `context` properties.
      create(context): RuleListener {
        freezeDeeply(context.options);
diff --git a/packages/utils/src/eslint-utils/RuleCreator.ts b/packages/utils/src/eslint-utils/RuleCreator.ts
  Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
  meta: RuleMetaData<MessageIds, Docs, Options>;
  name?: string;
 }

 export interface RuleWithMetaAndName<
  name: string;
 }

 type RuleModuleWithName<
  MessageIds extends string,
  Options extends readonly unknown[] = [],
  Docs = unknown,
  ExtendedRuleListener extends RuleListener = RuleListener,
 > = RuleModule<MessageIds, Options, Docs, ExtendedRuleListener> & {
  name: string;
 };

 /**
 * Creates reusable function to create rules with default options and docs URLs.
 *
    ...rule
  }: Readonly<
    RuleWithMetaAndName<Options, MessageIds, PluginDocs>
  >):RuleModule<MessageIds, Options, PluginDocs> {
 return createRule<Options, MessageIds, PluginDocs>({
  >):RuleModuleWithName<MessageIds, Options, PluginDocs> {
 const ruleWithDocs = createRule<Options, MessageIds, PluginDocs>({
      meta: {
        ...meta,
        docs: {
          ...meta.docs,
          url: urlCreator(name),
        },
      },
      name,
      ...rule,
    });

    return ruleWithDocs as RuleModuleWithName<MessageIds, Options, PluginDocs>;
  };
 }

  create,
  defaultOptions,
  meta,
  name,
 }: Readonly<RuleWithMeta<Options, MessageIds, PluginDocs>>): RuleModule<
  MessageIds,
  Options,
    },
    defaultOptions,
    meta,
    name,
  };
 }

diff --git a/packages/utils/src/ts-eslint/Rule.ts b/packages/utils/src/ts-eslint/Rule.ts
   * Metadata about the rule
   */
  meta: RuleMetaData<MessageIds, Docs, Options>;

  /**
   * Rule name
   */
  name?: string;
 }

 export type AnyRuleModule = RuleModule<string, readonly unknown[]>;
diff --git a/packages/utils/tests/eslint-utils/RuleCreator.test.ts b/packages/utils/tests/eslint-utils/RuleCreator.test.ts
      schema: [],
      type: 'problem',
    });
    expect(rule.name).toBe('test');
  });

  it('withoutDocs should work without a `name`', () => {
    const rule = ESLintUtils.RuleCreator.withoutDocs({
      create() {
        return {};
      },
      defaultOptions: [],
      meta: {
        docs: {
          description: 'some description',
        },
        messages: {
          foo: 'some message',
        },
        schema: [],
        type: 'problem',
      },
    });

    expect(rule.meta.docs).toEqual({
      description: 'some description',
    });
    expect(rule.name).toBeUndefined();
  });

  it('withoutDocs should work with a `name`', () => {
    const rule = ESLintUtils.RuleCreator.withoutDocs({
      create() {
        return {};
      },
      defaultOptions: [],
      meta: {
        docs: {
          description: 'some description',
        },
        messages: {
          foo: 'some message',
        },
        schema: [],
        type: 'problem',
      },
      name: 'some-name',
    });

    expect(rule.meta.docs).toEqual({
      description: 'some description',
    });
    expect(rule.name).toBe('some-name');
  });
 });
Original file line number	Diff line number	Diff line change
Expand Up		@@ -427,6 +427,7 @@ export class RuleTester extends TestFramework {
		defineRule(name: string, rule: AnyRuleModule): void {
		this.#rules[name] = {
		...rule,
		name,
		// Create a wrapper rule that freezes the `context` properties.
		create(context): RuleListener {
		freezeDeeply(context.options);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,6 +36,7 @@ export interface RuleWithMeta<
		Docs = unknown,
		> extends RuleCreateAndOptions<Options, MessageIds> {
		meta: RuleMetaData<MessageIds, Docs, Options>;
		name?: string;
		}

		export interface RuleWithMetaAndName<
Expand All		@@ -47,6 +48,15 @@ export interface RuleWithMetaAndName<
		name: string;
		}

		type RuleModuleWithName<
		MessageIds extends string,
		Options extends readonly unknown[] = [],
		Docs = unknown,
		ExtendedRuleListener extends RuleListener = RuleListener,
		> = RuleModule<MessageIds, Options, Docs, ExtendedRuleListener> & {
		name: string;
		};

		/**
		* Creates reusable function to create rules with default options and docs URLs.
		*
Expand All		@@ -67,17 +77,20 @@ export function RuleCreator<PluginDocs = unknown>(
		...rule
		}: Readonly<
		RuleWithMetaAndName<Options, MessageIds, PluginDocs>
		>):RuleModule<MessageIds, Options, PluginDocs> {
		return createRule<Options, MessageIds, PluginDocs>({
		>):RuleModuleWithName<MessageIds, Options, PluginDocs> {
		const ruleWithDocs = createRule<Options, MessageIds, PluginDocs>({
		meta: {
		...meta,
		docs: {
		...meta.docs,
		url: urlCreator(name),
		},
		},
		name,
		...rule,
		});

		return ruleWithDocs as RuleModuleWithName<MessageIds, Options, PluginDocs>;
		};
		}

Expand All		@@ -89,6 +102,7 @@ function createRule<
		create,
		defaultOptions,
		meta,
		name,
		}: Readonly<RuleWithMeta<Options, MessageIds, PluginDocs>>): RuleModule<
		MessageIds,
		Options,
Expand All		@@ -101,6 +115,7 @@ function createRule<
		},
		defaultOptions,
		meta,
		name,
		};
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -737,6 +737,11 @@ export interface RuleModule<
		* Metadata about the rule
		*/
		meta: RuleMetaData<MessageIds, Docs, Options>;

		/**
		* Rule name
		*/
		name?: string;
		}

		export type AnyRuleModule = RuleModule<string, readonly unknown[]>;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,5 +42,55 @@ describe(ESLintUtils.RuleCreator, () => {
		schema: [],
		type: 'problem',
		});
		expect(rule.name).toBe('test');
kirkwaiblinger marked this conversation as resolved. Show resolvedHide resolved
		});

		it('withoutDocs should work without a `name`', () => {
		const rule = ESLintUtils.RuleCreator.withoutDocs({
		create() {
		return {};
		},
		defaultOptions: [],
		meta: {
		docs: {
		description: 'some description',
		},
		messages: {
		foo: 'some message',
		},
		schema: [],
		type: 'problem',
		},
		});

		expect(rule.meta.docs).toEqual({
		description: 'some description',
		});
		expect(rule.name).toBeUndefined();
		});

		it('withoutDocs should work with a `name`', () => {
		const rule = ESLintUtils.RuleCreator.withoutDocs({
		create() {
		return {};
		},
		defaultOptions: [],
		meta: {
		docs: {
		description: 'some description',
		},
		messages: {
		foo: 'some message',
		},
		schema: [],
		type: 'problem',
		},
		name: 'some-name',
		});

		expect(rule.meta.docs).toEqual({
		description: 'some description',
		});
		expect(rule.name).toBe('some-name');
		});
		});