aboutsummaryrefslogtreecommitdiffstats
path: root/lsp/elixirls.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/elixirls.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/elixirls.lua')
-rw-r--r--lsp/elixirls.lua50
1 files changed, 25 insertions, 25 deletions
diff --git a/lsp/elixirls.lua b/lsp/elixirls.lua
index dbebea29..d3e5cb34 100644
--- a/lsp/elixirls.lua
+++ b/lsp/elixirls.lua
@@ -1,30 +1,30 @@
---@brief
---
--- https://github.com/elixir-lsp/elixir-ls
---
--- `elixir-ls` can be installed by following the instructions [here](https://github.com/elixir-lsp/elixir-ls#building-and-running).
---
--- 1. Download the zip from https://github.com/elixir-lsp/elixir-ls/releases/latest/
--- 2. Unzip it and make it executable.
--- ```bash
--- unzip elixir-ls.zip -d /path/to/elixir-ls
--- # Unix
--- chmod +x /path/to/elixir-ls/language_server.sh
--- ```
---
--- **By default, elixir-ls doesn't 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 your unzipped elixir-ls.
---
--- ```lua
--- vim.lsp.config('elixirls', {
--- -- Unix
--- cmd = { "/path/to/elixir-ls/language_server.sh" };
--- -- Windows
--- cmd = { "/path/to/elixir-ls/language_server.bat" };
--- ...
--- })
--- ```
---
--- 'root_dir' is chosen like this: if two or more directories containing `mix.exs` were found when searching directories upward, the second one (higher up) is chosen, with the assumption that it is the root of an umbrella app. Otherwise the directory containing the single mix.exs that was found is chosen.
+--- https://github.com/elixir-lsp/elixir-ls
+---
+--- `elixir-ls` can be installed by following the instructions [here](https://github.com/elixir-lsp/elixir-ls#building-and-running).
+---
+--- 1. Download the zip from https://github.com/elixir-lsp/elixir-ls/releases/latest/
+--- 2. Unzip it and make it executable.
+--- ```bash
+--- unzip elixir-ls.zip -d /path/to/elixir-ls
+--- # Unix
+--- chmod +x /path/to/elixir-ls/language_server.sh
+--- ```
+---
+--- **By default, elixir-ls doesn't 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 your unzipped elixir-ls.
+---
+--- ```lua
+--- vim.lsp.config('elixirls', {
+--- -- Unix
+--- cmd = { "/path/to/elixir-ls/language_server.sh" };
+--- -- Windows
+--- cmd = { "/path/to/elixir-ls/language_server.bat" };
+--- ...
+--- })
+--- ```
+---
+--- 'root_dir' is chosen like this: if two or more directories containing `mix.exs` were found when searching directories upward, the second one (higher up) is chosen, with the assumption that it is the root of an umbrella app. Otherwise the directory containing the single mix.exs that was found is chosen.
return {
filetypes = { 'elixir', 'eelixir', 'heex', 'surface' },
root_dir = function(bufnr, on_dir)