fix(js_formatter): placements of line comments between function parentheses and body #1485
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
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
A-Formatter
kalleep
commented
Jan 9, 2024
kalleep
force-pushed
the
fix-comments-function-between-function-parent-body
branch
from
94666d3
to
df3c813
Compare
CodSpeed Performance ReportMerging #1485 will degrade performances by 8.85%Falling back to comparing Summary
Benchmarks breakdown
|
ematipico
approved these changes
Jan 9, 2024
| // ```javascript | ||
| // function test() /* comment */ { | ||
| // function test() // comment { |
There was a problem hiding this comment.
The JS snippet didn't need to change, this is now incorrect because the curly bracket { is part of the comment, unless you meant to move the { to a new line too,
There was a problem hiding this comment.
oh yeah, you are right.
kalleep
force-pushed
the
fix-comments-function-between-function-parent-body
branch
from
250d1c1
to
8828e1b
Compare
We should only do this for `Line` comments, it seems like that is what prettier does.
kalleep
force-pushed
the
fix-comments-function-between-function-parent-body
branch
from
c2e31e3
to
6feeb93
Compare
kalleep
force-pushed
the
fix-comments-function-between-function-parent-body
branch
from
6feeb93
to
bd2c08b
Compare
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
To match prettier we need to attach a line comment that sits between function parentheses and function body to first statement inside the body.
Before we only did this for function declarations and we attached all types of comments to the body but to match prettier we should only do that for line comments. We should also not exclude empty statements.
I found another non-idempotent formatting issue but we can tackle this in another pr. For this case prettier also has a non-idempotent formatting.
Closes: #1172
Test Plan
Added new tests and uncommented prittier diff