Fix whitespace handling in syntaxhighlighter #3229
Merged
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3229 +/- ##
==========================================
+ Coverage 73.10% 73.14% +0.04%
==========================================
Files 69 69
Lines 2398 2398
Branches 338 338
==========================================
+ Hits 1753 1754 +1
Misses 517 517
+ Partials 128 127 -1 |
The syntaxhighlighter library strips blank lines at the start of code block it is trying to highlight. In addition to just being wrong, this means that line numbers on the source page will not line up with the real files. Work around this by providing the library with fake objects that ignore the attempt to strip these lines. This uses a fake string and a fake element to hold it. This is an ugly workaround, but allows us to continue using the syntax highlighter via npm.
Rather than padding empty lines with single spaces, we can use CSS to ensure correct alignment. This avoids copy/pasting code including invented spaces on empty lines.
haarg
force-pushed
the
haarg/fix-synhi-whitespace
branch
from
c6539d6 to
185dd14
Compare
mickeyn
approved these changes
Nov 13, 2024
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.
No description provided.