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
Update: pass rule meta to formatters RFC 10 #11551
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eslint-deprecated
bot
added
the
triage
An ESLint team member will look at this issue soon
label
Mar 25, 2019
EasyRhinoMSFT
changed the title
Update: pass rule meta to formatters (RFC #10)
Update: pass rule meta to formatters RFC #10
Mar 25, 2019
EasyRhinoMSFT
changed the title
Update: pass rule meta to formatters RFC #10
Update: pass rule meta to formatters RFC 10
Mar 25, 2019
ilyavolodin
approved these changes
Mar 27, 2019
not-an-aardvark
previously requested changes
Mar 27, 2019
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 the PR! This looks good overall -- I have a few minor suggestions.
not-an-aardvark
added
accepted
There is consensus among the team that this change meets the criteria for inclusion
core
Relates to ESLint's core APIs and features
feature
This change adds a new feature to ESLint
and removed
triage
An ESLint team member will look at this issue soon
labels
Mar 27, 2019
platinumazure
approved these changes
Mar 30, 2019
eslint-deprecated
bot
added
the
archived due to age
This issue has been archived; please open a new issue for any further discussion
label
Sep 27, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
accepted
There is consensus among the team that this change meets the criteria for inclusion
archived due to age
This issue has been archived; please open a new issue for any further discussion
core
Relates to ESLint's core APIs and features
feature
This change adds a new feature to ESLint
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[X] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[X] Add something to the core
[ ] Other, please explain:
https://github.com/EasyRhinoMSFT/rfcs/blob/master/designs/2019-expose-rules-to-formatters/readme.MD
What changes did you make? (Give an overview)
This change adds a new optional argument to the interface function exported by formatters. The argument is a dictionary that is keyed with the ruleIds of each rule run during the analysis. The entry values are the corresponding rule's meta property.
This change also adds a new JSON formatter that serializes both the results array and the new data object argument.
Other changes include unit test coverage for the new JSON formatter as well as updates to the CLI unit tests.
Finally, this updates the HTML formatter + tests, and fixes a bug that caused invalid URLs to be written out.
Is there anything you'd like reviewers to focus on?
Please review the changes to the working-with-custom-formatters document. I want to make sure they correctly follow the existing style, structure, and voice.