chore: enhance

Author: Shinigami92

.changeset/clear-bikes-jog.md

@@ -1,5 +1,5 @@
 ---
-"eslint-plugin-import-x": patch
+"eslint-plugin-import-x": minor
 ---
 
-fix: align with TypeScript Organize Imports for [mapped imports](https://nodejs.org/api/packages.html#imports)
+feat: add option `followTsOrganizeImports` for `order` rule

docs/rules/order.md

@@ -109,6 +109,7 @@ This rule supports the following options (none of which are required):
 - [`sortTypesGroup`][7]
 - [`newlines-between-types`][27]
 - [`consolidateIslands`][25]
+- [`followTsOrganizeImports`][26]
 
 ---
 
@@ -958,6 +959,17 @@ import type { G } from './aaa.js'
 import type { H } from './bbb'
 ```
 
+### `followTsOrganizeImports`
+
+Valid values: `boolean` \
+Default: `false`
+
+> [!CAUTION]
+>
+> Currently, `followTsOrganizeImports` defaults to `false`. However, in a later update, the default might change to `true`.
+
+When set to `true`, this option will align the behavior with [TypeScript's LSP Organize Imports][34] feature. This only has an effect if no manual `groups` are defined.
+
 ## Related
 
 - [`import-x/external-module-folders`][29]
@@ -984,10 +996,12 @@ import type { H } from './bbb'
 [22]: https://prettier.io
 [23]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#type-modifiers-on-import-names
 [25]: #consolidateislands
+[26]: #followtsorganizeimports
 [27]: #newlines-between-types
 [28]: ../../README.md#importinternal-regex
 [29]: ../../README.md#importexternal-module-folders
 [30]: #alphabetize
 [31]: https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free
 [32]: #distinctgroup
 [33]: #named
+[34]: https://code.visualstudio.com/docs/typescript/typescript-refactoring#_organize-imports

src/rules/order.ts

@@ -53,13 +53,13 @@ const defaultGroups = [
   'index',
 ] as const
 
-const defaultGroupsOfficialOrganizeImports = [
+const defaultGroupsTsOrganizeImports = [
   'private-import',
   'external',
   'builtin',
   'parent',
-  'sibling',
   'index',
+  'sibling',
 ] as const
 
 // REPORTING AND FIXING
@@ -1159,7 +1159,7 @@ export interface Options {
   pathGroups?: PathGroup[]
   sortTypesGroup?: boolean
   warnOnUnassignedImports?: boolean
-  privateImportsFeatureFlag?: boolean
+  followTsOrganizeImports?: boolean
 }
 
 type MessageId =
@@ -1282,8 +1282,9 @@ export default createRule<[Options?], MessageId>({
             type: 'boolean',
             default: false,
           },
-          privateImportsFeatureFlag: {
+          followTsOrganizeImports: {
             type: 'boolean',
+            // TODO: switch default to true in next major
             default: false,
           },
         },
@@ -1405,8 +1406,8 @@ export default createRule<[Options?], MessageId>({
       )
       const { groups, omittedTypes } = convertGroupsToRanks(
         options.groups ||
-          (options.privateImportsFeatureFlag
-            ? defaultGroupsOfficialOrganizeImports
+          (options.followTsOrganizeImports
+            ? defaultGroupsTsOrganizeImports
             : defaultGroups),
       )
       ranks = {

test/rules/order.spec.ts

@@ -4813,14 +4813,18 @@ describe('TypeScript', () => {
         tValid({
           code: `import { internA } from "#a";
 import { scopeA } from "@a/a";
+import a from 'a';
+import 'format.css';
 import fs from 'node:fs';
 import path from "path";
+import index from './';
 import { localA } from "./a";
+import sibling from './foo';
 `,
           ...parserConfig,
           options: [
             {
-              privateImportsFeatureFlag: true,
+              followTsOrganizeImports: true,
             },
           ],
         }),
@@ -5224,7 +5228,7 @@ import { localA } from "./a";
           ...parserConfig,
           options: [
             {
-              privateImportsFeatureFlag: true,
+              followTsOrganizeImports: true,
             },
           ],
           errors: [