Skip to content

Conversation

@leaysgur
Copy link
Member

@leaysgur leaysgur commented Nov 18, 2025

Part of #14253

Now user can specify own groups like:

groups: [
  "type",
  ["external", "builtin"]
]
  • Parse config
  • Implementation
  • Test
  • Refactor for readability
  • Refactor for performance
  • Report non-defaults?

Sorry for the large diffs. Yes, it's incredibly complicated. 😓

@github-actions github-actions bot added A-formatter Area - Formatter C-enhancement Category - New feature or request labels Nov 18, 2025
Copy link
Member Author

leaysgur commented Nov 18, 2025


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.

@leaysgur leaysgur force-pushed the 11-18-feat_formatter_sort-imports_support_options.groups branch from d3824ce to 64fb44c Compare November 18, 2025 08:55
@codspeed-hq
Copy link

codspeed-hq bot commented Nov 18, 2025

CodSpeed Performance Report

Merging #15831 will not alter performance

Comparing 11-18-feat_formatter_sort-imports_support_options.groups (4953781) with main (7c46a9e)1

Summary

✅ 38 untouched
⏩ 7 skipped2

Footnotes

  1. No successful run was found on main (acf9637) during the generation of this report, so 7c46a9e was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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

@leaysgur leaysgur force-pushed the 11-18-feat_formatter_sort-imports_support_options.groups branch 4 times, most recently from 0b395d7 to 5da5ddc Compare November 19, 2025 08:52
@leaysgur leaysgur changed the title feat(formatter/sort-imports): Support options.groups feat(formatter/sort-imports): Support options.groups Nov 19, 2025
@leaysgur leaysgur force-pushed the 11-18-feat_formatter_sort-imports_support_options.groups branch 11 times, most recently from 9d630eb to c9d6eac Compare November 20, 2025 07:42
@leaysgur leaysgur marked this pull request as ready for review November 20, 2025 07:48
@leaysgur leaysgur requested a review from Dunqing as a code owner November 20, 2025 07:48
Copilot AI review requested due to automatic review settings November 20, 2025 07:48
Copilot finished reviewing on behalf of leaysgur November 20, 2025 07:51
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 adds support for custom options.groups configuration in the experimental sort-imports feature, allowing users to define their own import grouping and ordering strategies (e.g., groups: ["type", ["external", "builtin"]]).

Key Changes:

  • Added groups field to SortImportsConfig with custom deserializer supporting both string and string array elements
  • Refactored code architecture: split import_unit.rs into three focused modules (group_config.rs, compute_metadata.rs, sortable_imports.rs)
  • Enhanced group matching to support complex patterns (e.g., type-external, side-effect-style, parent-type)
  • Changed default groups from hardcoded values to Option<Vec<Vec<String>>> (None uses defaults)

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
npm/oxfmt/configuration_schema.json Added groups property definition to SortImportsConfig schema
crates/oxc_formatter/tests/snapshots/schema_json.snap Updated snapshot to reflect schema changes
napi/playground/src/lib.rs Removed TODO comment and now uses configured groups from options
crates/oxc_formatter/src/service/oxfmtrc.rs Added custom deserializer for groups field and test coverage
crates/oxc_formatter/src/options.rs Changed groups from required Vec to Option, updated default implementation
crates/oxc_formatter/src/ir_transform/sort_imports/mod.rs Refactored to use new module structure, parse groups on initialization
crates/oxc_formatter/src/ir_transform/sort_imports/source_line.rs Added lifetime parameter, improved specifier detection logic
crates/oxc_formatter/src/ir_transform/sort_imports/partitioned_chunk.rs Integrated new sorting logic with group configuration
crates/oxc_formatter/src/ir_transform/sort_imports/group_config.rs New module defining group names, selectors, and modifiers with parsing
crates/oxc_formatter/src/ir_transform/sort_imports/compute_metadata.rs New module for import metadata computation and group matching
crates/oxc_formatter/src/ir_transform/sort_imports/sortable_imports.rs New module implementing sorting algorithm with side-effect preservation
crates/oxc_formatter/tests/ir_transform/sort_imports.rs Added comprehensive tests for custom group configurations
crates/oxc_formatter/tests/ir_transform/_sort-imports-tests.ref.snap Removed TypeScript test cases (migrated to Rust tests)
crates/oxc_formatter/examples/sort_imports.rs Updated to use None for default groups

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

@leaysgur leaysgur force-pushed the 11-18-feat_formatter_sort-imports_support_options.groups branch from c9d6eac to 4953781 Compare November 20, 2025 07:59
@graphite-app graphite-app bot added the 0-merge Merge with Graphite Merge Queue label Nov 20, 2025
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 20, 2025

Merge activity

Part of #14253

Now user can specify own `groups` like:

```js
groups: [
  "type",
  ["external", "builtin"]
]
```

