sort-modules

Enforce sorted module members.

Organizing module members in a consistent order improves both readability and maintainability.

This rule helps developers quickly locate module members and understand the overall structure of your file.

By sorting module members systematically, confusion is minimized, and the code becomes more intuitive to navigate. This practice not only aids in individual productivity but also enhances team collaboration by establishing clear and predictable coding standards.

Try it out

export interface FindUserInput {
  id: string
  cache: CacheType
}

enum CacheType {
  ALWAYS = 'ALWAYS',
  NEVER = 'NEVER',
}

export type FindUserOutput = {
  id: string
  name: string
  age: number
}

function assertInputIsCorrect(input: FindUserInput | FindAllUsersInput): void {
  // Some logic
}

export function findUser(input: FindUserInput): FindUserOutput {
  assertInputIsCorrect(input)
  return _findUserByIds([input.id])[0]
}

export type FindAllUsersInput = {
  ids: string[]
  cache: CacheType
}

export type FindAllUsersOutput = FindUserOutput[]

export function findAllUsers(input: FindAllUsersInput): FindAllUsersOutput {
  assertInputIsCorrect(input)
  return _findUserByIds(input.ids)
}

class Cache {
  // Some logic
}

What this rule sorts

This rule sorts the following module members:

enum
interface
type
class
function

The following elements are not sorted by this rule:

imports (see the sort-imports rule).
'from' exports (see the sort-exports rule).
Decorated then exported classes due to a known ESLint limitation. Place the export/export default keyword before the decorators in order to sort those classes.
Any other expression, in order to ensure compilation and runtime behavior.

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 the alphabet option.
'usage' — Enforces items referenced by other items within the same group to appear before the items that reference them.
'unsorted' — Do not sort items. grouping and newlines 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'
| 'usage'
| 'subgroup-order'
| 'unsorted'
order?: 'asc' | 'desc'
}}_{default: { type: 'unsorted' }}

Specifies fallback sort options for elements that are equal according to the primary sort type.

You can also sort by subgroup order (nested groups in the groups option) using subgroup-order.

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.

partitionByComment

_{default: false}

Enables the use of comments to separate the module members into logical groups. This can help in organizing and maintaining large modules 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 a class if there is an empty line between them. This helps maintain the defined order of logically separated groups of members.

// Group 1
interface BasicInformation {
  firstName: string;
  lastName: string;
 }

// Group 2
interface AgeInformation {
  age: number;
  birthDate: Date;
}

// Group 3
interface LocationInformation {
  street: string;
  city: string;
}

// Group 4
function updateAddress(address: string) {}
function updatePhone(phone?: string) {}

// Group 5
function editFirstName(firstName: string) {}
function editLastName(lastName: string) {}

newlinesBetween

_{type: number | 'ignore'}_{default: 'ignore'}

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.

You can also enforce the newline behavior between two specific groups through the groups option.

This option is only applicable when partitionByNewLine is false.

newlinesInside

_{type: number | 'ignore' | 'newlinesBetween'}_{default: 'newlinesBetween'}

Specifies how to handle newlines inside groups.

'ignore' — Do not report errors related to newlines.
'newlinesBetween' — [DEPRECATED] If newlinesBetween is 'ignore', then 'ignore', otherwise 0.
0 — No newlines are allowed.
Any other number — Enforce this number of newlines between each element of the same group.

You can also enforce the newline behavior inside a given group through the groups or customGroups options.

This option is only applicable when partitionByNewLine is false.

groups

_{type:
Array<
| string
| string[]
| { newlinesBetween: number | 'ignore' }
| {
group: string | string[];
type?: 'alphabetical' | 'natural' | 'line-length' | 'custom' | 'usage' | 'unsorted';
order?: 'asc' | 'desc';
fallbackSort?: { type: string; order?: 'asc' | 'desc' };
newlinesInside?: number | 'ignore';
}
>}_{default:
[
'declare-enum',
'export-enum',
'enum',
['declare-interface', 'declare-type'],
['export-interface', 'export-type'],
['interface', 'type'],
'declare-class',
'class',
'export-class',
'declare-function',
'export-function',
'function',
]}

Specifies a list of module member groups for sorting. Groups help organize module members into categories, prioritizing them during sorting.

Each module member 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.

Interfaces

Selector: interface.
Modifiers: declare, default, export.
Example: declare-interface, export-default-interface or interface.

Types

Selector: type.
Modifiers: declare, export.
Example: declare-type, declare-export-type or interface.

Classes

Selector: class.
Modifiers: declare, default, decorated, export.
Example: declare-class, export-default-decorated-class or class.

Functions

Selector: function.
Modifiers: declare, default, async, export.
Example: async-function, export-default-function or function.

Enums

Selectors: enum.
Modifiers: declare, export.
Example: export-declare-enum or enum.

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, the members will remain in their original order.

Behavior when multiple groups match an element

The lists of modifiers above are sorted by importance, from most to least important. In case of multiple groups matching an element, the following rules will be applied:

The group with the most modifiers matching will be selected.
If modifiers quantity is the same, order will be chosen based on modifier importance as listed above.

Example :

export default class {}

class can be matched by the following groups, from most to least important:

default-export-class or export-default-class.
default-class.
export-class.
class.
unknown.

