govlang/v-analyzer

Bring IDE features for V programming languages in VS Code, Vim and other editors

v-analyzer

Bring IDE features for V programming languages in VS Code, Vim, and other editors.

v-analyzer provides the following features:

• code completion/IntelliSense
• go to definition, type definition
• find all references, document symbol, symbol renaming
• types and documentation on hover
• inlay hints for types and some construction like or block
• semantic syntax highlighting
• formatting
• signature help

Installation

Linux and macOS

v -e "$(curl -fsSL https://raw.githubusercontent.com/v-analyzer/v-analyzer/master/install.vsh)"

Windows

curl 'https://raw.githubusercontent.com/v-analyzer/v-analyzer/master/install.vsh' | %{ v -e $_ }

Pre-built binaries

You can download pre-built binaries from the release page. Currently, we provide binaries for Linux (x64), macOS (x64 and ARM), and Windows (x64).

Building from source

Note If you're using Windows, then you need GCC for any build, as TCC doesn't work due to some issues.

Update V to the latest version:

v up

Install dependencies:

v install

You can build debug or release version of the binary. Debug version will be slower, but faster to compile.

Debug build:

v build.vsh debug

Release build:

v build.vsh release

Binary will be placed in bin/ folder.

Setup

Add bin/ folder to your $PATH environment variable to use v-analyzer command inside VS Code and other editors (preferred).

Or, you can specify the path to the binary in your VS Code settings:

{
  "v-analyzer.serverPath": "/path/to/v-analyzer/bin/v-analyzer"
}

Note Restart VS Code after changing the settings or PATH.

Config

v-analyzer is configured using global or local config. The global config is located in ~/.config/v-analyzer/config.toml, changing it will affect all projects.

A local config can be created with the v-analyzer init command at the root of the project. Once created, it will be in ./.v-analyzer/config.toml. Each setting in the config has a detailed description.

Pay attention to the custom_vroot setting, if v-analyzer cannot find where V was installed, then you will need to specify the path to it manually in this field.

Updating

To update v-analyzer to the latest version, run:

v-analyzer up

You can also update to a nightly version:

v-analyzer up --nightly

Note In the nightly version you will get the latest changes, but they may not be stable!

VS Code extension

This repository also contains the source code for the VS Code extension in the editors/code folder. See also extension page in VS Code Marketplace.

Authors

• jsonrpc, lsp, tree_sitter_v modules written initially by VLS authors and after that in 2023 it was modified by the VOSCA.

Thanks

• VLS authors for the initial Language Server implementation!
• vscode-vlang authors for the first VS Code extension!
• rust-analyzer and gopls for the inspiration!
• Tree-sitter authors for the cool parsing library!

License

This project is under the MIT License. See the LICENSE file for the full license text.