| title | sort-classes | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| description | Maintain a consistent order of class members with this ESLint rule. Improve readability and make it easier to navigate through your class structures | ||||||||
| shortDescription | Enforce sorted classes | ||||||||
| keywords |
|
import CodeExample from '../../components/CodeExample.svelte' import Important from '../../components/Important.astro' import CodeTabs from '../../components/CodeTabs.svelte' import dedent from 'dedent'
Enforce sorted class members.
Organizing class members in a consistent order improves both readability and maintainability.
This rule helps developers quickly locate class members and understand the overall structure of the class.
By sorting class 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.
<CodeExample alphabetical={dedent` class User { constructor(username: string, email: string, isActive: boolean) { this.username = username this.email = email this.isActive = isActive this.roles = [] }
activate() {
this.isActive = true
}
addRole(role: string) {
this.roles.push(role)
}
deactivate() {
this.isActive = false
}
getProfile() {
return {
username: this.username,
email: this.email,
isActive: this.isActive,
roles: this.roles,
}
}
removeRole(role: string) {
this.roles = this.roles.filter(r => r !== role)
}
setEmail(newEmail: string) {
this.email = newEmail
}
}
} lineLength={dedent
class User {
constructor(username: string, email: string, isActive: boolean) {
this.username = username
this.email = email
this.isActive = isActive
this.roles = []
}
getProfile() {
return {
username: this.username,
email: this.email,
isActive: this.isActive,
roles: this.roles,
}
}
removeRole(role: string) {
this.roles = this.roles.filter(r => r !== role)
}
setEmail(newEmail: string) {
this.email = newEmail
}
addRole(role: string) {
this.roles.push(role)
}
deactivate() {
this.isActive = false
}
activate() {
this.isActive = true
}
}
} initial={dedent
class User {
constructor(username: string, email: string, isActive: boolean) {
this.username = username
this.email = email
this.isActive = isActive
this.roles = []
}
addRole(role: string) {
this.roles.push(role)
}
deactivate() {
this.isActive = false
}
setEmail(newEmail: string) {
this.email = newEmail
}
activate() {
this.isActive = true
}
removeRole(role: string) {
this.roles = this.roles.filter(r => r !== role)
}
getProfile() {
return {
username: this.username,
email: this.email,
isActive: this.isActive,
roles: this.roles,
}
}
}
`} client:load lang="tsx" />
This rule accepts an options object with the following properties:
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 thealphabetoption.'unsorted'— Do not sort items.groupingandnewlines behaviorare still enforced.
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).
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' }
}You can also sort by subgroup order (nested groups in the groups option) using subgroup-order.
Example: enforce subgroup ordering for getters and setters.
{
groups: [['get-method', 'set-method']],
type: 'alphabetical',
order: 'desc',
fallbackSort: { type: 'subgroup-order', order: 'asc' }
}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...
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”).
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).
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.
default: false
Enables the use of 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.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.
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.
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) {}
};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.
Specifies how to handle newlines inside groups.
'ignore'— Do not report errors related to newlines.'newlinesBetween'— [DEPRECATED] IfnewlinesBetweenis'ignore', then'ignore', otherwise0.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.
Specifies 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.
Specifies filters to match a particular options configuration for a given class.
The first matching options configuration will be used. If no configuration matches, the default options configuration will be used.
allNamesMatchPattern— A regexp pattern that all class keys must match (index signatures and static blocks are ignored).
Example configuration:
{
'perfectionist/sort-classes': [
'error',
{
groups: ['r', 'g', 'b'], // Sort colors by RGB
customGroups: [
{
groupName: 'r',
elementNamePattern: '^r$',
},
{
groupName: 'g',
elementNamePattern: '^g$',
},
{
groupName: 'b',
elementNamePattern: '^b$',
},
],
useConfigurationIf: {
allNamesMatchPattern: '^[rgb]$',
},
},
{
type: 'alphabetical' // Fallback configuration
}
],
}matchesAstSelector— An AST selector matching aClassBodynode. To avoid unexpected behavior, do not use:exitor:enterpseudo-selectors.
Example configuration: don't sort classes that are exported.
{
'perfectionist/sort-classes': [
'error',
{
useConfigurationIf: {
matchesAstSelector: 'ExportNamedDeclaration ClassBody',
},
type: 'unsorted'
},
{
type: 'alphabetical' // Fallback configuration
}
],
}Specifies 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.
- Selector:
constructor. - Modifiers:
protected,private,public. - Example:
protected-constructor,private-constructor,public-constructororconstructor.
- Selectors:
get-method,set-method,method. - Modifiers:
static,abstract,decorated,override,protected,private,public,optional,async. - Example:
private-static-accessor-property,protected-abstract-override-methodorstatic-get-method.
The optional modifier is incompatible with the get-method and set-method selectors.
The abstract modifier is incompatible with the static, private and decorated modifiers.
constructor, get-method and set-method elements will also be matched as method.
- Selector:
accessor-property. - Modifiers:
static,abstract,decorated,override,protected,private,public. - Example:
private-static-accessor-property,protected-abstract-override-methodorstatic-get-method.
The abstract modifier is incompatible with the static, private and decorated modifiers.
- Selectors:
function-property,property. - Modifiers:
static,declare,abstract,decorated,override,readonly,protected,private,public,optional,async. - Example:
readonly-decorated-property.
The abstract modifier is incompatible with the static, private and decorated modifiers.
The declare modifier is incompatible with the override and decorated modifiers.
The function-property selector will match properties whose values are defined functions or arrow-functions.
As such, the declare and abstract modifiers are incompatible with this selector.
The async modifier is reserved for the function-property selector.
- Selector:
index-signature. - Modifiers:
static,readonly. - Example:
static-readonly-index-signature.
- Selector:
static-block. - Modifiers: No modifier available.
- Example:
static-block.
The private modifier will currently match any of the following:
- Elements with the
privatekeyword. - Elements with their name starting with
#.
Elements that are not protected nor private will be matched with the public modifier, even if the keyword is not present.
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.
The lists of selectors and modifiers above are both sorted by importance, from most to least important. In case of multiple groups matching an element, the following rules will be applied:
- Selector priority:
constructor,get-methodandset-methodgroups will always take precedence overmethodgroups. - If the selector is the same, 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 1:
abstract class Class {
protected abstract get field();
}field can be matched by the following groups, from most to least important:
abstract-protected-get-methodorprotected-abstract-get-method.abstract-get-method.protected-get-method.get-method.abstract-protected-methodorprotected-abstract-method.abstract-method.protected-method.method.unknown.
Example 2 (The most important group is written in the comments):
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() {};
}You may directly override options for a specific group by using an object with the group property and other option overrides.
type— Overrides thetypeoption for that group.order— Overrides theorderoption for that group.fallbackSort— Overrides thefallbackSortoption for that group.newlinesInside— Overrides thenewlinesInsideoption for that group.
{
groups: [
'property',
{ group: 'method', type: 'unsorted' }, // Elements from this group will not be sorted
]
}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',
]
}Migrating from the old to the current API is easy:
Old API:
{
"key1": "value1",
"key2": "value2"
}Current API:
[
{
"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'
fallbackSort?: { type: string; order?: 'asc' | 'desc' }
newlinesInside?: number | 'ignore'
selector?: string
modifiers?: string[]
elementNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
elementValuePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
decoratorNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: 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'
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 }[]
elementValuePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
decoratorNamePattern?: string | string[] | { pattern: string; flags?: string } | { pattern: string; flags?: string }[]
}>
}A class member will match a CustomGroupAnyOfDefinition group if it matches all the filters of at least one of the anyOf items.
groupName— The group's name, which needs to be put in thegroupsoption.selector— Filter on theselectorof the element.modifiers— Filter on themodifiersof 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.elementValuePattern— Only for non-function properties. If entered, will check that the value of the property matches the pattern entered.decoratorNamePattern— If entered, will check that at least onedecoratormatches the pattern entered.type— Overrides thetypeoption for that custom group.order— Overrides theorderoption for that custom group.fallbackSort— Overrides thefallbackSortoption for that custom group.newlinesInside— Overrides thenewlinesInsideoption for that custom group.
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. If you want a predefined group to take precedence over a custom group,
you must write a custom group definition that does the same as what the predefined group does (using selector and modifiers filters), and put it first in the list.
Example:
{
groups: [
'static-block',
'index-signature',
+ 'input-properties', // [!code ++]
+ 'output-properties', // [!code ++]
'constructor',
+ 'unsorted-methods-and-other-properties', // [!code ++]
['get-method', 'set-method'],
'unknown',
],
+ customGroups: [ // [!code ++]
+ { // [!code ++]
+ // `constructor()` members must not match // [!code ++]
+ // `unsorted-methods-and-other-properties` // [!code ++]
+ // so make them match this first // [!code ++]
+ groupName: 'constructor', // [!code ++]
+ selector: 'constructor', // [!code ++]
+ }, // [!code ++]
+ { // [!code ++]
+ groupName: 'input-properties', // [!code ++]
+ selector: 'property', // [!code ++]
+ modifiers: ['decorated'], // [!code ++]
+ decoratorNamePattern: 'Input', // [!code ++]
+ }, // [!code ++]
+ { // [!code ++]
+ groupName: 'output-properties', // [!code ++]
+ selector: 'property', // [!code ++]
+ modifiers: ['decorated'], // [!code ++]
+ decoratorNamePattern: 'Output', // [!code ++]
+ }, // [!code ++]
+ { // [!code ++]
+ groupName: 'unsorted-methods-and-other-properties', // [!code ++]
+ type: 'unsorted', // [!code ++]
+ anyOf: [ // [!code ++]
+ { // [!code ++]
+ selector: 'method', // [!code ++]
+ }, // [!code ++]
+ { // [!code ++]
+ selector: 'property', // [!code ++]
+ }, // [!code ++]
+ ] // [!code ++]
+ }, // [!code ++]
+ ] // [!code ++]
}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.
<CodeTabs code={[ { source: dedent` // eslint.config.js import perfectionist from 'eslint-plugin-perfectionist'
export default [
{
plugins: {
perfectionist,
},
rules: {
'perfectionist/sort-classes': [
'error',
{
type: 'alphabetical',
order: 'asc',
fallbackSort: { type: 'unsorted' },
ignoreCase: true,
specialCharacters: 'keep',
partitionByComment: false,
partitionByNewLine: false,
newlinesBetween: 'ignore',
newlinesInside: 'ignore',
ignoreCallbackDependenciesPatterns: [],
groups: [
'index-signature',
['static-property', 'static-accessor-property'],
['static-get-method', 'static-set-method'],
['protected-static-property', 'protected-static-accessor-property'],
['protected-static-get-method', 'protected-static-set-method'],
['private-static-property', 'private-static-accessor-property'],
['private-static-get-method', 'private-static-set-method'],
'static-block',
['property', 'accessor-property'],
['get-method', 'set-method'],
['protected-property', 'protected-accessor-property'],
['protected-get-method', 'protected-set-method'],
['private-property', 'private-accessor-property'],
['private-get-method', 'private-set-method'],
'constructor',
['static-method', 'static-function-property'],
['protected-static-method', 'protected-static-function-property'],
['private-static-method', 'private-static-function-property'],
['method', 'function-property'],
['protected-method', 'protected-function-property'],
['private-method', 'private-function-property'],
'unknown',
],
customGroups: [],
useConfigurationIf: {},
useExperimentalDependencyDetection: true,
},
],
},
},
]
`,
name: 'Flat Config',
value: 'flat',
},
{
source: dedent`
// .eslintrc.js
module.exports = {
plugins: [
'perfectionist',
],
rules: {
'perfectionist/sort-classes': [
'error',
{
type: 'alphabetical',
order: 'asc',
fallbackSort: { type: 'unsorted' },
ignoreCase: true,
specialCharacters: 'keep',
partitionByComment: false,
partitionByNewLine: false,
newlinesBetween: 'ignore',
newlinesInside: 'ignore',
ignoreCallbackDependenciesPatterns: [],
groups: [
'index-signature',
['static-property', 'static-accessor-property'],
['static-get-method', 'static-set-method'],
['protected-static-property', 'protected-static-accessor-property'],
['protected-static-get-method', 'protected-static-set-method'],
['private-static-property', 'private-static-accessor-property'],
['private-static-get-method', 'private-static-set-method'],
'static-block',
['property', 'accessor-property'],
['get-method', 'set-method'],
['protected-property', 'protected-accessor-property'],
['protected-get-method', 'protected-set-method'],
['private-property', 'private-accessor-property'],
['private-get-method', 'private-set-method'],
'constructor',
['static-method', 'static-function-property'],
['protected-static-method', 'protected-static-function-property'],
['private-static-method', 'private-static-function-property'],
['method', 'function-property'],
['protected-method', 'protected-function-property'],
['private-method', 'private-function-property'],
'unknown',
],
customGroups: [],
useConfigurationIf: {},
useExperimentalDependencyDetection: true,
},
],
},
}
`,
name: 'Legacy Config',
value: 'legacy',
},
]} type="config-type" client:load lang="tsx" />
This rule was introduced in v0.11.0.