-
-
Notifications
You must be signed in to change notification settings - Fork 728
feat(formatter/sort_imports): Sort imports by Array<Array<string>> groups
#15578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(formatter/sort_imports): Sort imports by Array<Array<string>> groups
#15578
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
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. |
4186bb5 to
7c9c8f3
Compare
07a8e69 to
04e4bb9
Compare
CodSpeed Performance ReportMerging #15578 will not alter performanceComparing Summary
Footnotes
|
04e4bb9 to
c9591ea
Compare
7c9c8f3 to
564a635
Compare
Array<Array<string>> groups
564a635 to
cf3f9cf
Compare
There was a problem hiding this 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 refactors the import sorting functionality to use configurable group definitions (Vec<Vec<String>>) instead of a hard-coded enum-based approach. The new system matches imports against group names like 'type-import', ['value-builtin', 'value-external'], etc., following the Perfectionist plugin convention. This enables more flexible import organization and sets the stage for user-configurable groups in future PRs.
Key changes:
- Replaced
ImportGroupenum with dynamic group matching usingVec<Vec<String>> - Implemented
match_group()andgenerate_group_names()methods for flexible import categorization - Added
groupsfield toSortImportsstruct with adefault_groups()factory method
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 |
|---|---|
| crates/oxc_formatter/src/options.rs | Added groups field to SortImports struct and removed Copy and Hash derives; implemented default_groups() method |
| crates/oxc_formatter/src/ir_transform/sort_imports/import_unit.rs | Removed ImportGroup enum; added group matching logic with ImportSelector and ImportModifier enums |
| crates/oxc_formatter/src/ir_transform/sort_imports/mod.rs | Updated to pass groups by reference and use group index instead of group enum |
| crates/oxc_formatter/src/lib.rs | Changed to clone experimental_sort_imports since it's no longer Copy |
| crates/oxc_formatter/src/service/oxfmtrc.rs | Added TODO and default groups initialization |
| crates/oxc_formatter/examples/sort_imports.rs | Added groups field initialization and cloning |
| napi/playground/src/options.rs | Added documentation for experimental_sort_imports and new groups option |
| napi/playground/src/lib.rs | Added TODO and default groups initialization |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Merge activity
|
…groups (#15578) Current implementation was performimg sort based on hard-coded `enum`. This PR changed it to use group definitions like this. ```js [ 'type-import', ['value-builtin', 'value-external'], 'type-internal', 'value-internal', ['type-parent', 'type-sibling', 'type-index'], ['value-parent', 'value-sibling', 'value-index'], 'ts-equals-import', 'unknown', ] ``` > https://perfectionist.dev/rules/sort-imports#groups And this will be refactored in the subsequent 2 PRs.
cf3f9cf to
25a0163
Compare
# Oxlint ### 🚀 Features - c199e38 linter: Implement config for all tsgolint rules supporting options (#15659) (camchenry) - 7598b3e linter: Allow configuring tsgolint rules (#15286) (camchenry) - e77f2ce vscode: Support `oxlint --lsp` (#15680) (Sysix) - e01c551 oxlint: Add `--lsp` flag to run the language server (#15611) (Sysix) - ac5c2ab lsp/fmt: Support ignore files & patterns (#15647) (Sysix) - e50a9bf linter: Add unicorn/prefer-response-static-json rule (#15692) (Mikhail Baev) - f5d9abb oxlint: Add enabled? column to --rules cli output (#15213) (Wren) - 6b5205c linter/plugins: Implement deprecated `SourceCode#getJSDocComment` method (#15653) (overlookmotel) - 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens methods (#15645) (overlookmotel) - 4c62ffa language_server: Add `run_server` helper for CLI tools (#15609) (Sysix) - 0d52a5e linter/plugins: Implement `Context#parserOptions` getter (#15632) (overlookmotel) - 287a538 linter/plugins: Implement `Context#get*` deprecated methods (#15606) (overlookmotel) - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - e763919 linter: Add test to enforce schema documentation for rules with configuration options (#15234) (Connor Shea) - 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr` option (#15507) (Li Wei) ### 🐛 Bug Fixes - 1decd57 linter/no-empty-named-blocks: Only search within node for comma token (#15751) (camc314) - 17c3d6d linter: Improve docs, diagnostic message, and implementation of typescript/consistent-indexed-object-style rule. (#15750) (connorshea) - 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for token (#15735) (camc314) - 042befd linter/require-await: Skip comments when searching for token (#15734) (camc314) - 7a78220 linter/no-async-await: Skip comments when searching for token (#15733) (camc314) - 23b9ad1 linter/consistent-type-specifier-style: Skip comments when searching for token (#15732) (camc314) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) - 516d14e linter/no-namespace: Skip comments when searching for token (#15716) (camc314) - b5aaace linter/prefer-namespace-keyword: Skip comments when searching for token (#15715) (camc314) - 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (#14203) (Sysix) - 9f991a4 linter: Reverse extends overrides priority (#14939) (Peter Wagenet) - 7c4a916 linter: Restores `oxlint --rules -f=json` functionality. (#15689) (Wren) - 24d00f4 linter/plugins: Add types for suggested fixes (#15636) (overlookmotel) - 257360f linter/plugins: Fill in TS type def for `RuleMeta` (#15629) (overlookmotel) - 81e179c linter: Allow file extensions without a dot in react/jsx-filename-extension rule (#15574) (Connor Shea) - 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs (#15581) (connorshea) - bb5f8ca oxlint: Fix type annotation for big-endian (#15561) (Sysix) ### ⚡ Performance - e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat mode (#15693) (overlookmotel) - 7528db4 language_server: Pass file content as a referenced `String` (#15568) (Sysix) - 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines` (#15641) (overlookmotel) - ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (#15516) (Sysix) ### 📚 Documentation - 3ab750a linter: Clarify react-in-jsx-scope rule docs. (#15749) (connorshea) - a5feebc linter: `oxlint-disable` not `eslint-disable` (#15672) (overlookmotel) - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) - 16fcba6 linter: Remove "experimental" from description of stable features (#15669) (overlookmotel) - e62fd98 linter: Correct comment on what `EnablePlugins` does (#15668) (overlookmotel) - a25d31e linter: Fix grammar (#15666) (overlookmotel) - f5f452f linter: Add missing `perf` category (#15667) (overlookmotel) - 2c58952 linter: Add config docs for no-restricted-globals rule. (#15662) (connorshea) - a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema` (#15642) (overlookmotel) - 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in ESLint-compat `Context` shim (#15605) (overlookmotel) - fd58aea linter: Fix a typo in the docs for react/no-is-mounted. (#15575) (Connor Shea) # Oxfmt ### 🚀 Features - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - 99823ad oxfmt: Print nothing for default(write) mode (#15583) (leaysgur) - 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>` groups (#15578) (leaysgur) ### 🐛 Bug Fixes - bf20cf5 formatter: `CRLF` issue in the member chain (#15764) (Dunqing) - 5d688a0 formatter: Measuring multiline text in `fits_text` is incorrect (#15762) (Dunqing) - e306958 formatter: Regression case for test call (#15760) (Dunqing) - c42d983 formatter: Re-fix all cases that fail after `AstNode::Argument` was removed (#15676) (Dunqing) ### ⚡ Performance - d99a83f oxfmt: Use simdutf8 based read_to_string (#15614) (leaysgur) - 128e186 formatter/sort_imports: Precompute import metadata (#15580) (leaysgur) - cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for `next_elements` (#15579) (leaysgur) ### 📚 Documentation - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

Current implementation was performimg sort based on hard-coded
enum.This PR changed it to use group definitions like this.
And this will be refactored in the subsequent 2 PRs.