sort-objects

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.

partitionByComment

Allows you to use comments to separate the keys of objects into logical groups. This can help in organizing and maintaining large objects 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[] — An array of regexp patterns 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 object’s keys if there is an empty line between them. This can be useful for keeping logically separated groups of keys in their defined order.

const user = {
  // Group 1
  firstName: 'John',
  lastName: 'Doe',

  // Group 2
  age: 30,
  birthDate: '1990-01-01',

  // Group 3
  email: 'john.doe@example.com',
  phone: '555-555-5555'
};

Each group of keys (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 groups.

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

This option is only applicable when partitionByNewLine is false.

styledComponents

Determines whether this rule should be applied to styled-components like libraries or style JSX attribute.

• true — Apply the rule to styled-components.
• false — Disable the rule for styled-components.

ignorePattern

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

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

[DEPRECATED] destructureOnly

Use the objectDeclarations and destructuredObjects options instead.

Allows you to only sort objects that are part of a destructuring pattern. When set to true, the rule will apply sorting exclusively to destructured objects, leaving other object declarations unchanged.

objectDeclarations

Allows you to choose whether to sort standard object declarations.

destructuredObjects

Allows you to choose whether to sort destructured objects. The groups attribute allows you to specify whether to use groups to sort destructured objects.

useConfigurationIf

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

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

Example configuration:

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

• callingFunctionNamePattern — A regexp pattern for matching objects that are passed as arguments to a function with a specific name.

{
  'perfectionist/sort-objects': [
    'error',
    {
      type: 'unsorted', // Don't sort objects passed to createSlice
      useConfigurationIf: {
        callingFunctionNamePattern: '^createSlice$',
      },
    },
    {
      type: 'alphabetical' // Fallback configuration
    }
  ],
}

groups

Allows you to specify a list of object keys groups for sorting. Groups help organize object keys into categories, making your objects 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.

let user = {
  firstName: "John", // unknown
  lastName: "Doe",  // unknown
  username: "john_doe",  // unknown
  job: {            // multiline-member
    // Stuff about job
  },
  localization: {   // multiline-member
    // Stuff about localization
  }
}

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

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

customGroups

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

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

You can define your own groups and use regexp patterns to match specific object keys.

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
}

An object 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
  }>
}

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

let user = {
  id: "id",                 // top
  name: "John",               // top
  age: 42,                // unknown
  isAdmin: true,           // unknown
  lastUpdated_metadata: null, // bottom
  localization: {            // multiline-member
    // Stuff about localization
  },
  version_metadata: "1"   // bottom
}

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