Sort Blocks Ascending: Sorts the selected code blocks in ascending order. If no code blocks are selected, a selection for the deepest block the cursor is currently positioned in is generated.

Sort Blocks Descending: Sorts the selected code blocks in descending order. If no code blocks are selected, a selection for the deepest block the cursor is currently positioned in is generated.

Sort Blocks Deep Ascending (Multilevel): Sorts the selected code blocks in ascending order, including nested blocks up to a specified depth.

Sort Blocks Deep Descending (Multilevel): Sorts the selected code blocks in descending order, including nested blocks up to a specified depth.

Expand current Selection to surrounding Block: Expand curren selection locally to surrounding lines in block.

Expand current Selection fully (including separating Newlines) to the surrounding Block: Expand curren selection to complete surrounding block.

source.fixAll.blocksort: This can be executed on save to auto-sort all blocks following a @blocksort marker.

To enable auto Sorting, you must set the editor.codeActionsOnSave in your settings.json:

{
  "editor.codeActionsOnSave": {
    "source.fixAll.blocksort": true
  }
}

This will enable auto-sorting for blocks following a @blocksort marker. The marker can additionally be followed by the options asc or desc to control the sorting order, as well as a number for the sorting depth:

// @blocksort asc
switch(value) {
  case 1:
    return 1;
  case 2:
    return 2;
  default:
    return 2;
}

# @blocksort asc inf
some:
  nested:
    - code
    - (will be
  sorted:
    - up to
    - any level)

• defaultMultilevelDepth: Default depth used for deep sorting.
  • Default: -1 (infinite)
• askForMultilevelDepth: Skip asking for multilevel depth and always use defaultMultilevelDepth.
  • Default: true
• indentIgnoreMarkers: List of regex markers that when matched will result in ignoring the indentation of the current line. This is for example used for c-style { in a new line. The markers are always assumed to be at teh start of the line, but can be preceded by spaces and comments.
  • Default:

    [
      "end(?:for(?:each)?|if|while|case|def)?\\s*?([\\.\\[\\->\\|\\s]\\s*(?:[$A-Za-z0-9_+\\-\\*\\/\\^\\%\\<\\>\\=\\!\\?\\:]*|'[^']*?'|'[']*?'|\"[^\"]*?\"|`[^`]*?`)\\s*[\\]\\|]?\\s*)*",
      "esac|fi",
      "{"
    ]
    

  • Language Overridable
• completeBlockMarkers: List of markers that complete a block. They are assumed to be at the end of a line, but can be succeeded by comments or end-of-line markers (, or ;).
  • Default: ["\\}", "<\\/[a-zA-Z0-9\\-_=\\s]+"]
  • Language Overridable
• foldingMarkers: Dictionary of folding markers. They are supplied set a key-value style, the key being a human-readable ultra-short description of the folding markers.
  • Base Options are always applied unless overridden in the dictionary, if null is specified, the marker is ignored:

    {
      "()": { "start": "\\(", "end": "\\)" },
      "[]": { "start": "\\[", "end": "\\]" },
      "{}": { "start": "\\{", "end": "\\}" },
      "<>": { "start": "<", "end": ">" },
    }
    

  • Default:
    • global: {}
    • [xml]:

      {
        "<>": {
          "start": "<[a-zA-Z0-9\\-_=\\s]+",
           "end": "<\\/[a-zA-Z0-9\\-_=\\s]+|\\/>"
        }
      }
      

    • [html], [php], [jsx-tags]:

      {
        "<>": {
          "start": "<(?!(?:\\/|area|base|br|col|command|embed|hr|img|input|keygen|link|meta|param|source|track|wbr)(?:[\\s\\/]|>))[a-zA-Z0-9\\-_=\\s>]+",
           "end": "<\\/[a-zA-Z0-9\\-_=\\s]+|\\/>"
        }
      }
      

  • Language Overridable
• enableNaturalSorting: Enables the natural sorting behavior for lines containing numbers.
  • Default: false
  • Deprecated: This option is n longer used, use collationOptions.numeric instead
• collatorOptions: Collator options for sorting. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator for more information
  • Default:

    {
      "numeric": true,
      "caseFirst": "false",
      "sensitivity": "base"
    }
    

  • In addition to the default JavaScript Collator options, the following properties can be supplied
    • locales: A BCP 47 language tag, or an comma separated array of such strings.
    • customSortOrder: Custom Sort order in the form of a list of characters
    • customIgnoreCharacters: A list of characters that are ignored when sorting, e.g. "'\"()[]{}<>"
• sortConsecutiveBlockHeaders: sorts consecutive block headers, such as a list of case statements.
  • Default: true
  • Language Overridable
• enableCodeLens: enables / disables code lenses shown over blocks annotated with @blocksort
  • Default: true
  • If true will copy value from enableCodeActions
• enableCodeActions: enables / disables code actions used for sorting blocks annotated with @blocksort, this will have an effect on fixAll code actions
  • Default: "*"
  • Will be overridden with enableCodeLens when set to false to avoid non-functioning code lenses
• enableDocumentFormatting: Document selector for selecting documents to select formatting for. Only matching documents will have a Sort with entry
  • Default: *
• enableRangeFormatting: Document selector for selecting documents to select formatting for. Only matching documents will have a Sort with entry
  • Default: true
  • If true will copy value from enableDocumentFormatting
• forceBlockHeaderFirstRegex: Regex to match block headers that should be sorted first. ^ and $ will be expanded to allow comments
  • Default: ^$
  • Language Overridable
• forceBlockHeaderLastRegex: Regex to match block headers that should be sorted last. ^ and $ will be expanded to allow comments
  • Default: ^(\\s*(when|case)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?\\n?\\r?)*\\s*default|else(?!\\s?if)\\s*:?$
  • Language Overridable
• multiBlockHeaderRegex: Regex for multi-block-headers such as a list of case statements under each other. ^ and $ will be expanded to allow comments
  • Default: ^(when|case|default|else)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$
  • Language Overridable
• incompleteBlockRegex: Regex for incomplete blocks. ^ and $ will be expanded to allow comments
  • Default: (if|when|else|case|for|foreach|else|elsif|while|def|then|default)\\s*('([^']|(?<=\\\\)')*'|\"([^\"]|(?<=\\\\)\")*\"|`([^`]|(?<=\\\\)`)*`|[A-Za-z_+\\-*/%<>d.,s]*)*\\s*(.*:)?$
  • Language Overridable
• keepAppendedNewlines: Keep appended Newlines in place when sorting
  • Default: true
• expandSelection: Expand Selection options
  • Default:

    {
      "expandLocally": true,
      "expandOverEmptyLines": false,
      "foldingComplete": true,
      "indentationComplete": true
    }
    

• expandSelection: Expand Cursor to selection options
  • Default:

    {
      "expandLocally": true,
      "expandOverEmptyLines": false,
      "foldingComplete": true,
      "indentationComplete": true
    }
    

Settings marked as Language Overridable can be specified on a per-language basis using the notation:

"[typescript]": {
  "blocksort.foldingMarkers": {
    "<>": {
      "start": "<",
      "end": "/>"
    }
  }
}