Prettier plugin sort imports

A prettier plugin to sort import declarations by provided Regular Expression order.

Note: If you are migrating from v2.x.x to v3.x.x, Please Read Migration Guidelines

$3

``javascript
import React, {
FC,
useEffect,
useRef,
ChangeEvent,
KeyboardEvent,
} from 'react';
import { logger } from '@core/logger';
import { reduce, debounce } from 'lodash-es';
import { Message } from '../Message';
import { createServer } from '@server/node';
import { Alert } from '@ui/Alert';
import { repeat, filter, add } from '../utils';
import { initializeApp } from '@core/app';
import { Popup } from '@ui/Popup';
import { createConnection } from '@server/database';
`




$3

`javascript
import { debounce, reduce } from 'lodash-es';
import React, {
ChangeEvent,
FC,
KeyboardEvent,
useEffect,
useRef,
} from 'react';

import { createConnection } from '@server/database';
import { createServer } from '@server/node';

import { initializeApp } from '@core/app';
import { logger } from '@core/logger';

import { Alert } from '@ui/Alert';
import { Popup } from '@ui/Popup';

import { Message } from '../Message';
import { add, filter, repeat } from '../utils';
`

$3

using npm

`shell script
npm install --save-dev @trivago/prettier-plugin-sort-imports
`

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

Note: If formatting .vue sfc files please install @vue/compiler-sfc if not in your dependency tree - this normally is within Vue projects.

$3

Add an order in prettier config file.

`ecmascript 6
module.exports = {
"printWidth": 80,
"tabWidth": 4,
"trailingComma": "all",
"singleQuote": true,
"semi": true,
"importOrder": ["^@core/(.)$", "^@server/(.)$", "^@ui/(.*)$", "^[./]"],
"importOrderSeparation": true,
"importOrderSortSpecifiers": true
}
`

**Note: There may be an issue with some package managers, such as pnpm or when using prettier v3.x. You can solve it by providing additional configuration option in prettier config file.

`js
module.exports = {
...
"plugins": ["@trivago/prettier-plugin-sort-imports"]
}
`

$3

#### importOrder

type: Array

A collection of Regular expressions in string format.

`
"importOrder": ["^@core/(.)$", "^@server/(.)$", "^@ui/(.*)$", "^[./]"],
`

_Default behavior:_ The plugin moves the third party imports to the top which are not part of the importOrder list.
To move the third party imports at desired place, you can use to assign third party imports to the appropriate position:

`
"importOrder": ["^@core/(.)$", "", "^@server/(.)$", "^@ui/(.*)$", "^[./]"],
`

You can also use to control the position of Node.js builtin modules (like fs, path, http, and their node: prefixed variants):

`
"importOrder": ["", "", "^@core/(.)$", "^@server/(.)$", "^@ui/(.*)$", "^[./]"],
`

When 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

default value: false

A boolean value to enable or disable the new line separation
between sorted import declarations group. The separation takes place according to the importOrder.

`
"importOrderSeparation": true,
`

If this option is enabled and 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

default value: false

A boolean value to enable or disable sorting of the specifiers in an import declarations.

#### importOrderGroupNamespaceSpecifiers

type: boolean

default value: false

A boolean value to enable or disable sorting the namespace specifiers to the top of the import group.

#### importOrderCaseInsensitive

type: boolean

default value: false

A boolean value to enable case-insensitivity in the sorting algorithm
used to order imports within each match group.

For example, when false (or not specified):

`ecmascript 6
import ExampleView from './ExampleView';
import ExamplesList from './ExamplesList';
`

compared with "importOrderCaseInsensitive": true:

`ecmascript 6
import ExamplesList from './ExamplesList';
import ExampleView from './ExampleView';
`

#### importOrderParserPlugins

type: Array

default value: ["typescript", "jsx"]

Previously known as experimentalBabelParserPluginsList.

A collection of plugins for babel parser. The plugin passes this list to babel parser, so it can understand the syntaxes
used in the file being formatted. The plugin uses prettier itself to figure out the parser it needs to use but if that fails,
you can use this field to enforce the usage of the plugins' babel parser needs.

To pass the plugins to babel parser:

`
"importOrderParserPlugins" : ["classProperties", "decorators-legacy"]
`

To pass the options to the babel parser plugins: Since prettier options are limited to string, you can pass plugins
with options as a JSON string of the plugin array:
"[\"plugin-name\", { \"pluginOption\": true }]".

`
"importOrderParserPlugins" : ["classProperties", "[\"decorators\", { \"decoratorsBeforeExport\": true }]"]
`

To disable default plugins for babel parser, pass an empty array:

`
importOrderParserPlugins: []
`

$3


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

$3

type: boolean
default value: true

By default, the plugin sorts side effect imports like any other imports in the file. If you need to keep side effect imports in the same place but sort all other imports around them, set this option to false.

Example:

Initial file:

`js
import z from 'z'
import a from 'a'

import 'side-effect-lib'

import c from 'c'
import b from 'b'
`
When sorted:

`js
import a from 'a'
import z from 'z'

import 'side-effect-lib'

import b from 'b'
import c from 'c'
`




$3

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.

`javascript
// sort-imports-ignore
import './polyfills';

import foo from 'foo'
`

#### importOrderImportAttributesKeyword

type: 'assert' | 'with' | 'with-legacy'

The import attributes/assertions syntax:
- with: import "..." with { type: "json" }
- assert: import "..." assert { type: "json" }
- with-legacy: import "..." with type: "json".

`json
"importOrderImportAttributesKeyword": 'with'
`

_Default behavior:_ When not specified, @babel/generator will try to match the style in the input code based on the AST shape.




$3

The plugin extracts the imports which are defined in importOrder. These imports are considered as _local imports_.
The imports which are not part of the importOrder is considered as _third party imports_.

After, the plugin sorts the _local imports_ and _third party imports_ using natural sort algorithm.

In the end, the plugin returns final imports with _third party imports_ on top and _local imports_ at the end.

The _third party imports_ position (it's top by default) can be overridden using the special word in the importOrder.

$3

This plugin uses 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.

$3

Having some trouble or an issue ? You can check FAQ / Troubleshooting section.

$3

| Framework | Supported | Note |
| ---------------------- | ------------------------ | ------------------------------------------------ |
| 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 | - |
| Svelte | ✅ Everything | prettier-plugin-svelte is required |
| Vue | ✅ Everything | @vue/compiler-sfc` is required |

$3

Want to highlight your project or company ? Adding your project / company name will help plugin to gain attraction and contribution.
Feel free to make a Pull Request to add your project / company name.

- trivago
- AuresKonnect
- FactorialHR

$3

For more information regarding contribution, please check the Contributing Guidelines. If you are trying to
debug some code in the plugin, check Debugging Guidelines

$3

| Ayush Sharma | Behrang Yarahmadi |
| ------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| !ayusharma | !@byara |
| @ayusharma\_ | @behrang_y |

$3

This plugin modifies the AST which is against the rules of prettier.