Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork4.8k
New: Add ESLint#getRulesMetaForResults() (refs #13654)#14716
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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.
LGTM aside from the comments about the documentation.
Does this implementation match everyone's expectations?
I'd guess this covers all use cases whereCLIEngine#getRules() was used, but can't be sure.
Assuming that it covers all use cases, I think it makes sense to require theresults argument, as it clarifies this method and emphasizes that it should be called afterESLint#lintFiles()/ESLint#lintText().
Docs have been updated. I think between |
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.
LGTM. Just one fix to the docs, and I'll commit that inline if you don't see it by the time I'm ready to do the release so it can go out today.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Added the
ESLint#getRulesMetaForResults()method. This method was proposed asESLint#getRulesMetaForReport()but that wording was incorrect in theRFC because it'sCLIEnginethat return a report whileESLintreturns an array of results, so I updated the name to match that reality.,I chose to return an object so that the
rulesMetapassed to formatters is the same format rather than returning a map.This part of the RFC is non-breaking, which is why I chose to create a separate PR for it.
Is there anything you'd like reviewers to focus on?
Does this implementation match everyone's expectations?