Rewrite source range highlight()
#215
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
`highlight()` now always prints whole lines of source code, and can highlight arbitrary ranges using box drawing characters, not just with ANSI colors. Use this to fix diagnostic printing so that it's comprehensible in a non color terminal and so that pasting errors into non-color environments works. The box drawing characters from WGL4 seem like a good balance of: * Relatively compatible because they're very old, dating from DOS era: https://en.wikipedia.org/wiki/Box-drawing_character#DOS - note we also use these for formatting log messages from Logging.ConsoleLogger. * Easy to distinguish from the user's source code I've also found it's helpful to prepend any lines of annotation with a Julia # comment where possible - this ensures that copy+paste into websites with syntax highlighting will highlight the annotations separately from the code. A simple example: julia> (x - (c <--- d)) ERROR: ParseError: (x - (c <--- d)) # └──┘ ── invalid operator @ REPL[48]:1:9 Also some semi-related changes included * Generalized/expanded _printstyled() function * Better diagnostic range for try-without-catch
Codecov Report
@@ Coverage Diff @@
## main #215 +/- ##
==========================================
+ Coverage 94.95% 96.32% +1.37%
==========================================
Files 15 15
Lines 3802 3868 +66
==========================================
+ Hits 3610 3726 +116
+ Misses 192 142 -50
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
Ah you got to be kidding. |
|
codecov keeping me honest here 😅 |
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.
highlight()now always prints whole lines of source code, and can highlight arbitrary ranges using box drawing characters, not just with ANSI colors.Use this to fix diagnostic printing so that it's comprehensible in a non color terminal and so that pasting errors into non-color environments works, as described in #150 (comment).
The box drawing characters from WGL4 seem like a good balance of:
Relatively compatible because they're very old, dating from DOS era: https://en.wikipedia.org/wiki/Box-drawing_character#DOS - note we also use these for formatting log messages from Logging.ConsoleLogger.
Easy to distinguish from the user's source code
I've also found it's helpful to prepend any lines of annotation with a Julia # comment where possible - this ensures that copy+paste into websites with syntax highlighting will highlight the annotations separately from the code.
A simple example:
With color
Also some semi-related changes included