A very featureless VSG to lsp bridge
Go to file
Dandaedre 4d78f5e6cf
Rust CI vsg_bridge_ls passed CI.
MadGobblins/vsg-bridge-ls/pipeline/head This commit looks good Details
Fix version badge rendering on FreeBSD
2026-10-02 23:59:26 +02:00
.cargo Pin Rust compatibility and publish coverage 2026-10-02 21:08:47 +02:00
doc Approve the scoped fix interface 2026-10-02 23:51:43 +02:00
scripts Fix version badge rendering on FreeBSD 2026-10-02 23:59:26 +02:00
src Stabilize subprocess tests on FreeBSD 2026-10-02 22:34:15 +02:00
tests/fixtures Stabilize subprocess tests on FreeBSD 2026-10-02 22:34:15 +02:00
vhdl Adds -ap to process all lints 2024-11-21 08:33:33 -06:00
.gitignore Remove local badge snapshots 2026-10-02 23:45:15 +02:00
Cargo.lock Stabilize subprocess tests on FreeBSD 2026-10-02 22:34:15 +02:00
Cargo.toml Stabilize subprocess tests on FreeBSD 2026-10-02 22:34:15 +02:00
Jenkinsfile Publish badges after failed builds 2026-10-02 23:50:08 +02:00
LICENSE
…
README.md Document the VSG bridge interface 2026-10-02 23:46:24 +02:00
deny.toml Add Cargo dependency policy gates 2026-10-02 21:45:16 +02:00
tarpaulin.toml Retain only the coverage badge 2026-10-02 23:28:11 +02:00

README.md

vsg_bridge_ls

version tests test coverage

vsg_bridge_ls reports VSG diagnostics through the Language Server Protocol (LSP). A complete setup needs the companion VSG fork and this bridge.

Helix is the only actively maintained and tested editor integration. The Vim and VSCodium recipes are best-effort and may need adjustment for your setup.

1. Install the VSG fork

The preferred installation uses uv pip and the prebuilt package:

uv venv .venv
uv pip install --python .venv/bin/python \
  --index https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/ \
  vsg

Without uv, use standard pip:

python3 -m venv .venv
. .venv/bin/activate
python -m pip install \
  --index-url https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/ \
  --extra-index-url https://pypi.org/simple \
  vsg

2. Install the bridge

cargo install --locked \
  --git https://proxy.dandaedre.com/gitea/MadGobblins/vsg-bridge-ls.git

Activate the environment and verify both executables:

. .venv/bin/activate
command -v vsg
command -v vsg_bridge_ls
vsg_bridge_ls --help

3. Configure Helix

Add this minimal setup to ~/.config/helix/languages.toml:

[language-server.vsg_bridge_ls]
command = "vsg_bridge_ls"

[[language]]
name = "vhdl"
language-servers = ["vsg_bridge_ls"]
auto-format = false
formatter = { command = "vsg", args = ["--stdin", "--stdout", "--fix", "-fp", "7", "--no-failure"] }

Start Helix from the activated environment:

. .venv/bin/activate
hx path/to/file.vhd

Diagnostics should appear as you edit. Run :format to format the current buffer with the fork.

More documentation

The bridge is deliberately small. Contributions should preserve clean LSP standard output and keep the VSG subprocess boundary explicit.