Skip to content

Latest commit

 

History

History
 
 

vscode

A TOML language support extension backed by Taplo.

It is currently a preview extension, it might contain bugs, or might even crash. If you encounter any issues, please report them on github.

Features

TOML version 1.0.0 support

This extension will try to support all the TOML versions in the future.

Syntax highlighting

Syntax highlighting for TOML documents with TextMate grammar.

Syntax Highlighting

Additional Syntax Colors

The extension defines custom scopes for array headers and arrays of tables.

In order to differentiate them from regular keys, you can set your own colors for them. Unfortunately this has to be done manually.

You might also want to set a color for dates and times, as they don't have have one in most themes.

Custom color settings for the Dark+ theme
{
  "editor.tokenColorCustomizations": {
      "textMateRules": [
          {
              "scope": "support.type.property-name.table",
              "settings": {
                  "foreground": "#4EC9B0",
              },
          },
          {
              "scope": "support.type.property-name.array",
              "settings": {
                  "foreground": "#569CD6",
              }
          },
          {
              "scope": "constant.other.time",
              "settings": {
                  "foreground": "#DCDCAA",
              }
          }
      ]
  },
}

Extended Color Highlighting

Semantic highlighting

Semantic key highlighting for inline tables and arrays can be enabled in the settings.

You need to set extended colors in order for this to have any practical effect.

Semantic Highlighting

Validation

Validation

Folding

Arrays, multi-line strings and top level tables and comments can be folded.

Folding

Symbol tree and navigation

Works even for tables not in order.

Symbols

Refactors

Renaming

Rename

Formatting

The formatter is rather conservative by default, additional features can be enabled in the settings. If you're missing a configuration option, feel free to open an issue about it!

Formatting

Completion and Validation with JSON Schema

There is support for completion, hover text, links and validation.

Schemas can be associated with document URIs with the evenBetterToml.schema.associations configuration.

You can provide your own schemas or use existing schemas from the JSON Schema Store. More details here.

Schema

Commands

The extension provides commands for easy JSON<->TOML conversions.

Configuration File

Taplo CLI's configuration file is supported and automatically found in workspace roots, or can be manually set in the VS Code configuration.

Special Thanks

  • To @GalAster and @be5invis for letting me use their TextMate grammar.
  • To every contributor.
  • And to everyone else using this extension.