feat(format/html): implement suppression comments #5356
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 reverts #4056 to make HTML comments actual comment trivia. It also attempts to fix the formatting for comments as well, trying to preserve whitespace in the same places that prettier does.
This PR is also the result of a cascading clusterfuck of issues that appeared as a result of making this change, so it may seem a little scatterbrained, and a little difficult to review.
One unfortunate regression is this case:
crates/biome_html_formatter/tests/specs/html/comments/after-text-inside-div.html
Prettier treats comments as actual nodes in the AST, it treats the comment as a child of the
div
. However, because this PR makes Biome not do that, the comment gets attached as trivia to the closing tag. Ultimately, this results in unstable formatting. I originally wanted to fix that in this PR, but it's too complicated and this PR is already kinda big.This PR also doesn't attempt to handle or reimplement
prettier-ignore-attribute
comments in any way. Example from prettier docs:The reason these exist is because you can't put comments inside the
<>
of HTML tags.Test Plan
CI should pass. Added new tests, and updated snapshots.