- [x] Parse config
- [x] Implementation
- [x] Test
- [x] Refactor for readability
- [x] Refactor for performance
- [x] ~~Report non-defaults?~~

Sorry for the large diffs. Yes, it's incredibly complicated. 😓
@graphite-app graphite-app bot force-pushed the 11-18-feat_formatter_sort-imports_support_options.groups branch from 4953781 to 7818e22 Compare November 20, 2025 09:09
graphite-app bot pushed a commit that referenced this pull request Nov 20, 2025
@graphite-app graphite-app bot merged commit 7818e22 into main Nov 20, 2025
20 checks passed
@graphite-app graphite-app bot deleted the 11-18-feat_formatter_sort-imports_support_options.groups branch November 20, 2025 09:14
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 20, 2025
Copilot AI pushed a commit that referenced this pull request Nov 21, 2025
Part of #14253

Now user can specify own `groups` like:

```js
groups: [
  "type",
  ["external", "builtin"]
]
```

- [x] Parse config
- [x] Implementation
- [x] Test
- [x] Refactor for readability
- [x] Refactor for performance
- [x] ~~Report non-defaults?~~

Sorry for the large diffs. Yes, it's incredibly complicated. 😓
Copilot AI pushed a commit that referenced this pull request Nov 21, 2025
lilnasy pushed a commit to lilnasy/oxc that referenced this pull request Nov 24, 2025
# Oxlint
### 💥 BREAKING CHANGES

- cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (oxc-project#15712)
(overlookmotel)

### 🚀 Features

- 72660f7 linter: Support auto generate config document for tuple lint
option (oxc-project#15904) (Duc Nghiem Xuan)
- 0c1f82b linter/plugins: Add `tokens` property to `Program` (oxc-project#16020)
(overlookmotel)
- 9e61beb linter/plugins: Implement `SourceCode#getFirstToken()`
(oxc-project#16002) (Arsh)
- 9a548dd linter/plugins: Implement `SourceCode#getLastTokens()`
(oxc-project#16000) (Arsh)
- 0b6cb11 linter/plugins: Implement `SourceCode#getFirstTokens()`
(oxc-project#15976) (Arsh)
- 166781e linter/plugins: Implement `SourceCode#getTokenAfter()`
(oxc-project#15973) (Arsh)
- 6ae232b linter: Expose type errors via tsgolint (oxc-project#15917) (camc314)
- 2bfdd26 linter/plugins: Implement `SourceCode#getTokensAfter()`
(oxc-project#15971) (Arsh)
- 45fffc1 linter/plugins: Implement `SourceCode#getTokenBefore()`
(oxc-project#15956) (Arsh)
- 776e473 linter/plugins: Implement `SourceCode#getTokensBefore()`
(oxc-project#15955) (Arsh)
- 595867a oxlint: Generate markdownDescription fields for oxlint JSON
schema. (oxc-project#15959) (connorshea)
- 5569317 vscode: Add quick actions to status bar tooltip (oxc-project#15962)
(Sysix)
- 986cac1 linter/plugins: Token-related `SourceCode` APIs (TS ESLint
implementation) (oxc-project#15861) (Arsh)
- a21f9e4 linter: Implement unicorn/prefer-bigint-literals rule (oxc-project#15923)
(Michiel Vrins)
- 4b9d8d2 linter/type-aware: Include range with tsconfig diagnostics
(oxc-project#15916) (camc314)
- 220d01e editor: Improve the status bar item for the VS Code extension
by adding a tooltip. (oxc-project#15819) (connorshea)

### 🐛 Bug Fixes

- 2bd3cb6 apps, editors, napi: Fix `oxlint-disable` comments (oxc-project#16014)
(overlookmotel)
- 81f5360 linter/prefer-number-properties: Get fixer to replace entire
call expr (oxc-project#15979) (camc314)
- e4ba07f language_server: Always write to memory file system (oxc-project#15975)
(Sysix)
- a8a2032 linter: Support missing `range` for internal diagnostics
(oxc-project#15964) (camc314)
- 619a226 oxlint/lsp: Don't register `textDocument/formatting`
capability (oxc-project#15882) (Sysix)
- 6ab1a20 linter: Fix no_useless_spread producing invalid syntax when
removing empty object spreads (oxc-project#15905) (camc314)
- be4b6df linter: Unicorn/prefer-string-replace-all incorrectly escapes
backslashes (oxc-project#15901) (camc314)
- 9fa9ef2 linter: Gracefully fail when using import plugin, large file
counf and JS plugins (oxc-project#15864) (camc314)
- c027398 linter/plugins: Correct bindings package names glob in TSDown
config (oxc-project#15871) (overlookmotel)
- b622ef8 linter: Fix `oxc/bad_array_method_on_arguments` rule behavior.
(oxc-project#15854) (connorshea)
- aa06c3f linter: Recognize NewExpression as value context in
no-unused-private-class-members (oxc-project#15843) (camc314)
- e89c5ba typescript/prefer-namespace-keyword: Skip nested
`TSModuleDeclaration`s (oxc-project#15806) (overlookmotel)
- 646d020 linter/exhaustive-dependencies: Prevent is_callee_of_call_expr
flag from leaking into nested expressions (oxc-project#15832) (camc314)
- 46bd6bd linter/plugins: Pin `@typescript-eslint/scope-manager`
dependency (oxc-project#15807) (overlookmotel)
- fba31fa linter: Patch `@typescript-eslint/scope manager` (oxc-project#15214)
(Arsh)
- 50307c1 linter/jest: Ignore `expect` identifier in argument position
(oxc-project#15785) (camc314)

### ⚡ Performance

- 024b48a linter/plugins: Lazy-load tokens parsing code (oxc-project#16011)
(overlookmotel)
- 15365c9 linter/plugins: Reduce var assignments (oxc-project#15953)
(overlookmotel)
- 84d1f4f linter/plugins: Downgrade some checks to debug-only (oxc-project#15922)
(overlookmotel)
- a49f704 linter/typescript: Avoid searching source text unless required
(oxc-project#15805) (overlookmotel)

### 📚 Documentation

- ceffa5a linter: Add config option docs for various rules. (oxc-project#16024)
(connorshea)
- 9a0ed13 linter: Fix config option docs for eslint/operator-assignment
rule. (oxc-project#16030) (connorshea)
- 0b18005 linter: Add config docs generation for rules with Regex
arguments (oxc-project#15978) (connorshea)
- 48d18e0 linter: Improve diagnostic message for promise/catch-or-return
rule (oxc-project#15980) (connorshea)
- 6c72e84 linter: Use backticks for code elements across more rule
diagnostics (oxc-project#15958) (connorshea)
- a63dad7 linter/plugins: Add comment (oxc-project#15952) (overlookmotel)
- 81ea642 vscode: Use markdownDescription for better formatting in
VSCode Settings (oxc-project#15889) (connorshea)
- db6a110 linter/plugins: Fix JSDoc comment (oxc-project#15884) (overlookmotel)
- 1487271 linter: Add config option docs for `jsdoc/require-param` and
`jsdoc/require-returns` rules (oxc-project#15857) (connorshea)
- fbf0fd4 linter/plugins: Add JSDoc comments to `Plugin` and `Rule`
types (oxc-project#15815) (overlookmotel)
- ac5e4b5 linter/plugins: Add JSDoc comments and improve comments
(oxc-project#15814) (overlookmotel)
- 9b7b083 linter: Fix error in `curly` `"all"` example (oxc-project#15801)
(camc314)
- 65a3520 linter: Improve diagnostic for consistent-type-definitions
rule. (oxc-project#15752) (connorshea)

### 🛡️ Security

- f9b9276 deps: Update dependency rolldown to v1.0.0-beta.51 (oxc-project#15856)
(renovate[bot])
# Oxfmt
### 💥 BREAKING CHANGES

- a937890 formatter: [**BREAKING**] Default to `lineWidth: 100` (oxc-project#15933)
(leaysgur)
- 03d5f5a formatter/sort-imports: [**BREAKING**] Change default order to
`natural` with `natord` crate (oxc-project#15828) (leaysgur)
- cbb27fd ast: [**BREAKING**] Add `TSGlobalDeclaration` type (oxc-project#15712)
(overlookmotel)

### 🚀 Features

- 7818e22 formatter/sort-imports: Support `options.groups` (oxc-project#15831)
(leaysgur)
- f9a502c oxfmt: `oxfmt --lsp` support (oxc-project#15765) (leaysgur)

### 🐛 Bug Fixes

- 4817486 formatter: Revert `FormatElement::BestFitting` printing logic
(oxc-project#16028) (Dunqing)
- 5562dd6 formatter: Incorrect formatting method chain with trailing
comments (oxc-project#16027) (Dunqing)
- 6d14c8b formatter: Comments in export class decorators are printing
incorrectly (oxc-project#15897) (Dunqing)
- 683c764 formatter: Correct a few minor mismatched typescript tests
(oxc-project#15894) (Dunqing)
- c11cc07 formatter: Improve formatting for default type on type
parameters (oxc-project#15893) (Dunqing)
- 0bff596 formatter: Handle JSX expresssion dangling comment (oxc-project#15890)
(leaysgur)
- 16a9dc8 formatter: Inconsistent printing of class extends and
interface extends (oxc-project#15892) (Dunqing)
- 300b496 formatter: Inconsistent CallExpression and NewExpression
around member chain and logical expression (oxc-project#15858) (Dunqing)

### ⚡ Performance

- 65174cc formatter: Reduce the size of `TextWidth` to 4 byte (oxc-project#15827)
(Dunqing)
- 4fe3aac formatter: Use `ArenaVec` and `ArenaBox` (oxc-project#15420) (Dunqing)

Co-authored-by: overlookmotel <557937+overlookmotel@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-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants