Sort JSON/JSONL/JSONC/JS array

Sorts a JSON/JSONL/JSONC/JS array by common property or by custom function and replace the array in-place. The array can be selected (must include [ and ]). If no selection is present, the extension will try to find an array that is enclosed by the current cursor position.

Installation

Install it from Visual Studio Code Market Place or Open VSX

In extensions search for sort js array or launch Quick Open (Ctrl+P), paste the following command, and press enter.

ext install fvclaus.sort-json-array

What is supported?

This extension contains its own parser, because JSON.parse is too restrictive and eval doesn't support comments and will strip out some information (for example how and if object properties are quoted). The result is a support for a superset of JSON/JSONC/JSONL and a subset of JS.

• Arrays:
  • number[], string[] or object[]
  • Dangling , commas after the last array item
• Objects:
  • Object properties/key can be either unquoted, 'single' or "double" quoted
• Strings: 'single' and "double" quoted
• Numbers: Base 10 numbers with optional exponent
• Comments:
  • // Line comments
  • /* Block comments stretching multiple lines
• JSONL: with the same rules as above. Selection of an arbitrary number of lines is supported.
• JSONC: Full support with the same rules as above

Demo

Sort array of objects ascending or descending by one or more properties to produce a deterministic sort result:

Sort array using custom function:

Manage sort modules:

Features

Sort number, string or object arrays

String arrays are sorted using the lexicographic order using Intl.Collator. Number arrays are sorted based on their value. Objects are sorted based on one or more properties. The program will ask until the sort is deterministic. There is command for ascending and descending sort. Nested objects and arrays with mixed types are only supported by custom function.

Custom sort

Custom sort opens the sort module in another tab. The sort module must be a valid typescript module that exports a sort(a, b): number function. Typing of a and b can be arbitrary. Every time the module is saved, it will be evaluated and applied to the selected array. A preview of the sort function applied to the current array will be displayed in the output view. Any error in the sort module will be displayed as error message. When the sort module (= tab) is closed, it will be applied to the array of the file where the command was triggered.

For older vscode versions: Opening the sort module in another tab only works properly if preview mode is disabled. Set workbench.editor.enablePreview to false. There is also some simple module management, including delete and rename functionality. New sort module will always be named sort.xx.ts.

Technical: Sort modules are stored in the global storage path location for this extension. This is a folder in your vs code config location.

Sort keybindings.json

The keybindings.json can be sorted with this custom sort module:

interface KeyMapping {
    key: string;
    command: string;
}

export function sort(a: KeyMapping, b: KeyMapping): number {

    const aIsUnassignment = a.command.startsWith("-");
    const bIsUnassignment = b.command.startsWith("-");

    // Put assignments before unassignments
    if (aIsUnassignment !== bIsUnassignment) {
        return aIsUnassignment ? 1 : -1;
    }

    return a.command.localeCompare(b.command);
}

Selecting array manually

Selecting an array works well with the editor.action.smartSelect.grow keyboard shortcut or a similar expand-selection shortcut.

Serialization according to editor settings

This extension supports a custom serialization that uses the indentation and end of line settings of the current editor. It will retain the style of quotation for object properties (none/single/double). Any custom formatting will be removed, because it often dependents on the position in the array (first vs second vs last) and there are too many variations to get it right. Instead, this extension serializes arrays similar to how JSON.parse would (also similar to Prettier's formatting).

Contributing

If you wish to contribute, check out the contributing guidelines.

Number of downloads

vscode
Open VSX