Skip to content

Comments

fix(formatter/sort_imports): Handle alignable comment with JsLabels#17791

Merged
graphite-app[bot] merged 1 commit intomainfrom
01-08-fix_formatter_sort_imports_handle_alignable_comment_with_jslabels
Jan 8, 2026
Merged

fix(formatter/sort_imports): Handle alignable comment with JsLabels#17791
graphite-app[bot] merged 1 commit intomainfrom
01-08-fix_formatter_sort_imports_handle_alignable_comment_with_jslabels

Conversation

@leaysgur
Copy link
Member

@leaysgur leaysgur commented Jan 8, 2026

Fixes #17788


This bug occurred because there was no way to distinguish Text element between

  • /* within TemplateLiteral
  • and /* representing part of an alignable_comment

in IR elements.

Now made it detectable by wrapping it in a new label.

Copilot AI review requested due to automatic review settings January 8, 2026 09:27
@leaysgur leaysgur requested a review from Dunqing as a code owner January 8, 2026 09:27
@github-actions github-actions bot added A-formatter Area - Formatter C-bug Category - Bug labels Jan 8, 2026
Copy link
Member Author

leaysgur commented Jan 8, 2026


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.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a panic in the sort imports transform that occurred when template literals containing /* were incorrectly identified as alignable block comments. The fix introduces a new AlignableBlockComment label to explicitly mark actual alignable comments, allowing the sort imports logic to distinguish them from template literal content.

  • Adds a new AlignableBlockComment label to track actual alignable block comments
  • Updates comment formatting to wrap alignable comments with the new label
  • Refactors sort imports logic to use label-based detection instead of text pattern matching

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
crates/oxc_formatter/src/lib.rs Adds the AlignableBlockComment enum variant and implements the Label trait method for it
crates/oxc_formatter/src/formatter/trivia.rs Wraps alignable comment formatting with StartLabelled and EndLabelled tags using the new AlignableBlockComment label
crates/oxc_formatter/src/ir_transform/sort_imports/mod.rs Refactors multiline comment detection from text-based to label-based, preventing false positives from template literals
crates/oxc_formatter/tests/ir_transform/sort_imports.rs Adds regression tests for template literals containing /* to verify the panic is fixed

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@leaysgur
Copy link
Member Author

leaysgur commented Jan 8, 2026

And I realized these labels are completely unnecessary when sort-imports is disabled!
I'll address this later as follow up PR.

@codspeed-hq
Copy link

codspeed-hq bot commented Jan 8, 2026

Merging this PR will not alter performance

Summary

✅ 38 untouched benchmarks
⏩ 7 skipped benchmarks1


Comparing 01-08-fix_formatter_sort_imports_handle_alignable_comment_with_jslabels (d8571d6) with main (7b7af13)

Open in CodSpeed

Footnotes

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

@Dunqing Dunqing added the 0-merge Merge with Graphite Merge Queue label Jan 8, 2026
Copy link
Member

Dunqing commented Jan 8, 2026

Merge activity

…17791)

Fixes #17788

---

This bug occurred because there was no way to distinguish `Text` element between

- `/*` within TemplateLiteral
- and `/*` representing part of an alignable_comment

in IR elements.

Now made it detectable by wrapping it in a new label.
@graphite-app graphite-app bot force-pushed the 01-08-fix_formatter_sort_imports_handle_alignable_comment_with_jslabels branch from d8571d6 to e2f534c Compare January 8, 2026 09:41
@graphite-app graphite-app bot merged commit e2f534c into main Jan 8, 2026
20 checks passed
@graphite-app graphite-app bot deleted the 01-08-fix_formatter_sort_imports_handle_alignable_comment_with_jslabels branch January 8, 2026 09:46
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Jan 8, 2026
Dunqing pushed a commit that referenced this pull request Jan 12, 2026
# Oxlint
### 🚀 Features

- 9699a1b linter/prefer-global-this: Add suggestion (#17873) (Mikhail
Baev)
- 51c2815 linter/no-invalid-regexp: Add labels and help text to flag
diagnostics (#17865) (camchenry)
- 344d77d linter/no-ex-assign: Improve diagnostic with more detail
(#17864) (camchenry)
- 7d280e0 linter: Add fixer for
`unicorn/no-useless-error-capture-stack-trace` rule (#17839) (Mikhail
Baev)
- af1d0e3 linter/prefer-optional-chain: Add rule (#17831) (camc314)
- e3c4108 vscode: Add more supported languages to extension (#17812)
(Alexander Lichter)
- 4a46678 vscode: Activate extension on more languages (#17717) (Sysix)
- b1298fc vscode: Sync formatter with supported files (#17615)
(Alexander Lichter)
- c7f0848 linte/rno-required-prop-with-default: Implement suggestion
(#17747) (Minsu Lee)
- 0e8127e linter/vue: Implement no-lifecycle-after-await (#17701)
(yefan)
- 3567304 linter/vitest: Implement `consistent-each-for` (#17601) (Said
Atrahouch)
- 883e156 linter: Add fixer for `unicorn/no-useless-collection-argument`
rule (#17594) (Mikhail Baev)
- 4eb335c linter/vitest: Implemented prefer-called-once (#17674) (Said
Atrahouch)
- 2bd2d5a linter/vitest: Implement hoisted-apis-on-top (#17658) (Said
Atrahouch)
- cfb2bcc linter/vue: Implement no-arrow-functions-in-watch (#17672)
(yefan)
- a68208a linter/eslint-plugin-vitest: Implements
`prefer-describe-function-title` (#17677) (Said Atrahouch)
- efa029f linter/vitest: Implement no-unneeded-async-expect-function
(#17494) (Minsu Lee)

### 🐛 Bug Fixes

- 49cf66e lsp: Fix workspace worker selection for nested and
similar-named workspaces (#17853) (Copilot)
- 84f4f3c linter: Add doc url for tsgolint diagnostics (#17879) (Sysix)
- 76c903f linter/consistent-indexed-object-style: Skip fixing default
exported interface (#17874) (Copilot)
- 7e87d16 linter/tabindex-no-positive: Improve diagnostic phrasing
(#17849) (connorshea)
- 28f9fba vscode: Fix nested search for binaries (#17832) (Sysix)
- 8ca2cd2 linter: Move jsx-a11y/no-static-element-interactions rule to
nursery. (#17818) (connorshea)
- dc9fdd6 linter/consistent-indexed-object-style: Re-port test cases and
fix some bugs (#17802) (camc314)
- 7bbd880 linter: Update prefer-destructuring rule metadata (#17642)
(Hamir Mahal)
- 3c45185 linter/consistent-indexed-object-style: False positive with
circular reference (#17789) (heygsc)
- bd186b4 vscode: Search for `oxlint` and `oxfmt` in every workspace
directory (#17760) (Sysix)
- 3e0dff7 linter/no-hooks: Add punctuation to diagnostic message
(#17751) (camc314)
- 6ae21f9 linter/prefer-called-once: Avoid panic on trailing comma
(#17735) (Said Atrahouch)
- 32c3901 oxlint: Do not panic on invalid `no-unused-vars` configuration
(#17719) (Sysix)
- 59a6228 parser: Detect TS1363 error for type-only imports with mixed
default and named/namespace bindings (#17712) (Copilot)

### ⚡ Performance

- f87a1e2 linter: Check for giving reserved plugin name before calling
`load_plugin` on napi side (#17841) (Sysix)

### 📚 Documentation

- a2b3a24 linter/no-caller: Improve docs and diagnostic for rule.
(#17890) (connorshea)
- aa48247 linter/no-unsafe-finally: Improve rule docs. (#17891)
(connorshea)
- 1b0bdee linter: Tweak docs for no-useless-constructor and
hoisted-apis-on-top (#17888) (connorshea)
- 8f24fa9 vscode: Remove mention of a built-in server (#17836) (Sysix)
- e81a306 linter: Update the tsconfig flag mention for the import
plugin. (#17778) (connorshea)
# Oxfmt
### 🚀 Features

- 539b350 formatter/sort_imports: Update `NODE_BUILTINS` modules
(#17771) (nilptr)
- 2e03ebf oxfmt/lsp: Use `SourceFormatter` to support non-JS files and
napi features (#17655) (leaysgur)
- 623f7eb oxfmt/sort_package_json: Use `options.sort_scripts` (#17740)
(leaysgur)
- 86c0168 oxfmt/sort_package_json: Handle `oxfmtrc.sort_scripts` option
(#17738) (leaysgur)
- 256636a oxfmt/lsp: Add `.editorconfig` to `get_watcher_patterns`
(#17694) (leaysgur)
- 3f3db39 oxfmt/lsp: Use `ConfigResolver` to align with CLI (#17654)
(leaysgur)

### 🐛 Bug Fixes

- fdd1e1e formatter: Don't wrap parenthesis for type assertion when it's
an declaration of export default (#17878) (Dunqing)
- f0813ad formatter: Incorrect type annotation check for short argument
(#17877) (Dunqing)
- 9e89389 formatter/tailwindcss: Nested class string doesn't respect
`singleQuote: true` (#17838) (Dunqing)
- e2f534c formatter/sort_imports: Handle alignable comment with JsLabels
(#17791) (leaysgur)
- f0cedd4 formatter/tailwindcss: Class name is broken after sorting when
its contains single quotes with `singleQuote: true` (#17790) (Dunqing)
- 1864142 oxfmt/tailwindcss: Bundle `prettier/plugins/*` (#17782)
(leaysgur)
- 3a9d43b oxfmt: Ignore explicit positional path which is ignored by
directory (#17732) (leaysgur)
- 0563217 formatter: Classes will be stripped out when both
`experimentalTailwindcss` and `experimentalSortImports` are enabled
(#17726) (Dunqing)

### ⚡ Performance

- d1bc514 formatter: Optimize RegExpLiteral formatting to avoid heap
allocations (#17797) (Dunqing)

### 📚 Documentation

- 62b7a01 formatter: Clarify `experimentalTailwindcss` configuration
comments (#17898) (Dunqing)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-formatter Area - Formatter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

formatter: sort-imports panics after oxfmt@0.22.0 release

2 participants