-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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.
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
base: main
Are you sure you want to change the base?
feat(eslint-plugin): expose rule name via RuleModule interface #11719
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
View your CI Pipeline Execution ↗ for commit 28af1c9
☁️ Nx Cloud last updated this comment at |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11719 +/- ##
=======================================
Coverage 90.53% 90.54%
=======================================
Files 523 523
Lines 53096 53101 +5
Branches 8838 8838
=======================================
+ Hits 48073 48082 +9
+ Misses 5010 5006 -4
Partials 13 13
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
JoshuaKGoldberg
left a comment
There was a problem hiding this 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?
…gw/typescript-eslint into feat/add-name-to-rulemodule
|
I’ve added tests. 91e97bc |
| return { | ||
| ...ruleWithDocs, | ||
| name, | ||
| }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like overkill to make another runtime change here just to satisfy the checker.
Maybe we just use an assertion here?
| return { | |
| ...ruleWithDocs, | |
| name, | |
| }; | |
| return ruleWithDocs as typeof ruleWithDocs & { name: string }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed it in 28af1c9.

PR Checklist
Overview
The previous PR #11616 was reverted after a discussion in #11662 pointing out that the
nameargument inwithoutDocsshould be optional.This PR reintroduces the change from #11616 while keeping name optional.
🍂