feat(formatter/sort_imports): Support customGroups attributes(selector and modifiers)#19356
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. |
customGroups attributes(selector and modifiers)
There was a problem hiding this comment.
Pull request overview
This pull request adds support for selector and modifiers attributes to customGroups in the experimentalSortImports configuration, enabling more fine-grained control over import grouping. The implementation follows an AND logic where all specified conditions (elementNamePattern, selector, and modifiers) must be met for an import to match a custom group.
Changes:
- Added
selectorandmodifiersfields toCustomGroupDefinitionfor filtering imports by kind and characteristics - Updated documentation to remove references to unimplemented
multilineandsinglelinemodifiers - Added comprehensive test coverage for various combinations of selector, modifiers, and pattern matching
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
tasks/website_formatter/src/snapshots/schema_markdown.snap |
Updated documentation with new selector/modifiers fields and removed unimplemented modifier references |
tasks/website_formatter/src/snapshots/schema_json.snap |
Updated JSON schema with new fields and corrected documentation |
npm/oxfmt/configuration_schema.json |
Added selector and modifiers to CustomGroupItemConfig schema |
crates/oxc_formatter/tests/ir_transform/sort_imports/custom_groups.rs |
Added 9 comprehensive tests covering all feature combinations |
crates/oxc_formatter/tests/ir_transform/mod.rs |
Updated test infrastructure to parse selector and modifiers |
crates/oxc_formatter/src/ir_transform/sort_imports/options.rs |
Added selector and modifiers fields to CustomGroupDefinition struct |
crates/oxc_formatter/src/ir_transform/sort_imports/group_matcher.rs |
Implemented AND logic for matching custom groups with selector/modifiers |
crates/oxc_formatter/src/ir_transform/sort_imports/group_config.rs |
Added parse methods for ImportModifier and exposed types |
apps/oxfmt/test/cli/sort_imports/sort_imports.test.ts |
Added CLI integration test for new functionality |
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/input.ts |
Test fixture input file |
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/.oxfmtrc.json |
Test fixture configuration |
apps/oxfmt/test/api/sort_imports.test.ts |
Added API integration test for selector and modifiers |
apps/oxfmt/src/core/oxfmtrc.rs |
Updated config parsing to handle selector and modifiers |
apps/oxfmt/src-js/index.ts |
Updated TypeScript types to include selector and modifiers as optional fields |
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/input.ts
Show resolved
Hide resolved
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/input.ts
Show resolved
Hide resolved
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/input.ts
Show resolved
Hide resolved
apps/oxfmt/test/cli/sort_imports/fixtures/custom_groups_selector_modifiers/input.ts
Show resolved
Hide resolved
Merging this PR will not alter performance
Comparing Footnotes
|
41867e1 to
444ee57
Compare
Merge activity
|
444ee57 to
d1c2fb6
Compare
# Oxlint ### 💥 BREAKING CHANGES - 7711821 oxlint: [**BREAKING**] `no-shadow-restricted-names` report `globalThis` by default (#19407) (Sysix) ### 🚀 Features - ce1baa0 linter: Implement eslint/no-shadow (#18979) (Víctor Fernández) - 7a333c1 linter: Support dynamic configs via CLI arguments (#19384) (camc314) - 1bf569b linter: Implement typescript/unified-signatures (#19375) (camc314) - 6562a9b linter: Implement typescript/parameter-properties (#19374) (camc314) - 94d8d74 linter: Implement typescript/no-use-before-define (#19373) (camc314) - 80b002a linter: Implement fixer for unicorn/no-instanceof-builtins (#19371) (camc314) - 5c3784b linter: Implement eslint/no-unmodified-loop-condition (#19341) (Vincent R) - cc00a59 linter/const-comparisons: Improve diagnostics when mixing logical/comparison operators (#19370) (camc314) - ea2c401 linter: Add support for no constructed context values (#18067) (Jovi De Croock) - f2440eb linter: Mark eslint/no-return-assign as having no fixer (#19327) (camc314) - 8588670 linter/unicorn: Implement suggestion for `unicorn/no-await-in-promise-methods` rule (#19359) (Mikhail Baev) - f0af965 linter: Move `jsx-a11y/no-static-element-interactions` rule out of the nursery. (#19355) (connorshea) - be0ce50 linter/tsgolint: Add support for labeled ranges in tsgolint diagnostics (#19201) (camchenry) - b5bc900 linter: Implement fixer for unicorn/no-new-buffer (#19326) (camc314) - 1612932 linter: Add typescript/no-unnecessary-condition (#19130) (camc314) - 37dc6c5 linter: Implement fixer for unicorn/prefer-includes (#19323) (camc314) ### 🐛 Bug Fixes - c2b1870 linter: Enforce config options for `react/forbid-dom-props` rule. (#19387) (connorshea) - 3d24e44 linter: Honor no-empty-function allow getters/setters for object literals (#19393) (camc314) - bbced8d linter: Enforce config options for `eslint/no-empty-function` rule, improve docs. (#19390) (connorshea) - 6bc8aec linter: Fix the behavior of `import/extensions` rule for a file that has multiple extensions. (#18919) (connorshea) - c62a295 linter/img-redundant-alt: Enforce whole-word matching for redundant alt text (#19367) (camc314) - 98956fe linter/describe-function-title: Skip autofix for type-only imports (#19329) (camc314) - d96d26d linter/plugins: Provide `parser.version` (#19364) (overlookmotel) - 81f0039 linter_codegen: Compute rule IDs relative to previous rule (#19350) (camchenry) - b7ef0a8 linter/consistent-indexed-object-style: Avoid unsafe Record conversions for mapped types (#19320) (camc314) ### 📚 Documentation - 3a6059f linter: Improve docs for `eslint/require-await` rule. (#19361) (connorshea) - b069269 linter/plugins: Add comment about deprecated `ScopeManager` methods (#19363) (overlookmotel) - 2d8aaf9 linter: Disable formatting for `eslint/no-unsafe-negation` examples. (#19347) (connorshea) - fb87806 linter: Ensure that we do not auto-format the docs for `unicorn/number-literal-case` rule. (#19346) (connorshea) - 8d3ae27 linter/typescript: Skip docs for deprecated type aware rule options (#19324) (camc314) # Oxfmt ### 💥 BREAKING CHANGES - 00135b5 formatter/sort_imports: [**BREAKING**] Change default `groups` order (#19427) (leaysgur) - 9c34f72 formatter/sort_imports: [**BREAKING**] Report invalid group name with renaming `side-effect` > `side_effect` (#19416) (leaysgur) ### 🚀 Features - 4baebef formatter/sort_imports: Support `{ newlinesBetween: bool }` inside `groups` (#19358) (leaysgur) - d1c2fb6 formatter/sort_imports: Support `customGroups` attributes(`selector` and `modifiers`) (#19356) (leaysgur) ### 🐛 Bug Fixes - f084ea6 oxfmt: Explicitly pass `process.env` for the forked process (#19380) (Long Ho) - 2bc7a14 formatter: Arrow function body incorrectly broken when return type has comment (#19368) (Dunqing) - 90ec3d2 oxfmt: Update tailwind plugin which fixes crash on non-js file (#19353) (leaysgur) - e9c5b1e formatter: Treat `PrivateFieldExpression` as simple call argument (#19348) (Dunqing) - 80643d5 formatter: Match Prettier union indentation with leading comments (#19271) (Dunqing) ### ⚡ Performance - c169c77 syntax: Optimize `is_identifier_name_patched` (#19386) (sapphi-red)

Fixes #19264
The original issue only mentioned
modifiers, but I've implementedselectoras well.While the original implementation also supports more attributes, I believe this is sufficient for now.