Skip to content

fix(formatter): don't move comments inside variable declaration in for of loop#22773

Merged
leaysgur merged 10 commits into
oxc-project:mainfrom
Leonabcd123:fix/destructured-for-loop-comment
May 28, 2026
Merged

fix(formatter): don't move comments inside variable declaration in for of loop#22773
leaysgur merged 10 commits into
oxc-project:mainfrom
Leonabcd123:fix/destructured-for-loop-comment

Conversation

@Leonabcd123

@Leonabcd123 Leonabcd123 commented May 27, 2026

Copy link
Copy Markdown
Contributor

Fixes #22748

In cases like:

for (const [
  item1, 
  item2, 
  item3, 
  item4, 
  // comment at the end
] of someIterable) {
  // 
}

leave the comments inside the array instead of formatting them as leading comments, instead only format the comments after the left side of the for of loop.

@codspeed-hq

codspeed-hq Bot commented May 27, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 52 untouched benchmarks
⏩ 5 skipped benchmarks1


Comparing Leonabcd123:fix/destructured-for-loop-comment (0633812) with main (0be59a3)

Open in CodSpeed

Footnotes

  1. 5 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.

@Leonabcd123 Leonabcd123 marked this pull request as draft May 27, 2026 18:19
@Leonabcd123 Leonabcd123 changed the title fix(formatter): don't move comments in for of loop fix(formatter): don't move comments in for of loop that declares an array/object May 27, 2026
@Leonabcd123 Leonabcd123 changed the title fix(formatter): don't move comments in for of loop that declares an array/object fix(formatter): don't move comments inside variable declaration in for of loop May 27, 2026
@Leonabcd123 Leonabcd123 marked this pull request as ready for review May 27, 2026 19:16

@leaysgur leaysgur left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I think this should be applied to ForIn too. I'll check it later.

@leaysgur leaysgur merged commit f200c40 into oxc-project:main May 28, 2026
38 checks passed
graphite-app Bot pushed a commit that referenced this pull request May 28, 2026
…r in loop (#22776)

The same fix of #22773, just for for-in loop.
@Leonabcd123 Leonabcd123 deleted the fix/destructured-for-loop-comment branch May 28, 2026 03:30
camc314 pushed a commit that referenced this pull request Jun 1, 2026
# Oxlint
### 🚀 Features

- e4b1f46 linter/typescript: Implement `method-signature-style` rule
(#22679) (Mikhail Baev)
- bc462ca linter/vue: Implement no-reserved-component-names rule
(#22741) (bab)
- ef9e751 linter/vue: Implement component-definition-name-casing rule
(#22818) (bab)
- d67f51a linter/vue: Implement require-prop-type-constructor rule
(#22708) (bab)
- 1444f82 linter/promise/spec-only: Add `Promise.try` to `Promise`
static methods (#22812) (Ben Saufley)
- 8422e8b linter/jsdoc: Implement `require-yields-description` rule
(#22805) (Mikhail Baev)
- fe93f97 linter/eslint: Implement `prefer-named-capture-group` rule
(#22759) (Sebastian Poxhofer)
- 1a7798b linter: Add suggestion for `unicorn/no-new-array` (#22682)
(Sysix)

### 🐛 Bug Fixes

- 760a9f9 linter: Report errors when writing to the filesystem (#22881)
(camc314)
- e5a2748 linter: Avoid no-unreachable false positive after conditional
loop (#22869) (camc314)
- 39d92d6 linter/arrow-body-style: Preserve comments within function
(#22854) (Sysix)
- 3d13e29 parser: Reject `declare` in an already-ambient context
(TS1038) (#22850) (Boshen)
- 5152854 parser: Reject statements in ambient contexts (TS1036)
(#22849) (Boshen)
- 2eafea6 parser: Reject function implementations in ambient contexts
(TS1183) (#22845) (Boshen)
- c645615 parser: Reject incompatible class member modifiers (#22843)
(Boshen)
- 4a1ca4a linter/export: Detect duplicate explicit exports (#22798)
(camc314)
- 0a9a735 linter/no-loop-func: Allow safe let closures (#22811)
(camc314)
- 1599f11 linter: Align lsp extends default plugins (#22788) (camc314)
- db32ec9 linter/no-accumulating-spread: Use loop as primary span
(#22800) (camc314)
- 33ec6b4 linter/consistent-test-it: Avoid adjacent describe leakage
(#22796) (camc314)
- 2606069 linter/no-array-sort: Unwrap parenthesized sort args (#22794)
(camc314)
- 9f2f709 linter/no-array-sort: Skip non compare fn sort arguments
(#22752) (Gaurav Dubey)
- 27268a0 linter/no-else-return: Preserve statement boundary in fixer
(#22687) (camc314)
- d9cb6d8 linter/no-empty-function: Allow functions callbacks with
`allow: functions` (#22764) (camc314)
- a40a314 linter/no-shadow-restricted-names: Ignore enum members
(#22762) (camc314)
- 82366d9 linter/no-cond-assign: Align ternary handling (#22761)
(camc314)

### 📚 Documentation

- 5e113ba linter: Add license notices for ported ESLint plugins (#22768)
(Boshen)
# Oxfmt
### 🚀 Features

- d75cbbf oxfmt: Format `parser:json` files by `oxc_formatter_json`
(#22709) (leaysgur)
- 49db054 formatter_json: Implement `oxc_formatter_json` (json variant
only) (#22641) (leaysgur)
- 9c71f2e ast, codegen, formatter: Add `WithClauseKeyword::as_str`
helper and use it (#22791) (camc314)

### 🐛 Bug Fixes

- d3cdd62 oxfmt: Skip formatting for whitespace-only file (#22780)
(leaysgur)
- 23f0cc8 formatter: Don't move comments inside variable declaration in
for in loop (#22776) (leaysgur)
- f200c40 formatter: Don't move comments inside variable declaration in
for of loop (#22773) (Leonabcd123)

### 📚 Documentation

- 845f393 oxfmt,formatter,formatter_json,formatter_core: Add/update
AGENTS.md (#22873) (leaysgur)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

formatter: Diff with Prettier on comments in destructured for loop variables

2 participants