sort-named-imports

type

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 the alphabet option.
• 'unsorted' — Do not sort items. grouping and newlines behavior are still enforced.

order

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: 'alphabetical' | 'natural' | 'line-length' | 'custom' | 'unsorted'
  order?: 'asc' | 'desc'
}

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

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

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

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

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

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

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

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

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

Specifies how to handle newlines between groups.

• 'ignore' — Do not report errors related to newlines.
• 0 — No newlines are allowed.
• Any other number — Enforce this number of newlines between each group, and forbid newlines inside groups.

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

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.

{
  newlinesBetween: 1,
  groups: [
    'a',
    { newlinesBetween: 0 }, // Overrides the global newlinesBetween option
    'b',
  ]
}

customGroups

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?: number
  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?: number
  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.