feat(cli): add diagnostic summary #2742
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
ematipico
force-pushed
the
feat/cli-summary
branch
from
609545b
to
9e31fb3
Compare
ematipico
force-pushed
the
feat/cli-summary
branch
from
2f3931e
to
bb05860
Compare
ematipico
force-pushed
the
feat/cli-summary
branch
from
bb05860
to
b8d863b
Compare
|
I am going to merge this. Feel free to leave some comments in case there's something wrong and requires some attention |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Closes #57
This PR creates a new reporter called
summary. This reporter reads the diagnostics emitted by the traversal and compiles information that is eventually printed to the terminal.The most exhaustive case is when we run
check/ci, because that's when we call all the tools, hence, I tried to come up with a summary that makes sense for each tool.Thanks to the feedback received, I landed this: #57 (comment)
The comment contains an explanation of why the information is broken down the way it is.
The linter block is sorted by the length of the diagnostic name, which is why the type
RuleNameimplements the ordering traits. I wanted to find the longest name so I could correctly calculate the padding in a predictable way, and print something nice to see.Test Plan
Added cases for
check,ci,formatandlint