customGroups

_{type: Array<CustomGroupDefinition | CustomGroupAnyOfDefinition>}_{default: []}

You can define your own groups and use regex for matching very specific module members.

A custom group definition may follow one of the two following interfaces:

interface CustomGroupDefinition {
  groupName: string
  type?: 'alphabetical' | 'natural' | 'line-length' | 'usage' | 'unsorted'
  order?: 'asc' | 'desc'
  fallbackSort?: { type: string; order?: 'asc' | 'desc' }
  newlinesInside?: number | 'ignore'
  selector?: string
  modifiers?: string[]
  elementNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
  decoratorNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
}

A module member 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' | 'usage' | 'unsorted'
  order?: 'asc' | 'desc'
  fallbackSort?: { type: string; order?: 'asc' | 'desc' }
  newlinesInside?: number | 'ignore'
  anyOf: Array<{
      selector?: string
      modifiers?: string[]
      elementNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
      decoratorNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
  }>
}

A module member 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 the groups option.
selector — Filter on the selector of the element.
modifiers — Filter on the modifiers of the element. (All the modifiers of the element must be present in that list)
elementNamePattern — If entered, will check that the name of the element matches the pattern entered.
decoratorNamePattern — If entered, will check that at least one decorator matches the pattern entered.
type — Overrides the type option for that custom group.
order — Overrides the order option for that custom group.
fallbackSort — Overrides the fallbackSort option for that custom group.
newlinesInside — Overrides the newlinesInside option for that custom 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.

Example:

 {
   groups: [
    ['export-interface', 'export-type'],
    'enum',
    'class',
+   'input-types-and-interfaces',
+   'output-types-and-interfaces',
+   'unsorted-functions',
    'unknown',
   ],
+  customGroups: [                                
+    {                                            
+       groupName: 'input-types-and-interfaces',
+       anyOf: [                                  
+         {                                       
+            selector: 'type',
+            elementNamePattern: 'Input',
+         },
+         {                                       
+            selector: 'interface',
+            elementNamePattern: 'Input',
+         },
+       ]                                         
+    },
+    {                                            
+       groupName: 'output-types-and-interfaces',
+       anyOf: [                                  
+         {                                       
+            selector: 'type',
+            elementNamePattern: 'Output',
+         },
+         {                                       
+            selector: 'interface',
+            elementNamePattern: 'Output',
+         },
+       ]                                         
+    },
+    {                                            
+       groupName: 'unsorted-functions',
+       type: 'unsorted',
+       selector: 'function',
+    },
+  ]                                              
 }

Group with overridden settings

You may directly override options for a specific group by using an object with the group property and other option overrides.

type — Overrides the type option for that group.
order — Overrides the order option for that group.
fallbackSort — Overrides the fallbackSort option for that group.
newlinesInside — Overrides the newlinesInside option for that group.

{
  groups: [
    'class',
    { group: 'enum', type: 'unsorted' }, // Elements from this group will not be sorted
  ]
}

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: 1,
  groups: [
    'a',
    { newlinesBetween: 0 }, // Overrides the global newlinesBetween option
    'b',
  ]
}

useExperimentalDependencyDetection

_{default: true}

Specifies whether to use a new experimental dependency detection logic, with reduced false positives.

true — Use the new experimental dependency detection logic.
false — Use the legacy dependency detection logic.

Usage

// .eslintrc.js
module.exports = {
  plugins: [
    'perfectionist',
  ],
  rules: {
    'perfectionist/sort-modules': [
      'error',
      {
        type: 'alphabetical',
        order: 'asc',
        fallbackSort: { type: 'unsorted' },
        ignoreCase: true,
        specialCharacters: 'keep',
        partitionByComment: false,
        partitionByNewLine: false,
        newlinesBetween: 'ignore',
        newlinesInside: 'ignore',
        groups: [
          'declare-enum',
          'export-enum',
          'enum',
          ['declare-interface', 'declare-type'],
          ['export-interface', 'export-type'],
          ['interface', 'type'],
          'declare-class',
          'class',
          'export-class',
          'declare-function',
          'export-function',
          'function'
        ],
        customGroups: [],
        useExperimentalDependencyDetection: true,
      },
    ],
  },
}

Version

This rule was introduced in v4.0.0.

sort-modules

Try it out

What this rule sorts

Options

type

order

fallbackSort

alphabet

ignoreCase

specialCharacters

locales

partitionByComment

partitionByNewLine

newlinesBetween

newlinesInside

groups

Interfaces

Types

Classes

Functions

Enums

Important notes

The `unknown` group

Behavior when multiple groups match an element

customGroups

Attributes

Match importance

Group with overridden settings

Newlines between groups

useExperimentalDependencyDetection

Usage

Version

Resources

Table of Contents

sort-modules

Try it out

What this rule sorts

Options

type

order

fallbackSort

alphabet

ignoreCase

specialCharacters

locales

partitionByComment

partitionByNewLine

newlinesBetween

newlinesInside

groups

Interfaces

Types

Classes

Functions

Enums

Important notes

The unknown group

Behavior when multiple groups match an element

customGroups

Attributes

Match importance

Group with overridden settings

Newlines between groups

useExperimentalDependencyDetection

Usage

Version

Resources

Table of Contents

The `unknown` group