Perfectionist
Rulessort-named-imports

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 the length of the code line (shorter lines first).
  • 'custom' — Sort items using the alphabet entered in the alphabet option.
  • 'unsorted' — Do not sort items.

order

default: 'asc'

Determines whether the sorted items should be 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' }

Defines a list of fallback sort options to use when comparing two 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: ''

Only used when the type option is set to 'custom'. Specifies the custom alphabet to use when sorting.

Use the Alphabet utility class from eslint-plugin-perfectionist/alphabet to quickly generate a custom alphabet.

Example: 0123456789abcdef...

ignoreCase

default: true

Controls whether sorting should be case-sensitive or not.

  • 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

Controls whether special characters should be trimmed, removed or kept 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. See 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

Determines 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.

groupKind

default: 'mixed'

Allows you to group 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; export 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

Allows you to use 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 can be useful for keeping logically separated groups of members in their defined order.

import {
     // Group 1
    Drone,
    Keyboard,
    Mouse,
    Smartphone,

    // Group 2
    Laptop,
    Monitor,
    Smartwatch,
    Tablet,

    // Group 3
    Headphones,
    Router,
} from './devices'

Usage

Version

This rule was introduced in v0.2.0.

Resources

Table of Contents