Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 5 commits into from
+41 −1

Conversation

@y-hsgw
Copy link
Contributor

@y-hsgw y-hsgw commented Oct 25, 2025 •
edited
Loading

PR Checklist

Overview

The previous PR #11616 was reverted after a discussion in #11662 pointing out that the name argument in withoutDocs should be optional.
This PR reintroduces the change from #11616 while keeping name optional.

🍂

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Oct 25, 2025

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
Copy link

netlify bot commented Oct 25, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit e6e499f
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/69093b1bf602e80008526b22
😎 Deploy Preview https://deploy-preview-11719--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 98 (🟢 up 2 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.

@y-hsgw y-hsgw changed the title Feat/add name to rulemodule feat(eslint-plugin): expose rule name via RuleModule interface Oct 25, 2025
@nx-cloud
Copy link

nx-cloud bot commented Oct 25, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit e6e499f

Command Status Duration Result
nx run-many -t lint ✅ Succeeded 3m 17s View ↗
nx run-many -t typecheck ✅ Succeeded 1m 56s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded 4s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 2s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded 3s View ↗
nx run generate-configs ✅ Succeeded 8s View ↗
nx run integration-tests:test ✅ Succeeded 4s View ↗
nx run types:build ✅ Succeeded 5s View ↗
Additional runs (29) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-11-03 23:36:28 UTC

@codecov
Copy link

codecov bot commented Oct 25, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.67%. Comparing base (ea2ee6b) to head (e6e499f).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #11719   +/-   ##
=======================================
  Coverage   90.66%   90.67%           
=======================================
  Files         518      518           
  Lines       52435    52439    +4     
  Branches     8686     8687    +1     
=======================================
+ Hits        47541    47549    +8     
+ Misses       4880     4876    -4     
  Partials       14       14
Flag Coverage Δ
unittest 90.67% <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/rule-tester/src/RuleTester.ts 74.31% <100.00%> (+0.02%) ⬆️
packages/utils/src/eslint-utils/RuleCreator.ts 93.61% <100.00%> (+9.52%) ⬆️
🚀 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
JoshuaKGoldberg requested changes Nov 3, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for restarting this! Could you please add tests ensuring the regressions noted in #11608 & linked don't happen again?

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Nov 3, 2025
@y-hsgw
Copy link
Contributor Author

y-hsgw commented Nov 3, 2025

I’ve added tests. 91e97bc

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JoshuaKGoldberg JoshuaKGoldberg Awaiting requested review from JoshuaKGoldberg

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[feature request] Expose the rule name as a property

2 participants

@y-hsgw @JoshuaKGoldberg