Update: pass rule meta to formatters RFC 10 #11551
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
EasyRhinoMSFT
changed the title
EasyRhinoMSFT
changed the title
ilyavolodin
approved these changes
Mar 27, 2019
not-an-aardvark
previously requested changes
Mar 27, 2019
not-an-aardvark
added
accepted
platinumazure
approved these changes
Mar 30, 2019
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.