[core] Add CLI Progress Bar#3866
Merged
oowekyala merged 12 commits intoApr 16, 2022
Merged
Conversation
Generated by 🚫 Danger |
oowekyala
reviewed
Mar 22, 2022
oowekyala
left a comment
Member
There was a problem hiding this comment.
This is very cool, thanks a lot for contributing this!
jsotuyod
reviewed
Mar 25, 2022
to see more clearly what's going on
This was referenced Apr 15, 2022
Closed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Describe the PR
Adds a progress bar reporting files analyzed, number of violations and number of errors to CLI in real time. Implemented as a GlobalAnalysisListener (as suggested in #3828) and instantiated in PmdAnalysis.
Adds a small dependency, namely the progress bar utility library progressbar.
Can be toggled off using new "--no-progress" CLI argument.
Operates standalone, uses trailing carriage returns to interleave will all other output without any modifications to MessageReporter (as that class will be undergoing further changes, #3816). The logging function it uses is configurable, currently it is through System.out as it appears that the JUL to SLF4J bridge does not (yet?) properly interact with carriage returns, ignoring them completely.
Sample with interleaved output:
Interleaved.mp4
Related issues
Ready?
./mvnw clean verifypasses (checked automatically by github actions)