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

y-hsgw · 2025-09-18T13:29:24Z

PR Checklist

Addresses an existing open issue: fixes [feature request] Expose the rule name as a property #11608
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR introduces an name property to the RuleModule interface.

🚀

typescript-eslint · 2025-09-18T13:29:27Z

Thanks for the PR, @y-hsgw!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

netlify · 2025-09-18T13:29:30Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`cc82d44`
🔍 Latest deploy log	https://app.netlify.com/projects/typescript-eslint/deploys/68daa0a11603390007684400
😎 Deploy Preview	https://deploy-preview-11616--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 89 (🔴 down 4 from production) Accessibility: 97 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

nx-cloud · 2025-09-18T13:30:59Z

View your CI Pipeline Execution ↗ for commit cc82d44

Command	Status	Duration	Result
`nx test eslint-plugin --coverage=false`	✅ Succeeded	5m 6s	View ↗
`nx run-many -t lint`	✅ Succeeded	3m 14s	View ↗
`nx run-many -t typecheck`	✅ Succeeded	2m 21s	View ↗
`nx test eslint-plugin-internal --coverage=false`	✅ Succeeded	17s	View ↗
`nx run types:build`	✅ Succeeded	13s	View ↗
`nx run generate-configs`	✅ Succeeded	14s	View ↗
`nx run integration-tests:test`	✅ Succeeded	11s	View ↗
`nx test typescript-estree --coverage=false`	✅ Succeeded	1s	View ↗
`Additional runs (27)`	✅ Succeeded	...	View ↗

☁️ Nx Cloud last updated this comment at 2025-09-29 15:19:27 UTC

codecov · 2025-09-18T13:41:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.93%. Comparing base (9530e02) to head (cc82d44).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #11616   +/-   ##
=======================================
  Coverage   90.93%   90.93%           
=======================================
  Files         506      506           
  Lines       51394    51397    +3     
  Branches     8482     8482           
=======================================
+ Hits        46735    46738    +3     
  Misses       4646     4646           
  Partials       13       13

Flag	Coverage Δ
unittest	`90.93% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
packages/utils/src/eslint-utils/RuleCreator.ts	`85.10% <100.00%> (+1.01%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

JoshuaKGoldberg

(just leaving some drive-by comments, not a full review for now)

JoshuaKGoldberg · 2025-09-22T16:06:54Z

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

    schema: [],
    type: 'problem',
  },
+  name: 'rule',


[Testing] For consistency with the rest of the block:

Suggested change

name: 'rule',

name: 'use-every-a',

🤔 I wonder if we should write a lint rule for this...

That makes sense.
By the way, instead of adding a separate lint rule, do you think we could change the defineRule logic itself so that it automatically keeps the name consistent, like in the following example?

typescript-eslint/packages/rule-tester/src/RuleTester.ts

Lines 447 to 448 in c198052

