Fix duplicated comments in for..of formatter#8395
Merged
cknitt merged 2 commits intorescript-lang:masterfrom Apr 27, 2026
Merged
Fix duplicated comments in for..of formatter#8395cknitt merged 2 commits intorescript-lang:masterfrom
cknitt merged 2 commits intorescript-lang:masterfrom
Conversation
fhammerschmidt
approved these changes
Apr 27, 2026
rescript
@rescript/darwin-arm64
@rescript/darwin-x64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/runtime
@rescript/win32-x64
commit: |
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
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
Fixes #8394.
for..ofandfor await..ofloops.forandwhileloops are not affected by the issue.Details
Issue #8394 was caused by the comment walker for
Pexp_for_ofandPexp_for_await_ofpassing the same full comment list to the loop pattern,iterable expression, and body. That allowed a single source comment to attach to
multiple nodes, so formatting duplicated it and repeated formatting compounded
the duplication.
The fix partitions comments through the pattern, iterable expression, and body,
matching the ownership approach already used by normal range
forloops.Verification
Reproduced the original duplication locally before the fix.
Checked
for..of,for await..of, rangefor, andwhilewith bodycomments after the fix.
Ran targeted printer fixture diff:
_build/install/default/bin/res_parser tests/syntax_tests/data/printer/comments/expr.res > /tmp/expr8394.out diff -u tests/syntax_tests/data/printer/comments/expected/expr.res.txt /tmp/expr8394.outRan a two-pass formatter roundtrip for the reproducer.
Ran
make checkformat.