formatter: sort-imports

[leaysgur]

Part of #13610, tracking issue for sorting ImportDeclaration.

Phase 0: Foundation parts

• Research prior arts
  • Use @perfectionist/sort-imports as a reference
  • https://perfectionist.dev/rules/sort-imports
• Decide how to integrate it to current formatter workflow
  • Reorder IR, after formatting
• Implement very basic sorting
• Setup tests and verify current architecture

Phase 1: Features behind default options

• Fix options.type default alphabetical, not properly implemented localeCompare
• options.partitionByComments(boolean only)
• options.partitionByNewline
• options.sortSideEffects
• options.order
• options.ignoreCase
• options.newlinesBetween
• options.groups
• Clean up comments, credits, and past trials
• Investigate perf improvement with this benchmark result
• Align default groups with prettier-plugin-sort-imports default?

Phase 2: More advanced options, features

• Perf: Skip sorting if ImportDeclaration not found
• Handle ignore comments
• options.customGroups
• Consider to support or not
  • options.internalPattern
  • options.fallbackSort
  • options.environment
  • options.specialCharacters
  • options.type: natural, unsorted
  • options.locales
  • options.partitionByComments(non-boolean)
  • Support ImportEquals, require()?

[bc-m]

It would be great if oxc could automatically merge imports from the same source. For example:

import { A } from 'package';
import { B } from 'package';

could be merged into:

import { A, B } from 'package';

Maybe this could be added to the roadmap?

[leaysgur]

Thank you for your feedback!

I don't think it's impossible, but please let us to consider it first. 😉
In this issue, I will focus solely on sorting.

[binarybaba]

It would be great if oxc could automatically merge imports from the same source. For example:

import { A } from 'package';
import { B } from 'package';
could be merged into:

import { A, B } from 'package';
Maybe this could be added to the roadmap?

Shouldn't this be part of linter? I see they're actively doing support for eslint-plugin-import in the linter. It does it out of the box.

[bc-m]

@binarybaba I’d prefer having this in the formatter, since (i think) the linter should focus on actual code problems — or things that could potentially become problems — and separate imports are still valid code.

Maybe we should move this discussion to a separate issue or a GitHub discussion, so we can keep this thread focused on import sorting.