sort-classes

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

order

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

alphabet

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

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

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

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.

partitionByComment

Allows you to use comments to separate the class members into logical groups. This can help in organizing and maintaining large classes by creating partitions within the class based on comments.

• true — All comments will be treated as delimiters, creating partitions.
• false — Comments will not be used as delimiters.
• string — A regexp pattern to specify which comments should act as delimiters.
• { block: boolean | string | string[]; line: boolean | string | string[] } — Specify which block and line comments should act as delimiters.

partitionByNewLine

When true, the rule will not sort the members of a class if there is an empty line between them. This can be useful for keeping logically separated groups of members in their defined order.

class User {
  // Group 1
  firstName: string;
  lastName: string;

  // Group 2
  age: number;
  birthDate: Date;

  // Group 3
  address: {
    street: string;
    city: string;
  };
  phone?: string;

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

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

newlinesBetween

Specifies how new lines should be handled between class member groups.

• ignore — Do not report errors related to new lines between object type groups.
• always — Enforce one new line between each group, and forbid new lines inside a group.
• never — No new lines are allowed in object types.

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.

ignoreCallbackDependenciesPatterns

Allows you to specify regexp patterns of function names that should ignore dependency sorting in their callback functions.

Example with ignoreCallbackDependenciesPatterns: ['^computed$']:

class User {
  fullName = computed(() => this.role + ' - ' + this.username);
  role = signal('admin');
  username = signal('John');
};

Without ignoreCallbackDependenciesPatterns: ['^computed$'], role and username would be sorted before fullName as it depends on them.

groups

[
  'index-signature',
  'static-property',
  'static-block',
  ['protected-property', 'protected-accessor-property'],
  ['private-property', 'private-accessor-property'],
  ['property', 'accessor-property'],
  'constructor',
  'static-method',
  'protected-method',
  'private-method',
  'method',
  ['get-method', 'set-method'],
  'unknown',
]

Allows you to specify a list of class member groups for sorting. Groups help organize class members into categories, prioritizing them during sorting.

Each class 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.

abstract class Class {

    protected abstract get field();

}

abstract class Example extends BaseExample {

  // 'index-signature'
  [key: string]: any;

  // 'public-static-property'
  static instance: Example;

  // 'declare-protected-static-readonly-property'
  declare protected static readonly value: string;

  // 'static-block'
  static {
    console.log("I am a static block");
  }

  // 'public-property'
  public description: string;

  // 'public-decorated-property'
  @SomeDecorator
  public value: number;

  // 'public-decorated-accessor-property'
  @SomeDecorator
  public accessor value: number;

  // 'public-decorated-get-method'
  @SomeDecorator
  get decoratedValue() {
    return this._value;
  }

  // 'public-decorated-set-method'
  @SomeDecorator
  set decoratedValue(value: number) {
    this._value = value;
  }

  // 'public-decorated-get-method'
  @SomeDecorator
  get value() {
    return this._value;
  }

  // 'public-get-method'
  get value() {
    return this._value;
  }

  // 'public-set-method'
  set value(value: number) {
    this._value = value;
  }

  // 'protected-abstract-override-readonly-decorated-property'
  @SomeDecorator
  protected abstract override readonly _value: number;

  // 'protected-decorated-accessor-property'
  @SomeDecorator
  protected accessor _value: number;

  // 'protected-property'
  protected name: string;

  // 'protected-decorated-get-method'
  @SomeDecorator
  protected get value() {
    return this._value;
  }

  // 'private-decorated-property'
  @SomeDecorator
  private _value: number;

  // 'private-decorated-accessor-property'
  @SomeDecorator
  private accessor _value: number;

  // 'private-property'
  private name: string;

  // 'private-decorated-get-method'
  @SomeDecorator
  private get value() {
    return this._value;
  }

  // 'public-constructor'
  constructor(value: number) {
    this._value = value;
  }

  // 'public-static-method'
  static getInstance() {
    return this.instance;
  }

  // 'protected-static-method'
  protected static initialize() {
    this.instance = new Example(0);
  }

  // 'private-static-method'
  private static initialize() {
    this.instance = new Example(0);
  }

  // 'public-decorated-method'
  @SomeDecorator
  public decoratedMethod() {
    return this._value;
  }

  // 'public-method'
  public display() {
    console.log(this._value);
  }

  // 'protected-method'
  protected calculate() {
    return this._value * 2;
  }

  // private-function-property
  private arrowProperty = () => {};

  // 'private-method'
  private calculate() {
    return this._value * 2;
  }

  // private-function-property
  private functionProperty = function() {};
}

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

customGroups

{
  "key1": "value1",
  "key2": "value2"
}

[
  {
    "groupName": "key1",
    "elementNamePattern": "value1"
  },
  {
    "groupName": "key2",
    "elementNamePattern": "value2"
  }
]

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

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'
  newlinesInside?: 'always' | 'never'
  selector?: string
  modifiers?: string[]
  elementNamePattern?: string
  elementValuePattern?: string
  decoratorNamePattern?: string
}

A class 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' | 'unsorted'
  order?: 'asc' | 'desc'
  newlinesInside?: 'always' | 'never'
  anyOf: Array<{
      selector?: string
      modifiers?: string[]
      elementNamePattern?: string
      elementValuePattern?: string
      decoratorNamePattern?: string
  }>
}

A class member will match a CustomGroupAnyOfDefinition group if it matches all the filters of at least one of the anyOf items.

 {
   groups: [
    'static-block',
    'index-signature',
+   'input-properties',
+   'output-properties',
    'constructor',
+   'unsorted-methods-and-other-properties',
    ['get-method', 'set-method'],
    'unknown',
   ],
+  customGroups: [                                          
+    {                                                      
+      // `constructor()` members must not match
+      // `unsorted-methods-and-other-properties`
+      // so make them match this first
+       groupName: 'constructor',
+       selector: 'constructor',
+    },
+    {                                                      
+       groupName: 'input-properties',
+       selector: 'property',
+       modifiers: ['decorated'],
+       decoratorNamePattern: 'Input',
+    },
+    {                                                      
+       groupName: 'output-properties',
+       selector: 'property',
+       modifiers: ['decorated'],
+       decoratorNamePattern: 'Output',
+    },
+    {                                                      
+       groupName: 'unsorted-methods-and-other-properties',
+       type: 'unsorted',
+       anyOf: [                                            
+         {                                                 
+            selector: 'method',
+         },
+         {                                                 
+            selector: 'property',
+         },
+       ]                                                   
+    },
+  ]                                                        
 }