summaryrefslogtreecommitdiff
path: root/nvim/lsp/vhdl_ls.lua
diff options
context:
space:
mode:
Diffstat (limited to 'nvim/lsp/vhdl_ls.lua')
-rwxr-xr-xnvim/lsp/vhdl_ls.lua36
1 files changed, 36 insertions, 0 deletions
diff --git a/nvim/lsp/vhdl_ls.lua b/nvim/lsp/vhdl_ls.lua
new file mode 100755
index 0000000..5ca6810
--- /dev/null
+++ b/nvim/lsp/vhdl_ls.lua
@@ -0,0 +1,36 @@
+---@brief
+---
+--- Install vhdl_ls from https://github.com/VHDL-LS/rust_hdl and add it to path
+---
+--- Configuration
+---
+--- The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the TOML format named vhdl_ls.toml.
+---
+--- vhdl_ls will load configuration files in the following order of priority (first to last):
+---
+--- A file named .vhdl_ls.toml in the user home folder.
+--- A file name from the VHDL_LS_CONFIG environment variable.
+--- A file named vhdl_ls.toml in the workspace root.
+---
+--- Settings in a later files overwrites those from previously loaded files.
+---
+--- Example vhdl_ls.toml
+--- ```
+--- # File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
+--- [libraries]
+--- lib2.files = [
+--- 'pkg2.vhd',
+--- ]
+--- lib1.files = [
+--- 'pkg1.vhd',
+--- 'tb_ent.vhd'
+--- ]
+--- ```
+return {
+ cmd = { 'vhdl_ls' },
+ filetypes = { 'vhd', 'vhdl' },
+ root_markers = {
+ 'vhdl_ls.toml',
+ '.vhdl_ls.toml',
+ },
+}