Add flag for printing reports in colour #89
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
This was last referenced in 44a7fed.
Before this change the logic for writing the report to stdout was a part of ChangeTracker. By extracting this to a separate class, we allow for other writer classes to be implemented.
|
I've taken this out of review for a moment, because I intend to do a refactor PR first, and land this afterwards. That'll make it easier to revamp #18 |
Tenzer
reviewed
Jan 3, 2024
|
Thanks for the review! I'll address your points so we can get this in, and then in contrast to what I said earlier, I'll do the refactor after :) |
|
@Tenzer I've addressed your points an rebased them in. The commit which changes is "Add ColorChangeReportWriter", and I have created one new commit, "Change spacing around report summary". |
Tenzer
approved these changes
Jan 3, 2024
meshy
force-pushed
the
color-report
branch
2 times, most recently
from
aef0e35 to
2530a10
Compare
|
All updated -- thank you! |
This class can be used to print out change reports in colour. The colours selected closely match those output by Mypy, with the exception that links are not highlighted in notes. The logic is inspired by Mypy's highlighting code. (See https://github.com/python/mypy/blob/f9e8e0bda5cfbb54d6a8f9e482aa25da28a1a635/mypy/util.py#L761) This supports only ANSI colours, so I suspect that this will not work on Windows.
Before this change an empty line would be printed above the summary when there were no new errors, and no empty line would be printed when there were errors. This change reverses that. An empty line is printed to separate the summary from the new errors only if there are new errors.
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.
With this new
--color(or--colour, or-c) flag, the error report can now be printed in colour.The selected colour scheme (mostly) matches that of Mypy. (I didn't bother adding URL highlighting in notes. Please let me know if you want this.)
I used ANSI colour codes for this to avoid adding a dependency, but please let me know if you would prefer this to make use of a library such as
richorcolorist.Happy New Year!