defineRule(name: string, rule: AnyRuleModule): void {

this.#rules[name] = {

defineRule(rule: AnyRuleModule): void { this.#rules[rule.name] = {

Oh, that's an interesting idea. I like it. But I think it'd be a behavioral change that differs from the ESLint core RuleTester. We're restricted from doing those too much. It'll have to be something we talk about separately 😞.

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

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

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

…rs-eslint.test.ts Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

JoshuaKGoldberg

LGTM, thanks! I'm glad this ended up being a clean diff. 🙂

Can you update the PR's description to reflect the changes?

JoshuaKGoldberg

(wrong button)

y-hsgw · 2025-09-29T15:16:38Z

Thanks for the review! I’ve updated the description ✅

JoshuaKGoldberg · 2025-09-29T15:21:38Z

Swell! We might have docs work to do later on to more prominently mention this. But for now I think "soft launching" with just the types change is best. 🚀

#11616)" This reverts commit f2eeb9d.

…e" (#11663) Revert "feat(eslint-plugin): expose rule name via RuleModule interface (#11616)" This reverts commit f2eeb9d.

@thebolarin

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.44.1 | 8.45.0 | | npm | @typescript-eslint/parser | 8.44.1 | 8.45.0 | ## [v8.45.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8450-2025-09-29) ##### 🚀 Features - **eslint-plugin:** expose rule name via RuleModule interface ([#11616](typescript-eslint/typescript-eslint#11616)) ##### 🩹 Fixes - **eslint-plugin:** \[prefer-nullish-coalescing] ignoreBooleanCoercion should not apply to top-level ternary expressions ([#11614](typescript-eslint/typescript-eslint#11614)) - **eslint-plugin:** \[no-base-to-string] check if superclass is ignored ([#11617](typescript-eslint/typescript-eslint#11617)) ##### ❤️ Thank You - mdm317 - Moses Odutusin [@thebolarin](https://github.com/thebolarin) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) You can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.

@thebolarin

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.44.1 | 8.45.0 | | npm | @typescript-eslint/parser | 8.44.1 | 8.45.0 | ## [v8.45.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8450-2025-09-29) ##### 🚀 Features - **eslint-plugin:** expose rule name via RuleModule interface ([#11616](typescript-eslint/typescript-eslint#11616)) ##### 🩹 Fixes - **eslint-plugin:** \[prefer-nullish-coalescing] ignoreBooleanCoercion should not apply to top-level ternary expressions ([#11614](typescript-eslint/typescript-eslint#11614)) - **eslint-plugin:** \[no-base-to-string] check if superclass is ignored ([#11617](typescript-eslint/typescript-eslint#11617)) ##### ❤️ Thank You - mdm317 - Moses Odutusin [@thebolarin](https://github.com/thebolarin) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) You can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.

@thebolarin

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.44.1 | 8.45.0 | | npm | @typescript-eslint/parser | 8.44.1 | 8.45.0 | ## [v8.45.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8450-2025-09-29) ##### 🚀 Features - **eslint-plugin:** expose rule name via RuleModule interface ([#11616](typescript-eslint/typescript-eslint#11616)) ##### 🩹 Fixes - **eslint-plugin:** \[prefer-nullish-coalescing] ignoreBooleanCoercion should not apply to top-level ternary expressions ([#11614](typescript-eslint/typescript-eslint#11614)) - **eslint-plugin:** \[no-base-to-string] check if superclass is ignored ([#11617](typescript-eslint/typescript-eslint#11617)) ##### ❤️ Thank You - mdm317 - Moses Odutusin [@thebolarin](https://github.com/thebolarin) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) You can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.

@thebolarin

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.44.1 | 8.45.0 | | npm | @typescript-eslint/parser | 8.44.1 | 8.45.0 | ## [v8.45.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8450-2025-09-29) ##### 🚀 Features - **eslint-plugin:** expose rule name via RuleModule interface ([#11616](typescript-eslint/typescript-eslint#11616)) ##### 🩹 Fixes - **eslint-plugin:** \[prefer-nullish-coalescing] ignoreBooleanCoercion should not apply to top-level ternary expressions ([#11614](typescript-eslint/typescript-eslint#11614)) - **eslint-plugin:** \[no-base-to-string] check if superclass is ignored ([#11617](typescript-eslint/typescript-eslint#11617)) ##### ❤️ Thank You - mdm317 - Moses Odutusin [@thebolarin](https://github.com/thebolarin) - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) You can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.

y-hsgw added 2 commits September 18, 2025 22:18

feat: expose rule name on RuleModule interface

365b023

fix: resolve type errors after adding name to RuleModule

c3ac10c

JoshuaKGoldberg reviewed Sep 22, 2025

View reviewed changes

y-hsgw and others added 4 commits September 23, 2025 11:07

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

7fb5521

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

Update packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-va…

6055ed3

…rs-eslint.test.ts Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

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

9e638fa

refactor: add name property to RuleWithMeta

c77d386

JoshuaKGoldberg requested changes Sep 29, 2025

View reviewed changes

JoshuaKGoldberg approved these changes Sep 29, 2025

View reviewed changes

Merge branch 'main' into feat/add-name-to-rulemodule

cc82d44

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Sep 29, 2025

JoshuaKGoldberg merged commit f2eeb9d into typescript-eslint:main Sep 29, 2025
64 of 65 checks passed

y-hsgw deleted the feat/add-name-to-rulemodule branch September 29, 2025 15:25

kirkwaiblinger mentioned this pull request Sep 29, 2025

Bug: (regression) name should be optional in RuleCreator.withoutDocs #11662

Closed

4 tasks

JoshuaKGoldberg added a commit that referenced this pull request Sep 29, 2025

Revert "feat(eslint-plugin): expose rule name via RuleModule interface (

c80d100

#11616)" This reverts commit f2eeb9d.

JoshuaKGoldberg mentioned this pull request Sep 29, 2025

Revert "feat(eslint-plugin): expose rule name via RuleModule interface" #11663

Merged

chrisbbreuer mentioned this pull request Sep 29, 2025

chore(deps): update all non-major dependencies stacksjs/eslint-plugin#64

Closed

JoshuaKGoldberg added a commit that referenced this pull request Sep 29, 2025

Revert "feat(eslint-plugin): expose rule name via RuleModule interfac…

db09a7d

…e" (#11663) Revert "feat(eslint-plugin): expose rule name via RuleModule interface (#11616)" This reverts commit f2eeb9d.

JoshuaKGoldberg mentioned this pull request Oct 3, 2025

[feature request] Expose the rule name as a property #11608

Open

chrisbbreuer mentioned this pull request Oct 4, 2025

chore(deps): update all non-major dependencies stacksjs/eslint-plugin#67

Open

1 task

This was referenced Oct 6, 2025

chore(deps-dev): bump the dependencies group with 4 updates openfga/js-sdk#263

Merged

Bump @typescript-eslint/eslint-plugin from 8.44.1 to 8.46.0 fossas/fossa-action#220

Merged

y-hsgw mentioned this pull request Oct 25, 2025

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

Open

3 tasks

	defineRule(name: string, rule: AnyRuleModule): void {
	this.#rules[name] = {

Uh oh!

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

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

Uh oh!

Conversation

y-hsgw commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Sep 18, 2025

Uh oh!

netlify bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

y-hsgw Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

y-hsgw commented Sep 29, 2025

Uh oh!

JoshuaKGoldberg commented Sep 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

y-hsgw commented Sep 18, 2025 •

edited

Loading

netlify bot commented Sep 18, 2025 •

edited

Loading

nx-cloud bot commented Sep 18, 2025 •

edited

Loading

codecov bot commented Sep 18, 2025 •

edited

Loading