useSortedInterfaceMembers (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.4.0
Diagnostic Category: assist/source/useSortedInterfaceMembers
Sources:
- Inspired from perfectionist/sort-interfaces
- Inspired from typescript-sort-keys/interface

How to enable in your editor

1
{
2
  "editor.codeActionsOnSave": {
3
    "source.action.useSortedInterfaceMembers.biome": "explicit",
4
    "source.fixAll.biome": "explicit"
5
  }
6
}

1
{
2
  "code_actions_on_format": {
3
    "source.action.useSortedInterfaceMembers.biome": true,
4
    "source.fixAll.biome": true
5
  }
6
}

Use the source action code source.action.useSortedInterfaceMembers.biome

How to configure

1
{
2
  "assist": {
3
    "actions": {
4
      "source": {
5
        "useSortedInterfaceMembers": "on"
6
      }
7
    }
8
  }
9
}

Description

Sort named members of a TypeScript interface.

The action uses natural order, which compares numbers by value so that item9 comes before item10. It can sort members with fixed names:

properties: property: type;
methods: method(): type;
getters: get property(): type;
setters: set property(value: type): void.

Members without a fixed name cannot be sorted by name:

call signatures such as (): type make the interface callable;
construct signatures such as new (): type make it constructible;
index signatures such as [key: string]: type describe dynamically named properties;
computed names such as [Symbol.iterator]() are calculated from an expression.

The action places sorted, named members first. It keeps members without fixed names in their original relative order after them.

Examples

Invalid

1
interface MixedMembers {
2
  z: string;
3
  a: number;
4
  (): void;  // Call signature
5
  y: boolean;
6
  new (): MixedMembers;  // Construct signature
7
  b: string;
8
  [key: string]: any;  // Index signature
9
}

code-block.ts:1:1 assist/source/useSortedInterfaceMembers  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ The interface members are not sorted by key.
  
   > 1 │ interface MixedMembers {
       │ ^^^^^^^^^^^^^^^^^^^^^^^^
   > 2 │   z: string;
   > 3 │   a: number;
   > 4 │   (): void;  // Call signature
   > 5 │   y: boolean;
   > 6 │   new (): MixedMembers;  // Construct signature
   > 7 │   b: string;
   > 8 │   [key: string]: any;  // Index signature
   > 9 │ }
       │ ^
    10 │ 
  
  ℹ Safe fix: Sort the interface members by key.
  
     1  1 │   interface MixedMembers {
     2    │ - ··z:·string;
     3    │ - ··a:·number;
     4    │ - ··():·void;··//·Call·signature
     5    │ - ··y:·boolean;
     6    │ - ··new·():·MixedMembers;··//·Construct·signature
     7    │ - ··b:·string;
        2 │ + ··a:·number;
        3 │ + ··b:·string;
        4 │ + ··y:·boolean;
        5 │ + ··z:·string;
        6 │ + ··():·void;··//·Call·signature
        7 │ + ··new·():·MixedMembers;··//·Construct·signature
     8  8 │     [key: string]: any;  // Index signature
     9  9 │   }

Valid

1
interface MixedMembers {
2
  a: number;
3
  b: string;
4
  y: boolean;
5
  z: string;
6
  (): void;  // Non-sortable members remain in original order
7
  new (): MixedMembers;
8
  [key: string]: any;
9
}

Options

`partitionByNewLine`

When enabled, members separated by a blank line are kept in their own section and sorted only within that section. This preserves logical groupings that the author intentionally introduced with empty lines.

Default: false

1
{
2
  "assist": {
3
    "actions": {
4
      "source": {
5
        "useSortedInterfaceMembers": {
6
          "level": "on",
7
          "options": {
8
            "partitionByNewLine": true
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

With the option enabled, the following interface is considered sorted because each section is sorted on its own:

1
interface User {
2
  id: string;
3

4
  createdAt: Date;
5
  updatedAt: Date;
6

7
  email: string;
8
  name: string;
9
  passwordHash: string;
10
}