useSortedKeys (JSON)

Summary

Rule available since: v1.9.0
Diagnostic Category: assist/source/useSortedKeys
Sources:
- Same as json/sort-keys

How to enable in your editor

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

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

Use the source action code source.action.useSortedKeys.biome

How to configure

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

Description

Sort keys in a JSON object.

By default, the action uses natural order: uppercase letters come before lowercase letters (A before a), and numbers are compared by value (item9 before item10).

Examples

1
{
2
    "vase": "fancy",
3
    "nested": {
4
        "omega": "bar",
5
        "alpha": "foo"
6
    }
7
}

code-block.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    1 1 │   {
    2   │ - ····"vase":·"fancy",
    3   │ - ····"nested":·{
      2 │ + ····"nested":·{
    4 3 │           "omega": "bar",
    5 4 │           "alpha": "foo"
    6   │ - ····}
      5 │ + ····},
      6 │ + ····"vase":·"fancy"
    7 7 │   }
    8 8 │   
  
code-block.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    2 2 │       "vase": "fancy",
    3 3 │       "nested": {
    4   │ - ········"omega":·"bar",
    5   │ - ········"alpha":·"foo"
      4 │ + ········"alpha":·"foo",
      5 │ + ········"omega":·"bar"
    6 6 │       }
    7 7 │   }

Options

`sortOrder`

Selects natural or lexicographic ordering. Natural ordering compares numbers by value and is the default. Lexicographic ordering compares keys character by character.

The following configuration uses natural order:

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

1
{
2
    "val13": 1,
3
    "val1": 1,
4
    "val2": 1,
5
    "val21": 1,
6
    "val11": 1
7
}

code-block.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    1 1 │   {
    2   │ - ····"val13":·1,
    3   │ - ····"val1":·1,
    4   │ - ····"val2":·1,
    5   │ - ····"val21":·1,
    6   │ - ····"val11":·1
      2 │ + ····"val1":·1,
      3 │ + ····"val2":·1,
      4 │ + ····"val11":·1,
      5 │ + ····"val13":·1,
      6 │ + ····"val21":·1
    7 7 │   }
    8 8 │

The following configuration uses lexicographic order.

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

1
{
2
    "val13": 1,
3
    "val1": 1,
4
    "val2": 1,
5
    "val21": 1,
6
    "val11": 1
7
}

code-block.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    1 1 │   {
    2   │ - ····"val13":·1,
    3   │ - ····"val1":·1,
    4   │ - ····"val2":·1,
    5   │ - ····"val21":·1,
    6   │ - ····"val11":·1
      2 │ + ····"val1":·1,
      3 │ + ····"val11":·1,
      4 │ + ····"val13":·1,
      5 │ + ····"val2":·1,
      6 │ + ····"val21":·1
    7 7 │   }
    8 8 │

`groupByNesting`

Groups keys by the shape of their values before sorting by name. Strings, numbers, booleans, null, and single-line arrays or objects come first. Multi-line arrays and objects come afterward. Defaults to false.

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

1
{
2
    "name": "Sample",
3
    "details": {
4
        "description": "nested"
5
    },
6
    "id": 123
7
}

code-block.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    1 1 │   {
    2   │ - ····"name":·"Sample",
      2 │ + ····"id":·123,
      3 │ + ····"name":·"Sample",
    3 4 │       "details": {
    4 5 │           "description": "nested"
    5   │ - ····},
    6   │ - ····"id":·123
      6 │ + ····}
    7 7 │   }
    8 8 │