V6

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [18.x, 20.x, 22.x]
+        node: [20.x, 22.x, 24.x]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4

.prettierignore

@@ -1,2 +1,6 @@
 tests/
 lib/
+examples/
+.github/
+docs/
+*.md

.prettierrc

@@ -0,0 +1,16 @@
+{
+    "printWidth": 80,
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "singleQuote": true,
+    "bracketSameLine": true,
+    "semi": true,
+    "importOrder": ["^[./]"],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true,
+    "plugins": [
+        "prettier-plugin-ember-template-tag",
+        "prettier-plugin-svelte",
+        "./lib/src/index.js"
+    ]
+}

CHANGELOG.md

@@ -2,6 +2,31 @@
 
 
 ---
+### 6.0.0
+
+#### Breaking Changes
+- **Switch to ESM** [#366](https://github.com/trivago/prettier-plugin-sort-imports/pull/366) by [@RobbieTheWagner](https://github.com/RobbieTheWagner) - The plugin now uses ES modules instead of CommonJS
+- **Require Node >= 20.x** [#367](https://github.com/trivago/prettier-plugin-sort-imports/pull/367) by [@RobbieTheWagner](https://github.com/RobbieTheWagner) - Drop support for Node.js versions below 20
+- **Switch to vitest** [#370](https://github.com/trivago/prettier-plugin-sort-imports/pull/370) by [@RobbieTheWagner](https://github.com/RobbieTheWagner) - Replaced Jest with Vitest for better ESM support
+
+#### New features
+- **Ember.js gjs/gts support** [#377](https://github.com/trivago/prettier-plugin-sort-imports/pull/377) by [@NullVoxPopuli](https://github.com/NullVoxPopuli) and [@RobbieTheWagner](https://github.com/RobbieTheWagner) - Add support for Ember.js gjs/gts file formats with namespace and named type imports
+- **`<BUILTIN_MODULES>` placeholder** [#381](https://github.com/trivago/prettier-plugin-sort-imports/pull/381) by [@sdotson](https://github.com/sdotson) - Add support for sorting Node.js builtin modules to a specific position using `<BUILTIN_MODULES>` placeholder in `importOrder`
+- **`<SEPARATOR>` placeholder** [#339](https://github.com/trivago/prettier-plugin-sort-imports/pull/339) - Add `<SEPARATOR>` keyword for fine-grained control over import group separation when `importOrderSeparation` is enabled
+- **Sort by length option** [#224](https://github.com/trivago/prettier-plugin-sort-imports/pull/224) by [@KLewin23](https://github.com/KLewin23) - Add option to sort imports by import statement length
+- **`importOrderExclude` option** [#384](https://github.com/trivago/prettier-plugin-sort-imports/pull/384) by [@RyderKishan](https://github.com/RyderKishan) - Add support for excluding specific files from import sorting using glob patterns
+- **Expand `sort-imports-ignore` detection** [#358](https://github.com/trivago/prettier-plugin-sort-imports/pull/358) by [@ckwalsh](https://github.com/ckwalsh) - Improved detection of `sort-imports-ignore` comments throughout the file, not just at line 1
+
+#### Performance improvements
+- **Improve `removeNodesFromOriginalCode()` performance** [#356](https://github.com/trivago/prettier-plugin-sort-imports/pull/356) by [@ckwalsh](https://github.com/ckwalsh) - Replace RegExp logic with string slices for better performance
+
+#### Refactoring
+- **Stop rerendering directives** [#357](https://github.com/trivago/prettier-plugin-sort-imports/pull/357) by [@ckwalsh](https://github.com/ckwalsh) - Inject imports instead of re-rendering directives to better preserve whitespace and reduce formatting conflicts
+- **Stop ignoring exceptions in snapshot tests** [#355](https://github.com/trivago/prettier-plugin-sort-imports/pull/355) by [@ckwalsh](https://github.com/ckwalsh) - Improve test reliability by properly handling exceptions
+
+#### Chores
+- Add pnpm install command to README [#361](https://github.com/trivago/prettier-plugin-sort-imports/pull/361) - Document pnpm installation option
+
 ### 5.2.2
 - Update packages and pin babel/types [#343](https://github.com/trivago/prettier-plugin-sort-imports/pull/343) by [@byara](https://github.com/byara)
 

CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -71,4 +71,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -15,7 +15,7 @@ import React, {
     KeyboardEvent,
 } from 'react';
 import { logger } from '@core/logger';
-import { reduce, debounce } from 'lodash';
+import { reduce, debounce } from 'lodash-es';
 import { Message } from '../Message';
 import { createServer } from '@server/node';
 import { Alert } from '@ui/Alert';
@@ -29,7 +29,7 @@ import { createConnection } from '@server/database';
 ### Output
 
 ```javascript
-import { debounce, reduce } from 'lodash';
+import { debounce, reduce } from 'lodash-es';
 import React, {
     ChangeEvent,
     FC,
@@ -53,18 +53,24 @@ import { add, filter, repeat } from '../utils';
 
 ### Install
 
-npm
+using npm
 
 ```shell script
 npm install --save-dev @trivago/prettier-plugin-sort-imports
 ```
 
-or, using yarn
+using yarn
 
 ```shell script
 yarn add --dev @trivago/prettier-plugin-sort-imports
 ```
 
+using pnpm
+
+```shell script
+pnpm add -D @trivago/prettier-plugin-sort-imports
+```
+
 **Note: If you are migrating from v2.x.x to v3.x.x, [Please Read Migration Guidelines](./docs/MIGRATION.md)**
 
 **Note: If formatting `.vue` sfc files please install `@vue/compiler-sfc` if not in your dependency tree - this normally is within Vue projects.**
@@ -114,6 +120,14 @@ To move the third party imports at desired place, you can use `<THIRD_PARTY_MODU
 "importOrder": ["^@core/(.*)$", "<THIRD_PARTY_MODULES>", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
 ```
 
+You can also use `<BUILTIN_MODULES>` to control the position of Node.js builtin modules (like `fs`, `path`, `http`, and their `node:` prefixed variants):
+
+```
+"importOrder": ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
+```
+
+When `<BUILTIN_MODULES>` is included in your `importOrder`, Node.js builtin modules will be sorted to that position. If not included, builtin modules are treated as regular third-party imports.
+
 #### `importOrderSeparation`
 
 **type**: `boolean`
@@ -127,6 +141,9 @@ between sorted import declarations group. The separation takes place according t
 "importOrderSeparation": true,
 ```
 
+If this option is enabled and `<SEPARATOR>` is used in the `importOrder` array, the plugin 
+will ONLY add newlines at those locations and at the end of the imports.
+
 #### `importOrderSortSpecifiers`
 
 **type**: `boolean`
@@ -198,6 +215,13 @@ with options as a JSON string of the plugin array:
 importOrderParserPlugins: []
 ```
 
+### `importOrderSortByLength`
+**type**: `'asc' | 'desc' | null`
+**default value**: `null`
+
+A choice value to enable sorting imports within their groups based on their string lengths, the two options being ascending and descending.
+Leaving the value blank or setting it to null will result in length being ignored
+
 ### `importOrderSideEffects`
 **type**: `boolean`
 **default value**: `true`
@@ -229,6 +253,7 @@ import b from 'b'
 import c from 'c'
 ```
 
+
 ### Ignoring import ordering
 
 In some cases it's desired to ignore import ordering, specifically if you require to instantiate a common service or polyfill in your application logic before all the other imports. The plugin supports the `// sort-imports-ignore` comment, which will exclude the file from ordering the imports.
@@ -267,6 +292,12 @@ In the end, the plugin returns final imports with _third party imports_ on top a
 
 The _third party imports_ position (it's top by default) can be overridden using the `<THIRD_PARTY_MODULES>` special word in the `importOrder`.
 
+### Pattern Matching Implementation
+
+This plugin uses [minimatch](https://github.com/isaacs/minimatch) for pattern matching of import paths. The matching is performed using the exact version specified in the plugin's dependencies to ensure consistent behavior. This is important to note because different versions of minimatch or other glob matching libraries might have subtle differences in their pattern matching behavior.
+
+If you're experiencing unexpected matching behavior, please ensure you're using patterns compatible with minimatch's syntax, which might differ slightly from other glob implementations.
+
 ### FAQ / Troubleshooting
 
 Having some trouble or an issue ? You can check [FAQ / Troubleshooting section](./docs/TROUBLESHOOTING.md).
@@ -277,11 +308,13 @@ Having some trouble or an issue ? You can check [FAQ / Troubleshooting section](
 | ---------------------- | ------------------------ | ------------------------------------------------ |
 | JS with ES Modules     | ✅ Everything            | -                                                |
 | NodeJS with ES Modules | ✅ Everything            | -                                                |
+| Angular                | ✅ Everything            | Supported through `importOrderParserPlugins` API |
+| Ember                  | ✅ Everything            | `prettier-plugin-ember-template-tag` is required |
 | React                  | ✅ Everything            | -                                                |
 | Solid                  | ✅ Everything            | -                                                |
-| Angular                | ✅ Everything            | Supported through `importOrderParserPlugins` API |
-| Vue                    | ✅ Everything            | `@vue/compiler-sfc` is required                  |
 | Svelte                 | ✅ Everything            | `prettier-plugin-svelte` is required             |
+| Vue                    | ✅ Everything            | `@vue/compiler-sfc` is required                  |
+
 
 ### Used by
 
@@ -299,10 +332,10 @@ debug some code in the plugin, check [Debugging Guidelines](./docs/DEBUG.md)
 
 ### Maintainers
 
-| [Ayush Sharma](https://github.com/ayusharma)                             | [Behrang Yarahmadi](https://github.com/byara)                         | [Vladislav Arsenev](https://github.com/vladislavarsenev)                 |
-| ------------------------------------------------------------------------ | --------------------------------------------------------------------- |--------------------------------------------------------------------------|
-| ![ayusharma](https://avatars2.githubusercontent.com/u/6918450?s=120&v=4) | ![@byara](https://avatars2.githubusercontent.com/u/6979966?s=120&v=4) |![@vladislavarsenev](https://avatars.githubusercontent.com/u/51095682?s=120&v=4)|
-| [@ayusharma](https://twitter.com/ayusharma_)                             | [@behrang_y](https://twitter.com/behrang_y)                           |                                                                          |
+| [Ayush Sharma](https://github.com/ayusharma)                             | [Behrang Yarahmadi](https://github.com/byara)                         |
+| ------------------------------------------------------------------------ | --------------------------------------------------------------------- |
+| ![ayusharma](https://avatars2.githubusercontent.com/u/6918450?s=120&v=4) | ![@byara](https://avatars2.githubusercontent.com/u/6979966?s=120&v=4) |
+| [@ayusharma\_](https://twitter.com/ayusharma_)                           | [@behrang_y](https://twitter.com/behrang_y)                           |
 
 ### Disclaimer
 

docs/TROUBLESHOOTING.md

@@ -87,7 +87,7 @@ Due to the package handling of the pnpm, sometimes, the plugin is not automatica
 via prettier config.
 ```js
   module.exports = {
-    plugins: [require('@trivago/prettier-plugin-sort-imports')],
+    plugins: ['@trivago/prettier-plugin-sort-imports'],
   }
 ```
 

examples/.prettierrc

@@ -8,5 +8,9 @@
     "importOrder": ["^@server/(.*)$", "^@core/(.*)$", "^@ui/(.*)$", "^[./]"],
     "importOrderSeparation": true,
     "importOrderSortSpecifiers": true,
-    "plugins": ["../lib/src/index.js"]
+    "plugins": [
+        "prettier-plugin-ember-template-tag",
+        "prettier-plugin-svelte",
+        "../lib/src/index.js"
+    ]
 }

examples/example.gjs

@@ -0,0 +1,29 @@
+// I am top level comment in this file.
+import z from 'z';
+import threeLevelRelativePath from '../../../threeLevelRelativePath';
+import sameLevelRelativePath from './sameLevelRelativePath';
+import thirdParty from 'third-party';
+import oneLevelRelativePath from '../oneLevelRelativePath';
+import otherthing from '@core/otherthing';
+import abc from '@core/abc';
+import twoLevelRelativePath from '../../twoLevelRelativePath';
+import component from '@ui/hello';
+import fourLevelRelativePath from '../../../../fourLevelRelativePath';
+import * as a from 'a';
+import something from '@server/something';
+import xyz from '@ui/xyz';
+import Component from '@glimmer/component';
+import { action } from '@ember/object';
+
+const what = <template>Used as an expression</template>;
+
+export const who = <template>Used as an expression</template>;
+
+export default class Foo extends Component {
+  @action
+  myCoolFunction(){}
+
+  <template>
+    Top-level class template
+  </template>
+}

examples/example.gts

@@ -0,0 +1,41 @@
+// I am top level comment in this file.
+import z from 'z';
+import threeLevelRelativePath from '../../../threeLevelRelativePath';
+import sameLevelRelativePath from './sameLevelRelativePath';
+import thirdParty from 'third-party';
+import oneLevelRelativePath from '../oneLevelRelativePath';
+import otherthing from '@core/otherthing';
+import abc from '@core/abc';
+import twoLevelRelativePath from '../../twoLevelRelativePath';
+import component from '@ui/hello';
+import fourLevelRelativePath from '../../../../fourLevelRelativePath';
+import * as a from 'a';
+import type RouterService from '@ember/routing/router-service';
+import something from '@server/something';
+import xyz from '@ui/xyz';
+import Component from '@glimmer/component';
+import { action } from '@ember/object';
+import { getOwner } from '@ember/owner';
+import { setOwner } from '@ember/owner';
+import type Owner from '@ember/owner';
+import type DefaultOwner from '@ember/owner';
+import type * as AllOwner from '@ember/owner';
+
+interface FooSignature {
+  Args: {
+    bar: string
+  };
+}
+
+const what = <template>Used as an expression</template>;
+
+export const who = <template>Used as an expression</template>;
+
+export default class Foo extends Component<FooSignature> {
+  @action
+  myCoolFunction(){}
+
+  <template>
+    Top-level class template
+  </template>
+}

examples/example.ts

@@ -6,7 +6,7 @@ import React, {
     KeyboardEvent,
 } from 'react';
 import { logger } from '@core/logger';
-import { reduce, debounce } from 'lodash';
+import { reduce, debounce } from 'lodash-es';
 import { Message } from '../Message';
 import { createServer } from '@server/node';
 import { Alert } from '@ui/Alert';