aboutsummaryrefslogtreecommitdiffstats
path: root/lsp/bicep.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-04-18 17:44:38 +0200
committerJustin M. Keyes <justinkz@gmail.com>2025-04-18 17:44:38 +0200
commitf8b5cbe6312b568def1f91d747e2cdb8984fdf2e (patch)
treec1baf319b22d8ccc7d3468276b5ba9a26dfa2775 /lsp/bicep.lua
parentfeat: angularls #3746 (diff)
downloadnvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.gz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.bz2
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.lz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.xz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.zst
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.zip
docs: cleanup
- brief should live at the top of each file - fix indentation for some docs
Diffstat (limited to 'lsp/bicep.lua')
-rw-r--r--lsp/bicep.lua62
1 files changed, 31 insertions, 31 deletions
diff --git a/lsp/bicep.lua b/lsp/bicep.lua
index 04cc22d9..310213bc 100644
--- a/lsp/bicep.lua
+++ b/lsp/bicep.lua
@@ -1,36 +1,36 @@
---@brief
---
--- https://github.com/azure/bicep
--- Bicep language server
---
--- Bicep language server can be installed by downloading and extracting a release of bicep-langserver.zip from [Bicep GitHub releases](https://github.com/Azure/bicep/releases).
---
--- Bicep language server requires the [dotnet-sdk](https://dotnet.microsoft.com/download) to be installed.
---
--- Neovim does not have built-in support for the bicep filetype which is required for lspconfig to automatically launch the language server.
---
--- Filetype detection can be added via an autocmd:
--- ```lua
--- vim.cmd [[ autocmd BufNewFile,BufRead *.bicep set filetype=bicep ]]
--- ```
---
--- **By default, bicep language server does not have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary.
---
--- ```lua
--- local bicep_lsp_bin = "/path/to/bicep-langserver/Bicep.LangServer.dll"
--- vim.lsp.config('bicep', {
--- cmd = { "dotnet", bicep_lsp_bin };
--- ...
--- })
--- ```
---
--- To download the latest release and place in /usr/local/bin/bicep-langserver:
--- ```bash
--- (cd $(mktemp -d) \
--- && curl -fLO https://github.com/Azure/bicep/releases/latest/download/bicep-langserver.zip \
--- && rm -rf /usr/local/bin/bicep-langserver \
--- && unzip -d /usr/local/bin/bicep-langserver bicep-langserver.zip)
--- ```
+--- https://github.com/azure/bicep
+--- Bicep language server
+---
+--- Bicep language server can be installed by downloading and extracting a release of bicep-langserver.zip from [Bicep GitHub releases](https://github.com/Azure/bicep/releases).
+---
+--- Bicep language server requires the [dotnet-sdk](https://dotnet.microsoft.com/download) to be installed.
+---
+--- Neovim does not have built-in support for the bicep filetype which is required for lspconfig to automatically launch the language server.
+---
+--- Filetype detection can be added via an autocmd:
+--- ```lua
+--- vim.cmd [[ autocmd BufNewFile,BufRead *.bicep set filetype=bicep ]]
+--- ```
+---
+--- **By default, bicep language server does not have a `cmd` set.** This is because nvim-lspconfig does not make assumptions about your path. You must add the following to your init.vim or init.lua to set `cmd` to the absolute path ($HOME and ~ are not expanded) of the unzipped run script or binary.
+---
+--- ```lua
+--- local bicep_lsp_bin = "/path/to/bicep-langserver/Bicep.LangServer.dll"
+--- vim.lsp.config('bicep', {
+--- cmd = { "dotnet", bicep_lsp_bin };
+--- ...
+--- })
+--- ```
+---
+--- To download the latest release and place in /usr/local/bin/bicep-langserver:
+--- ```bash
+--- (cd $(mktemp -d) \
+--- && curl -fLO https://github.com/Azure/bicep/releases/latest/download/bicep-langserver.zip \
+--- && rm -rf /usr/local/bin/bicep-langserver \
+--- && unzip -d /usr/local/bin/bicep-langserver bicep-langserver.zip)
+--- ```
return {
filetypes = { 'bicep' },
root_markers = { '.git' },