135 lines
4.7 KiB
Markdown
135 lines
4.7 KiB
Markdown
|
|
|
|
A TOML language support extension backed by [Taplo](https://taplo.tamasfe.dev).
|
|
|
|
It is currently a **preview extension**, it might contain bugs, or might even crash. If you encounter any issues, please report them [on github](https://github.com/tamasfe/taplo/issues).
|
|
|
|
- [Features](#features)
|
|
- [TOML version 1.0.0 support](#toml-version-100-support)
|
|
- [Syntax highlighting](#syntax-highlighting)
|
|
- [Additional Syntax Colors](#additional-syntax-colors)
|
|
- [Semantic highlighting](#semantic-highlighting)
|
|
- [Validation](#validation)
|
|
- [Folding](#folding)
|
|
- [Symbol tree and navigation](#symbol-tree-and-navigation)
|
|
- [Refactors](#refactors)
|
|
- [Renaming](#renaming)
|
|
- [Formatting](#formatting)
|
|
- [Completion and Validation with JSON Schema](#completion-and-validation-with-json-schema)
|
|
- [Commands](#commands)
|
|
- [Configuration File](#configuration-file)
|
|
- [Special Thanks](#special-thanks)
|
|
|
|
# Features
|
|
|
|
## TOML version [1.0.0](https://toml.io/en/v1.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.
|
|
|
|
|
|
|
|
### 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](https://github.com/Microsoft/vscode/issues/32813).
|
|
|
|
You might also want to set a color for dates and times, as they don't have have one in most themes.
|
|
|
|
<details>
|
|
<summary>Custom color settings for the Dark+ theme</summary>
|
|
|
|
```json
|
|
{
|
|
"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",
|
|
}
|
|
}
|
|
]
|
|
},
|
|
}
|
|
```
|
|
</details>
|
|
|
|
|
|
|
|
## 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.**
|
|
|
|
|
|
|
|
## Validation
|
|
|
|
|
|
|
|
## Folding
|
|
|
|
Arrays, multi-line strings and top level tables and comments can be folded.
|
|
|
|
|
|
|
|
## Symbol tree and navigation
|
|
|
|
Works even for tables not in order.
|
|
|
|
|
|
|
|
## Refactors
|
|
|
|
### Renaming
|
|
|
|
|
|
|
|
## 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!
|
|
|
|
|
|
|
|
## Completion and Validation with [JSON Schema](https://json-schema.org/)
|
|
|
|
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](https://www.schemastore.org/json/). More details [here](https://taplo.tamasfe.dev/configuration/using-schemas.html#using-schemas).
|
|
|
|
|
|
|
|
## Commands
|
|
|
|
The extension provides commands for easy JSON<->TOML conversions.
|
|
|
|
# Configuration File
|
|
|
|
Taplo CLI's [configuration file](https://taplo.tamasfe.dev/configuration/file) is supported and automatically found in workspace roots, or can be manually set in the VS Code configuration.
|
|
|
|
# Special Thanks
|
|
|
|
- To [@GalAster](https://github.com/GalAster) and [@be5invis](https://github.com/be5invis) for letting me use their TextMate grammar.
|
|
- To every contributor.
|
|
- And to everyone else using this extension.
|