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

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

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 members of types into logical groups. This can help in organizing and maintaining large object types by creating partitions within the enum 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.

groupKind

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.

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.

Predefined groups:

• 'multiline' — Properties with multiline definitions, such as methods or complex type declarations.
• 'method' - Members that are methods.
• 'unknown' — Properties that don’t fit into any group specified in the groups option.

If the unknown group is not specified in the groups option, it will automatically be added to the end of the list.

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.

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

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

customGroups

You can define your own groups and use regexp pattern to match specific object type members.

Each key of customGroups represents a group name which you can then use in the groups option. The value for each key can either be of type:

• string — A type member’s name matching the value will be marked as part of the group referenced by the key.
• string[] — A type member’s name matching any of the values of the array will be marked as part of the group referenced by the key. The order of values in the array does not matter.

Custom group matching takes precedence over predefined group matching.

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

 {
   groups: [
+    'top',
     'unknown',
     ['multiline', 'bottom'] 
   ],
+  customGroups: {           
+    top: ['^id$', '^name$'] 
+    bottom: '.+_metadata$'
+  }                         
 }