FeatureComplete/Check: improve usability/readability of reporting in CLI #95
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
* Align the various parts of the error/warning messages for improved readability. * Make the "horizontal rule" above the summary match the length of the first two "columns". * Don't have a period `.` after the file name as it may confuse CLI interfaces which allow for clicking through to the file. Tested via the (adjusted) existing unit tests.
Improve error/warning summary: * Display the correct singular "error"/"warning" vs plural "errors"/"warnings" depending on the number of errors/warnings found. * Only mention "warnings" when not in quiet mode. I.e. when warnings are actually a possibility. * Colorize the "# errors" and "# warnings" part of the summary message. * Minor punctuation fix for the summary. Tested via the (adjusted) existing unit tests + added specific tests for the coloring of the summary to the `ColorTest` file.
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.
FeatureComplete/Check: improve individual error/warning display
.after the file name as it may confuse CLI interfaces which allow for clicking through to the file.Tested via the (adjusted) existing unit tests.
FeatureComplete/Check: improve error/warning summary display
Improve error/warning summary:
Tested via the (adjusted) existing unit tests + added specific tests for the coloring of the summary to the
ColorTestfile.