sort-object-types

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.
• 'unsorted' — Do not sort items. To be used with the useConfigurationIf 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.

[DEPRECATED] ignorePattern

Use the useConfigurationIf.declarationMatchesPattern option alongside type: unsorted instead.

Allows you to specify names or patterns for object types that should be ignored by this rule. This can be useful if you have specific object types that you do not want to sort.

You can specify their names or a regexp pattern to ignore, for example: '^Component.+' to ignore all object types whose names begin with the word “Component”.

partitionByComment

Allows you to use comments to separate the members of types into logical groups. This can help in organizing and maintaining large object types by creating partitions 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.
• string[] — A list of regexp patterns to specify which comments should act as delimiters.

partitionByNewLine

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

type User = {
  // Group 1
  firstName: string;
  lastName: string;

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

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

Each group of members (separated by empty lines) is treated independently, and the order within each group is preserved.

newlinesBetween

Specifies how new lines should be handled between object type 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.

This options is only applicable when partitionByNewLine is false.

[DEPRECATED] groupKind

Use the groups option with the optional and required modifiers instead.

Allows you to group type object keys by their kind, determining whether required values should come before or after optional values.

• mixed — Do not group object keys by their kind; required values are sorted together optional values.
• required-first — Group all required values before optional.
• optional-first — Group all optional values before required.

useConfigurationIf

Allows you to specify filters to match a particular options configuration for a given object type.

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 keys must match.

Example configuration:

{
  'perfectionist/sort-object-types': [
    'error',
    {
      groups: ['r', 'g', 'b'], // Sort colors types by RGB
      customGroups: {
        r: '^r$',
        g: '^g$',
        b: '^b$',
      },
      useConfigurationIf: {
        allNamesMatchPattern: '^r|g|b$',
      },
    },
    {
      type: 'alphabetical' // Fallback configuration
    }
  ],
}

• declarationMatchesPattern — A regexp pattern that the object type declaration must match.

Example configuration:

{
  'perfectionist/sort-object-types': [
    'error',
    {
      type: 'unsorted', // Do not sort Metadata types
      useConfigurationIf: {
        declarationMatchesPattern: '*Metadata$',
      },
    },
    {
      type: 'alphabetical' // Fallback configuration
    }
  ],
}

groups

Allows you to specify a list of type properties groups for sorting. Groups help organize properties into categories, making your type definitions more readable and maintainable.

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

type User = {
  firstName: string // unknown
  lastName: string  // unknown
  username: string  // unknown
  job: {            // multiline-member
    // Stuff about job
  }
  localization: {   // multiline-member
    // Stuff about localization
  }
}

{
  groups: [
    'unknown',
    'method',
    'multiline-member',
  ]
}

interface Test {
  optionalMethod?: () => {
      property: string;
    }
}

interface Interface {
  // 'index-signature'
  [key: string]: any;
  // 'optional-property'
  description?: string;
  // 'required-method'
  method(): string

customGroups

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

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

You can define your own groups and use regexp pattern to match specific object type 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'
  selector?: string
  modifiers?: string[]
  elementNamePattern?: string
}

An object type 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'
  anyOf: Array<{
      selector?: string
      modifiers?: string[]
      elementNamePattern?: string
  }>
}

An object type will match a CustomGroupAnyOfDefinition group if it matches all the filters of at least one of the anyOf items.

type User = {
  id: string                 // top
  name: string               // top
  age: number                // unknown
  isAdmin: boolean           // unknown
  lastUpdated_metadata: Date // bottom
  localization?: {            // optional-multiline-member
    // Stuff about localization
  }
  version_metadata: string   // bottom
}

 {
   groups: [
+    'top',
     'unknown',
+    ['optional-multiline-member', 'bottom'] 
   ],
+  customGroups: [                              
+    {                                          
+       groupName: 'top',
+       selector: 'property',
+       elementNamePattern: '^(?:id|name)$',
+    },
+    {                                          
+       groupName: 'bottom',
+       selector: 'property',
+       elementNamePattern: '.+_metadata$',
+    }                                          
+  ]                                            
 }