refactor(formatter): improve printing comments for special nodes #14544

Dunqing · 2025-10-13T06:14:58Z

Remove SiblingNode usages. It used to check comments for special nodes based on Prettier's behavior, but we have moved all of the logic to the comments printing side, so SiblingNode becomes unnecessary; it will be removed in the next PR.

Dunqing · 2025-10-13T06:15:39Z

fix(formatter): print a line break incorrectly for directives #14577
refactor(formatter): simplify foramtting import and export #14576
refactor(formatter): remove SiblingNode #14551
refactor(formatter): improve printing comments for special nodes #14544 👈 (View in Graphite)
fix(formatter): correct printing comments that are around the StaticMemberExpression #14543
fix(formatter): no need to wrap a parenthesis for TSConditionalType and TSFunctionType when its parent is TSUnionType and it only has one element #14540
refactor(formatter): improve line break detaching logic in SourceText #14539
fix(formatter): missing parenthesis for ComputedMemberExpression when its parent is an NewExpression #14530
fix(formatter): missing parenthesis for PrivateInExpression when its parent is an UnaryExpression #14529
fix(formatter): correct printing comments for logical expression #14500
fix(formatter): should break even if the right side of the assignment is a require when it has a leading own line comment #14499
fix(formatter): correct printing comments for the end of union type #14498
fix(formatter): correct printing comments for try statement #14497
fix(formatter): should expand the parent if the member chain will break #14487
fix(formatter): correct printing comments around the expression of ComputedMemberExpression #14486
fix(formatter): correct printing yield argument #14485
fix(formatter): no need to wrap with parentheses for a type cast node #14484
fix(formatter): ignore the leading line break for the first argument of the call expression #14483
fix(formatter): correct checking comments between the operator and the right side for assignment like nodes #14482
fix(formatter): block comments without a leading linebreak that are around the operator of the conditional expression should be printed as-is #14474
fix(formatter): correct printing comments for for statements #14473
fix(formatter): correct printing comments for assignment pattern #14469
test(formatter): add snapshot-based test infrastructure #14400
main

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

0-merge - adds this PR to the back of the merge queue
hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

codspeed-hq · 2025-10-13T06:21:55Z

CodSpeed Performance Report

Merging #14544 will not alter performance

_{Comparing 09-11-refactor_formatter_improve_printing_comments_for_special_nodes (893bdac) with main (2cd53c5)¹}

Summary

✅ 33 untouched
⏩ 4 skipped²

No successful run was found on main (0829d2c) during the generation of this report, so 2cd53c5 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
4 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Copilot

Pull Request Overview

This PR refactors comment handling in the formatter by removing SiblingNode usages and moving comment processing logic to dedicated formatting methods. The changes improve how comments are handled for special nodes like control structures, call expressions, and import/export statements.

Removes SiblingNode-based comment handling from the Comments struct
Introduces specialized comment formatting for empty statements in control structures
Consolidates import/export source formatting with proper comment handling

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tasks/prettier_conformance/snapshots/prettier.ts.snap.md	Updates test compatibility percentage for TypeScript definite assignment
crates/oxc_formatter/src/write/utils/statement_body.rs	Adds special handling for trailing comments in if statement consequents
crates/oxc_formatter/src/write/mod.rs	Implements comment formatting for empty statements and control structure tests
crates/oxc_formatter/src/write/import_declaration.rs	Extracts shared logic for formatting import/export sources with clauses
crates/oxc_formatter/src/write/export_declarations.rs	Uses shared formatting function for export sources with proper comment handling
crates/oxc_formatter/src/utils/member_chain/chain_member.rs	Adds conditional trailing comment formatting for member expressions
crates/oxc_formatter/src/utils/assignment_like.rs	Implements trailing comment handling for assignment-like expressions
crates/oxc_formatter/src/formatter/comments.rs	Removes SiblingNode-based comment logic and simplifies comment detection

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

