refactor(diagnostics): indentation #3722
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
ematipico
commented
Aug 26, 2024
| @@ -2,4 +2,4 @@ | |||
| source: crates/biome_diagnostics/tests/disagnostics.rs | |||
| expression: content | |||
| --- | |||
| code_block check <span style="color: #000; background-color: #ddd;"> FIXABLE </span> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br /><strong><span style="color: Tomato;"> </span></strong><strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">This is the message of the diagnostic. It will appear in different colours based on the severity of the diagnostic.</span><br /> <br /> | |||
| code_block:1:11 check <span style="color: #000; background-color: #ddd;"> FIXABLE </span> ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━<br /><br /> <strong><span style="color: Tomato;">✖</span></strong> <span style="color: Tomato;">This is the message of the diagnostic. It will appear in different colours based on the severity of the diagnostic.</span><br /> <br /> <strong><span style="color: Tomato;">></span></strong> <strong>1 │ </strong>fn main() {<br /> <strong> │ </strong> <strong><span style="color: Tomato;">^</span></strong><br /> <strong><span style="color: Tomato;">></span></strong> <strong>2 │ </strong> println!("Hello, world!");<br /> <strong> │ </strong> <strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><strong><span style="color: Tomato;">^</span></strong><br /> <strong>3 │ </strong>}<br /> <br /> | |||
There was a problem hiding this comment.
Notice here, after the first two <br /><br /> that you can find after the long line. We have two whitespace. They aren't wrapped by any special tag. Instead, on the left, we have <strong><span style="color: Tomato;"> </span></strong>
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.
Summary
This PR changes how the indentation of the diagnostics is printed.
Before, the
IndentWriterwas using the same markup elements of the elements to indent. This means that if we had<Info>Text</Info>, theIndentWriterwould have created<Info> </Info><Info>Text</Info>. This isn't visible in a terminal, becauseInfobasically sets some ANSI codes for changing the colour.However, in the
HTMLadapter, this was more visible, because it create HTML like this:This is more cumbersome when we have things like
<Emphasis><Info>Text</Info></Emphasis>, which emits:This causes some issues inside MDX files. MDX is weird, really weird, so it requires some special handling, however this change is fine also for Markdown documents.
With this PR, we just use a
::Rootelement, which means that we emit less HTML tags, and the spaces are emitted as they are... spaces!Test Plan
I updated the current tests. I took the emitted HTML for the MDX variant and used it on the website to see if the printed diagnostics are correctly indented, and they are!