fix(html_formatter): preserve whitespace around inline elements and text expressions #7987
+598
−29
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
…ext expressions
Fixed an issue where whitespace was being incorrectly removed after closing
tags of inline elements and around text expressions (e.g., {name} in
Astro/Vue/Svelte). The formatter now:
- Preserves trailing whitespace after inline element closing tags when in
whitespace-sensitive mode
- Treats text expressions as whitespace-sensitive elements to maintain
proper spacing around them
This ensures proper rendering when formatting HTML with inline elements
followed by text, or when using framework-specific text expressions.
|
github-actions
bot
added
A-Formatter
Contributor
WalkthroughThis PR addresses whitespace handling in the HTML formatter, specifically fixing issues where spaces were incorrectly removed after inline closing tags and text expressions. The changes add conditional logic to preserve trailing whitespace after closing angle brackets when whitespace sensitivity is strict, and introduce a new Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro ⛔ Files ignored due to path filters (13)
📒 Files selected for processing (13)
🧰 Additional context used🧠 Learnings (22)📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:46.002ZApplied to files:
📚 Learning: 2025-10-15T09:22:46.002ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:46.002ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-08-05T14:43:29.581ZApplied to files:
📚 Learning: 2025-10-15T09:25:05.698ZApplied to files:
📚 Learning: 2025-10-15T09:25:05.698ZApplied to files:
📚 Learning: 2025-10-15T09:22:46.002ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:22:15.851ZApplied to files:
📚 Learning: 2025-10-15T09:24:31.042ZApplied to files:
🧬 Code graph analysis (1)crates/biome_html_formatter/src/html/auxiliary/closing_element.rs (1)
🔇 Additional comments (15)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
dyc3
requested changes
Nov 4, 2025
Comment on lines
+40
to
+41
| Start {expr1} | ||
| {expr2}middle end {expr3} |
Contributor
There was a problem hiding this comment.
The space from the input {expr2} middle disappeared in the output.
It's a bit weird that it keeps the newline between {expr1} and {expr2}, but it matches prettier behavior, so keep it.
Comment on lines
+7
to
+12
| ```vue | ||
| <template> | ||
| <p>{a} {b} {c}</p> | ||
| <div>{firstName}{middleInitial}.{lastName}</div> | ||
| <span> {padded} </span> | ||
| </template> |
Comment on lines
+7
to
+11
| ```vue | ||
| <template> | ||
| <p>User: {name} ({username})</p> | ||
| <div>{count} items in cart</div> | ||
| <span>{first} {last}</span> |
Comment on lines
+41
to
+43
| <p>{name}({username})</p> | ||
| <p>Hello {firstName} {lastName}!</p> | ||
| <p>{a}+ {b}= {sum}</p> |
Contributor
There was a problem hiding this comment.
- The space between
{name}and({username})disappeared. - The spaces before the
+and=disappeared.
Comment on lines
+35
to
+47
| ```astro | ||
| <div> | ||
| <span>Name:</span> | ||
| {fullName} | ||
| <span>Age:</span> | ||
| {age} | ||
| </div> | ||
| <p> | ||
| <strong>Total:</strong> | ||
| {price} | ||
| <em>(tax included)</em> | ||
| </p> |
Contributor
There was a problem hiding this comment.
This is significantly different from prettier's output, and shows no difference from biome's current output.
| ----- | ||
|
|
||
| ```astro | ||
| <p>{name}({username})</p> |
Member
|
It would be nice if the PR description would highlight what kind of strategy (business logic) was used to fix the bug. Without it, I wouldn't know what to review and how. |
ematipico
reviewed
Nov 5, 2025
| } | ||
|
|
||
| /// Whether the element is a text expression (like `{name}` in HTML-ish languages) | ||
| pub(crate) fn is_text_expression(element: &AnyHtmlElement) -> bool { |
Member
There was a problem hiding this comment.
Suggested change
| pub(crate) fn is_text_expression(element: &AnyHtmlElement) -> bool { | |
| const pub(crate) fn is_text_expression(element: &AnyHtmlElement) -> bool { |
| && is_whitespace_sensitive | ||
| && r_angle_token.has_trailing_whitespace() | ||
| { | ||
| write!(f, [space()])?; |
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Fixes #7875, fixes #7960 where whitespace was being incorrectly removed after closing tags of inline elements and around text expressions (e.g., {name} in Astro/Vue/Svelte).
AI assistance notice
I used Claude Code to write most of the code and comments in this pull request. As the human author, I take full responsibility for its contents.
Test Plan
I added snapshot tests for the straightforward and edge cases around preserving whitespace around text expressions and in tags in whitespace-sensitve mode.
Some snapshots that test other things like long tag children needed to be updated, but they appear to be unrelated to whitespace preservation, and can be safely changed without changing the meaning of the tests.
Note - unimplemented nodes/tokens are expected with snapshots of framework tests because of limited support for html-ish languages (compared to support for just html).