crates/oxc_formatter/src/write/mod.rs

crates/oxc_formatter/src/formatter/comments.rs

crates/oxc_formatter/src/write/mod.rs

graphite-app · 2025-10-14T05:59:13Z

Merge activity

Oct 14, 5:59 AM UTC: graphite-app added this pull request to the Graphite merge queue.
Oct 14, 6:05 AM UTC: Merged by the Graphite merge queue.

) Remove `SiblingNode` usages. It used to check comments for special nodes based on [Prettier's](https://github.com/prettier/prettier/blob/7584432401a47a26943dd7a9ca9a8e032ead7285/src/language-js/comments/handle-comments.js#L861) behavior, but we have moved all of the logic to the comments printing side, so `SiblingNode` becomes unnecessary; it will be removed in the next PR.

Remove `SiblingNode`; all of the last usages are removed in #14544.

## [0.5.0] - 2025-10-14 ### 🚀 Features - 8077f9b oxfmt: Provide JSON schema for `.oxfmtrc.json` (#14399) (leaysgur) - 51ddfa8 oxfmt: Support `.oxfmtrc.json(c)` config file (#14398) (leaysgur) ### 🐛 Bug Fixes - c4e12df formatter: Correct checking comments around the return argument (#14585) (Dunqing) - 454303b formatter: Check empty lines between arguments incorrectly (#14584) (Dunqing) - a5554a8 formatter: Print a line break incorrectly for directives (#14577) (Dunqing) - 5db9774 formatter: Correct printing comments that are around the `StaticMemberExpression` (#14543) (Dunqing) - 620dbac formatter: No need to wrap a parenthesis for `TSConditionalType` and `TSFunctionType` when its parent is `TSUnionType` and it only has one element (#14540) (Dunqing) - 1aec74f formatter: Missing parenthesis for `ComputedMemberExpression` when its parent is an `NewExpression` (#14530) (Dunqing) - 59f1d8f formatter: Missing parenthesis for `PrivateInExpression` when its parent is an `UnaryExpression` (#14529) (Dunqing) - b06059e formatter: Correct printing comments for logical expression (#14500) (Dunqing) - be38095 formatter: Should break even if the right side of the assignment is a require when it has a leading own line comment (#14499) (Dunqing) - 4d55654 formatter: Correct printing comments for the end of union type (#14498) (Dunqing) - 4994872 formatter: Correct printing comments for `try` statement (#14497) (Dunqing) - 9a4da3d formatter: Should expand the parent if the member chain will break (#14487) (Dunqing) - bba9689 formatter: Correct printing comments around the expression of `ComputedMemberExpression` (#14486) (Dunqing) - dc5e08a formatter: Correct printing yield argument (#14485) (Dunqing) - b8a0905 formatter: No need to wrap with parentheses for a type cast node (#14484) (Dunqing) - b159215 formatter: Ignore the leading line break for the first argument of the call expression (#14483) (Dunqing) - ea8f9ed formatter: Correct checking comments between the operator and the right side for assignment like nodes (#14482) (Dunqing) - 4f19504 formatter: Block comments without a leading linebreak that are around the operator of the conditional expression should be printed as-is (#14474) (Dunqing) - ef77997 formatter: Correct printing comments for `for` statements (#14473) (Dunqing) - 31595c3 formatter: Correct printing comments for assignment pattern (#14469) (Dunqing) - 0f19be0 oxfmt: Normalize path delimiter on Windows (#14463) (leaysgur) - 5856bc9 oxc_formatter: Fix arrow_parentheses: 'avoid' > 'as-needed' (#14462) (leaysgur) ### 🚜 Refactor - 7bc86f4 formatter: Simplify foramtting import and export (#14576) (Dunqing) - 29c3cf2 formatter: Remove `SiblingNode` (#14551) (Dunqing) - 893bdac formatter: Improve printing comments for special nodes (#14544) (Dunqing) - 97bb964 formatter: Improve line break detaching logic in SourceText (#14539) (Dunqing) ### 🧪 Testing - bb43dc5 formatter: Add snapshot-based test infrastructure (#14400) (Dunqing) Co-authored-by: leaysgur <6259812+leaysgur@users.noreply.github.com>

github-actions bot added A-formatter Area - Formatter C-cleanup Category - technical debt or refactoring. Solution not expected to change behavior labels Oct 13, 2025

graphite-app bot changed the base branch from 10-13-fix_formatter_correct_printing_comments_that_are_around_the_staticmemberexpression to graphite-base/14544 October 13, 2025 06:34

graphite-app bot force-pushed the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch from e347966 to 997b2eb Compare October 13, 2025 06:40

graphite-app bot force-pushed the graphite-base/14544 branch from 191b50b to 5db9774 Compare October 13, 2025 06:40

graphite-app bot changed the base branch from graphite-base/14544 to main October 13, 2025 06:40

graphite-app bot force-pushed the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch from 997b2eb to afe0be2 Compare October 13, 2025 06:41

Dunqing force-pushed the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch from afe0be2 to 18f6334 Compare October 13, 2025 08:05

Dunqing mentioned this pull request Oct 13, 2025

refactor(formatter): remove SiblingNode #14551

Merged

This was referenced Oct 14, 2025

refactor(formatter): simplify foramtting import and export #14576

Merged

fix(formatter): print a line break incorrectly for directives #14577

Merged

Dunqing marked this pull request as ready for review October 14, 2025 01:59

Copilot AI review requested due to automatic review settings October 14, 2025 01:59

Copilot AI reviewed Oct 14, 2025

View reviewed changes

crates/oxc_formatter/src/write/mod.rs Outdated Show resolved Hide resolved

crates/oxc_formatter/src/write/mod.rs Outdated Show resolved Hide resolved

crates/oxc_formatter/src/formatter/comments.rs Show resolved Hide resolved

graphite-app bot reviewed Oct 14, 2025

View reviewed changes

crates/oxc_formatter/src/write/mod.rs Outdated Show resolved Hide resolved

Dunqing force-pushed the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch 2 times, most recently from 85ce0af to f6a70a2 Compare October 14, 2025 02:32

graphite-app bot added the 0-merge Merge with Graphite Merge Queue label Oct 14, 2025

graphite-app bot force-pushed the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch from f6a70a2 to 893bdac Compare October 14, 2025 05:59

graphite-app bot pushed a commit that referenced this pull request Oct 14, 2025

refactor(formatter): remove SiblingNode (#14551)

29c3cf2

Remove `SiblingNode`; all of the last usages are removed in #14544.

graphite-app bot merged commit 893bdac into main Oct 14, 2025
27 checks passed

graphite-app bot deleted the 09-11-refactor_formatter_improve_printing_comments_for_special_nodes branch October 14, 2025 06:05

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Oct 14, 2025

Boshen mentioned this pull request Oct 14, 2025

release(oxfmt): v0.5.0 #14586

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(formatter): improve printing comments for special nodes #14544

refactor(formatter): improve printing comments for special nodes #14544

Uh oh!

Dunqing commented Oct 13, 2025 •

edited

Loading

Uh oh!

Dunqing commented Oct 13, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

graphite-app bot commented Oct 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor(formatter): improve printing comments for special nodes #14544

refactor(formatter): improve printing comments for special nodes #14544

Uh oh!

Conversation

Dunqing commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dunqing commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

codspeed-hq bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #14544 will not alter performance

Summary

Footnotes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

graphite-app bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Dunqing commented Oct 13, 2025 •

edited

Loading

Dunqing commented Oct 13, 2025 •

edited

Loading

codspeed-hq bot commented Oct 13, 2025 •

edited

Loading

graphite-app bot commented Oct 14, 2025 •

edited

Loading