sort-named-imports
Enforce sorted named imports.
Sorting named imports promotes a standardized ordering, making it easier for developers to navigate and understand import statements.
This rule ensures that named imports are consistently organized, enhancing the readability and maintainability of the code. By keeping imports sorted, developers can quickly locate necessary modules and maintain a clean code structure.
Important
If you use the sort-imports
rule, it is highly recommended to disable it to avoid conflicts.
Try it out
Options
This rule accepts an options object with the following properties:
type
default:'alphabetical'
Specifies the sorting method.
'alphabetical'
— Sort items alphabetically (e.g., “a” < “b” < “c”) using localeCompare.'natural'
— Sort items in a natural order (e.g., “item2” < “item10”).'line-length'
— Sort items by code line length (shorter lines first).'custom'
— Sort items using the alphabet specified in thealphabet
option.'unsorted'
— Do not sort items.grouping
andnewlines behavior
are still enforced.
order
default:'asc'
Specifies whether to sort items in ascending or descending order.
'asc'
— Sort items in ascending order (A to Z, 1 to 9).'desc'
— Sort items in descending order (Z to A, 9 to 1).
fallbackSort
type:
{
type: 'alphabetical' | 'natural' | 'line-length' | 'custom' | 'unsorted'
order?: 'asc' | 'desc'
}
default: { type: 'unsorted' }
Specifies fallback sort options for elements that are equal according to the primary sort
type
.
Example: enforce alphabetical sort between two elements with the same length.
{
type: 'line-length',
order: 'desc',
fallbackSort: { type: 'alphabetical', order: 'asc' }
}
alphabet
default:''
Used only when the type
option is set to 'custom'
. Specifies the custom alphabet for sorting.
Use the Alphabet
utility class from eslint-plugin-perfectionist/alphabet
to quickly generate a custom alphabet.
Example: 0123456789abcdef...
ignoreCase
default:true
Specifies whether sorting should be case-sensitive.
true
— Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).false
— Consider case when sorting (e.g., “a” comes before “A”).
specialCharacters
default:keep
Specifies whether to trim, remove, or keep special characters before sorting.
'keep'
— Keep special characters when sorting (e.g., “_a” comes before “a”).'trim'
— Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).'remove'
— Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).
locales
default:'en-US'
Specifies the sorting locales. Refer To String.prototype.localeCompare() - locales.
string
— A BCP 47 language tag (e.g.'en'
,'en-US'
,'zh-CN'
).string[]
— An array of BCP 47 language tags.
ignoreAlias
default:false
Specifies whether to use the import alias as the name for sorting instead of the exported name.
true
— Use the import alias for sorting.false
— Use the exported name for sorting.
[DEPRECATED] groupKind
default:'mixed'
Use the groups option with the value
and type
modifiers instead.
Groups named imports by their kind, determining whether value imports should come before or after type imports.
mixed
— Do not group named imports by their kind; named imports statements are sorted together regardless of their type.values-first
— Group all value imports before type imports.types-first
— Group all type imports before value imports.
partitionByComment
default:false
Enables the use of comments to separate the members of named imports into logical groups. This can help in organizing and maintaining large named imports by creating partitions based on comments.
true
— All comments will be treated as delimiters, creating partitions.false
— Comments will not be used as delimiters.RegExpPattern = string | { pattern: string; flags: string}
— A regexp pattern to specify which comments should act as delimiters.RegExpPattern[]
— A list of regexp patterns to specify which comments should act as delimiters.{ block: boolean | RegExpPattern | RegExpPattern[]; line: boolean | RegExpPattern | RegExpPattern[] }
— Specify which block and line comments should act as delimiters.
partitionByNewLine
default:false
When true
, the rule will not sort the members of named imports if there is an empty line between them. This helps maintain the defined order of logically separated groups of members.
import {
// Group 1
Drone,
Keyboard,
Mouse,
Smartphone,
// Group 2
Laptop,
Monitor,
Smartwatch,
Tablet,
// Group 3
Headphones,
Router,
} from './devices'
newlinesBetween
default:'ignore'
Specifies how to handle new lines between groups.
ignore
— Do not report errors related to new lines.always
— Enforce one new line between each group, and forbid new lines inside a group.never
— No new lines are allowed.
You can also enforce the newline behavior between two specific groups through the groups
options.
See the groups
option.
This option is only applicable when partitionByNewLine
is false
.
groups
type: Array<string | string[]>
[]
Specifies a list of named imports groups for sorting. Groups help organize named imports into categories, making them more readable and maintainable.
Each named import will be assigned a single group specified in the groups
option (or the unknown
group if no match is found).
The order of items in the groups
option determines how groups are ordered.
Within a given group, members will be sorted according to the type
, order
, ignoreCase
, etc. options.
Individual groups can be combined together by placing them in an array. The order of groups in that array does not matter. All members of the groups in the array will be sorted together as if they were part of a single group.
Predefined groups are characterized by a single selector and potentially multiple modifiers. You may enter modifiers in any order, but the selector must always come at the end.
Selectors
The only selector possible for this rule is import
.
Modifiers
value
— Matches value imports.type
— Matches type imports.
Example: type-import
.
Important notes
The unknown
group
Members that don’t fit into any group specified in the groups
option will be placed in the unknown
group. If the unknown
group is not specified in the groups
option,
it will automatically be added to the end of the list.
Newlines between groups
You may place newlinesBetween
objects between your groups to enforce the newline behavior between two specific groups.
See the newlinesBetween
option.
This feature is only applicable when partitionByNewLine
is false
.
{
newlinesBetween: 'always',
groups: [
'a',
{ newlinesBetween: 'never' }, // Overrides the global newlinesBetween option
'b',
]
}
customGroups
type: Array<CustomGroupDefinition | CustomGroupAnyOfDefinition>
[]
Defines custom groups to match specific named imports.
A custom group definition may follow one of the two following interfaces:
interface CustomGroupDefinition {
groupName: string
type?: 'alphabetical' | 'natural' | 'line-length' | 'unsorted'
order?: 'asc' | 'desc'
fallbackSort?: { type: string; order?: 'asc' | 'desc' }
newlinesInside?: 'always' | 'never'
selector?: string
elementNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
}
A named import will match a CustomGroupDefinition
group if it matches all the filters of the custom group’s definition.
or:
interface CustomGroupAnyOfDefinition {
groupName: string
type?: 'alphabetical' | 'natural' | 'line-length' | 'unsorted'
order?: 'asc' | 'desc'
fallbackSort?: { type: string; order?: 'asc' | 'desc' }
newlinesInside?: 'always' | 'never'
anyOf: Array<{
selector?: string
elementNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
}>
}
A named import will match a CustomGroupAnyOfDefinition
group if it matches all the filters of at least one of the anyOf
items.
Attributes
groupName
— The group’s name, which needs to be put in thegroups
option.selector
— Filter on theselector
of the element.elementNamePattern
— If entered, will check that the name of the element matches the pattern entered.type
— Overrides thetype
option for that custom group.unsorted
will not sort the group.order
— Overrides theorder
option for that custom group.fallbackSort
— Overrides thefallbackSort
option for that custom group.newlinesInside
— Enforces a specific newline behavior between elements of the group.
Match importance
The customGroups
list is ordered:
The first custom group definition that matches an element will be used.
Custom groups have a higher priority than any predefined group.
Usage
Version
This rule was introduced in v0.2.0.