KVD for VS Code

Language support for the KVD config/data format, powered by the kvd-lsp language server.

Features

• Syntax highlighting — keys and quoted strings in .kvd files.
• Diagnostics — parse errors with line/column ranges, plus schema violations when a sibling <name>.schema.kvd file exists.
• Completion — builtin type names, scalar keywords, document keys, and type-aware schema keys: element only for list/dict, validation constraints filtered by type, and reason/since inside deprecated.
• Hover — one-line help for builtins, value shapes for document keys, and spec help for schema descriptor, validation, and deprecated keys.
• Formatting — whole-document rewrite through kvd-lsp (kvd-rs).
• Go to definition — jump between data keys and their schema keys.

Requirements

This extension is a client for the kvd-lsp binary, which is installed separately. It requires VS Code 1.82 or newer. Installing the server with cargo install requires Rust 1.85 or newer.

cargo install kvd-lsp

cargo install puts the binary in $CARGO_HOME/bin (~/.cargo/bin by default, %USERPROFILE%\.cargo\bin on Windows). The extension searches that directory automatically, so no configuration is needed. Type-aware schema completion and deprecated help require kvd-lsp 0.3.0 or newer.

To use a binary elsewhere, set kvd.serverPath:

{
    "kvd.serverPath": "/absolute/path/to/kvd-lsp"
}

When kvd.serverPath is empty, the extension uses the current OS's setting (kvd.serverPathLinux, kvd.serverPathDarwin, or kvd.serverPathWindows), then falls back to auto-detection: $CARGO_HOME/bin, ~/.cargo/bin, or target/debug/kvd-lsp in a source checkout.

Extension settings

~, $VAR, ${VAR}, ${userHome}, ${env:VAR}, and %VAR% are expanded. Resolution order is kvd.serverPath, then the current OS's setting, then auto-detection ($CARGO_HOME/bin, ~/.cargo/bin, or a source checkout). If an OS default does not exist, auto-detection still runs. Because each OS reads its own key, one synced settings.json can carry a path per host:

{
    "kvd.serverPathLinux": "~/.local/bin/kvd-lsp",
    "kvd.serverPathDarwin": "~/bin/kvd-lsp",
    "kvd.serverPathWindows": "C:\\tools\\kvd-lsp.exe"
}

Commands

License

MIT