|
|
||
|---|---|---|
| .cargo | ||
| doc | ||
| scripts | ||
| src | ||
| vhdl | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Jenkinsfile | ||
| LICENSE | ||
| README.md | ||
README.md
vsg_bridge_ls
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
- Installation alternatives and PATH troubleshooting
- Helix, Vim, and VSCodium setup
- Development and packaging
- Dependency and CI hardening plan
The bridge is deliberately small. Contributions should preserve clean LSP standard output and keep the VSG subprocess boundary explicit.