A prettier plugin to sort import declarations by provided Regular Expression order.
This was forked from @trivago/prettier-plugin-sort-imports.
The first change was preserving the order of side-effect imports to avoid breaking situations where import-order has correctness implications (such as styles).
Since then more critical features & fixes have been added. As a result, this repo intends to stay compatible with the upstream, but may continue to gain features not present in the original version of the plugin.
Table of Contents
- Sample
- Install
- Usage
- FAQ / Troubleshooting
- Compatibility
- Contribution
- Disclaimer
// prettier-ignore
import { environment } from "./misguided-module-with-side-effects.js";
import "core-js/stable";
import "regenerator-runtime/runtime";
import React, {
FC,
useEffect,
useRef,
ChangeEvent,
KeyboardEvent,
} from 'react';
import { logger } from '@core/logger';
import { reduce, debounce } from 'lodash';
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';// prettier-ignore
import { environment } from "./misguided-module-with-side-effects.js";
import "core-js/stable";
import "regenerator-runtime/runtime";
import { debounce, reduce } from 'lodash';
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';npm
npm install --save-dev @ianvs/prettier-plugin-sort-importsor, using yarn
yarn add --dev @ianvs/prettier-plugin-sort-importsNote: If you are migrating from v2.x.x to v3.x.x, Please Read Migration Guidelines
Add your preferred settings in your prettier config file.
module.exports = {
"printWidth": 80,
"tabWidth": 4,
"trailingComma": "all",
"singleQuote": true,
"semi": true,
"importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
"importOrderBuiltinModulesToTop": true,
"importOrderCaseInsensitive": true,
"importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
"importOrderMergeDuplicateImports": true,
"importOrderCombineTypeAndValueImports": true,
"importOrderSeparation": true,
"importOrderSortSpecifiers": true,
}Note: all flags are off by default, so explore your options below
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.
First, the plugin checks for
side effect imports,
such as import 'mock-fs'. These imports often modify the global scope or apply some patches to the current
environment, which may affect other imports. To preserve potential side effects, these kind of side effect imports are
classified as unsortable. They also behave as a barrier that other imports may not cross during the sort. So for
example, let's say you've got these imports:
import E from 'e';
import F from 'f';
import D from 'd';
import 'c';
import B from 'b';
import A from 'a';Then the first three imports are sorted and the last two imports are sorted, but all imports above c stay above c
and all imports below c stay below c, resulting in:
import D from 'd';
import E from 'e';
import F from 'f';
import 'c';
import A from 'a';
import B from 'b';Additionally, any import statements lines that are preceded by a // prettier-ignore comment are also classified as
unsortable. This can be used for edge-cases, such as when you have a named import with side-effects.
Next, 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 <THIRD_PARTY_MODULES> special word in the importOrder.
type: Array<string>
A collection of Regular expressions in string format.
"importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],Default: []
By default, this plugin will not move any imports. To separate third party from relative imports, use ["^[./]"]. This will become the default in the next major version.
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 <THIRD_PARTY_MODULES> to assign third party imports to the appropriate position:
"importOrder": ["^@core/(.*)$", "<THIRD_PARTY_MODULES>", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],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,Note: If you want greater control over which groups are separated from others, you can add an empty string to your importOrder array to signify newlines. For example:
"importOrderSeparation": false,
"importOrder": [
"^react", // React will be placed at the top of third-party modules
"<THIRD_PARTY_MODULES>",
"", // use empty strings to separate groups with empty lines
"^[./]"
],type: boolean
default value: false
A boolean value to enable or disable sorting of the specifiers in an import declarations. If enabled, type imports will be sorted after value imports.
Before:
import Default, {type Bravo, delta as echo, charlie, type Alpha} from 'source';After:
import Default, {charlie, delta as echo, type Alpha, type Bravo} from 'source';type: boolean
default value: false
A boolean value to enable or disable sorting the namespace specifiers to the top of the import group.
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):
import ExampleView from './ExampleView';
import ExamplesList from './ExamplesList';compared with "importOrderCaseInsensitive": true:
import ExamplesList from './ExamplesList';
import ExampleView from './ExampleView';type: boolean
default value: false
When true, multiple import statements from the same module will be combined into a single import.
type: boolean
default value: false
A boolean value to control merging import type expressions into import {…}.
- import type { C1 } from 'c';
- import { C2 } from 'c';
+ import { type C1, C2 } from "c";
- import { D1 } from 'd';
- import type { D2 } from 'd';
+ import { D1, type D2 } from "d";
- import type { A1 } from 'a';
- import type { A2 } from 'a';
+ import type { A1, A2 } from "a";type: Array<string>
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": []type: boolean
default value: false
A boolean value to enable sorting of node builtins to the top of all import groups.
This plugin supports standard prettier ignore comments. By default, side-effect imports (like
import "core-js/stable";) are not sorted, so in most cases things should just work. But if you ever need to, you can
prevent an import from getting sorted like this:
// prettier-ignore
import { goods } from "zealand";
import { cars } from "austria";This will keep the zealand import at the top instead of moving it below the austria import. Note that since only
entire import statements can be ignored, line comments (// prettier-ignore) are recommended over inline comments
(/* prettier-ignore */).
Having some trouble or an issue? You can check FAQ / Troubleshooting section.
| Framework | Supported | Note |
|---|---|---|
| JS with ES Modules | ✅ Everything | - |
| NodeJS with ES Modules | ✅ Everything | - |
| React | ✅ Everything | - |
| Angular | ✅ Everything | Supported through importOrderParserPlugins API |
| Vue | Any contribution is welcome. | |
| Svelte | Any contribution is welcome. |
For more information regarding contribution, please check the Contributing Guidelines. If you are trying to debug some code in the plugin, check Debugging Guidelines
This plugin modifies the AST which is against the rules of prettier.