vsg-bridge-ls/README.md

1.5 KiB

vsg_bridge_ls

A very featureless VSG to lsp bridge, allowing to use vsg as a linting lsp instead of an external diagnostic tool.

Install

Installing VSG

Install vsg either via pip on pip in your venv:

python -m venv venv
source venv/activate (or activate.fish if you use fish etc...)
pip install vsg

Please note that if you decide to use a venv, you will need to activate your venv every time.

Installing vsg_bridge_ls

cargo install --git https://proxy.dandaedre.com/gitea/Dandaedre/vsg_bridge_ls.git

Adding the lsp bridge to your editor

Helix

Add the following to your ~/.config/helix/language.toml (create this file if it doesn't exist)

[language-server.vsg_bridge_ls]
command = "vsg_bridge_ls"
args = ["-c", "vhdl/config.yaml"] # Optionnal config, note that the path is relative to your project

[[language]]
name = "vhdl"
scope = "source.vhdl"
file-types = ["vhd", "vhdl"]
comment-token = "--"
language-servers = [ "vhdl_ls", "vsg_bridge_ls" ]
indent = { tab-width = 2, unit = "  " }
injection-regex = "vhdl"
 

Others

Check your editor documentation on how to add a lsp. Untested.

Developper Documentation

Tower-lsp VSG Github VSG Docs Lsp Specs