elixir-tools.nvim provides a nice experience for writing Elixir applications with Neovim.
Note This plugin does not provide autocompletion, I recommend using nvim-cmp.
Note This plugin does not provide syntax highlighting, I recommend using nvim-treesitter.
- Next LS installation and configuration.
- Credo Language Server installation and configuration.
- ElixirLS installation and configuration.
:Mixcommand with autocomplete- vim-projectionist support
Requires 0.8
{
"elixir-tools/elixir-tools.nvim",
version = "*",
event = { "BufReadPre", "BufNewFile" },
config = function()
local elixir = require("elixir")
local elixirls = require("elixir.elixirls")
elixir.setup {
nextls = {enable = true},
credo = {},
elixirls = {
enable = true,
settings = elixirls.settings {
dialyzerEnabled = false,
enableTestLenses = false,
},
on_attach = function(client, bufnr)
vim.keymap.set("n", "<space>fp", ":ElixirFromPipe<cr>", { buffer = true, noremap = true })
vim.keymap.set("n", "<space>tp", ":ElixirToPipe<cr>", { buffer = true, noremap = true })
vim.keymap.set("v", "<space>em", ":ElixirExpandMacro<cr>", { buffer = true, noremap = true })
end,
}
}
end,
dependencies = {
"nvim-lua/plenary.nvim",
},
}use({ "elixir-tools/elixir-tools.nvim", tag = "stable", requires = { "nvim-lua/plenary.nvim" }})The minimal setup will configure both ElixirLS and credo-language-server.
require("elixir").setup()NextLS, ElixirLS, and credo-language-server can be enabled/disabled by setting the enable flag in the respective options table.
The defaults are shown below.
require("elixir").setup({
nextls = {enable = false},
credo = {enable = true},
elixirls = {enable = true},
})While the plugin works with a minimal setup, it is much more useful if you add some personal configuration.
Note For ElixirLS, not specifying the
repo,branch, ortagoptions will default to the latest release.
local elixir = require("elixir")
local elixirls = require("elixir.elixirls")
elixir.setup {
nextls = {
enable = false, -- defaults to false
port = 9000, -- connect via TCP with the given port. mutually exclusive with `cmd`. defaults to nil
cmd = "path/to/next-ls", -- path to the executable. mutually exclusive with `port`
version = "0.5.0", -- version of Next LS to install and use. defaults to the latest version
on_attach = function(client, bufnr)
-- custom keybinds
end
},
credo = {
enable = true, -- defaults to true
port = 9000, -- connect via TCP with the given port. mutually exclusive with `cmd`. defaults to nil
cmd = "path/to/credo-language-server", -- path to the executable. mutually exclusive with `port`
version = "0.1.0-rc.3", -- version of credo-language-server to install and use. defaults to the latest release
on_attach = function(client, bufnr)
-- custom keybinds
end
},
elixirls = {
-- specify a repository and branch
repo = "mhanberg/elixir-ls", -- defaults to elixir-lsp/elixir-ls
branch = "mh/all-workspace-symbols", -- defaults to nil, just checkouts out the default branch, mutually exclusive with the `tag` option
tag = "v0.14.6", -- defaults to nil, mutually exclusive with the `branch` option
-- alternatively, point to an existing elixir-ls installation (optional)
-- not currently supported by elixirls, but can be a table if you wish to pass other args `{"path/to/elixirls", "--foo"}`
cmd = "/usr/local/bin/elixir-ls.sh",
-- default settings, use the `settings` function to override settings
settings = elixirls.settings {
dialyzerEnabled = true,
fetchDeps = false,
enableTestLenses = false,
suggestSpecs = false,
},
on_attach = function(client, bufnr)
vim.keymap.set("n", "<space>fp", ":ElixirFromPipe<cr>", { buffer = true, noremap = true })
vim.keymap.set("n", "<space>tp", ":ElixirToPipe<cr>", { buffer = true, noremap = true })
vim.keymap.set("v", "<space>em", ":ElixirExpandMacro<cr>", { buffer = true, noremap = true })
end
}
}Note Next LS is disabled by default. Once it reaches feature parity with ElixirLS, it will switch to enabled by default.
Note Next LS integration utilizes
Mix.install/2, so you must be running Elixir >= 1.12
Note Next LS creates a
.elixir-toolsdirectory in your project root. You'll want to add that to your gitignore.
The language server for Elixir that just works. 😎
You can read more about it at https://www.elixir-tools.dev/next-ls.
Note Credo Language Server integration utilizes
Mix.install/2, so you must be running Elixir >= 1.12
Note Credo Language Server creates a
.elixir-toolsdirectory in your project root. You'll want to add that to your gitignore.
- Uses your project's Credo version.
- Full project diagnostics
- Code Actions
When a compatible installation of ElixirLS is not found, you will be prompted to install it. The plugin will download the source code to the .elixir_ls directory and compile it using the Elixir and OTP versions used by your current project.
Caveat: This assumes you are developing your project locally (outside of something like Docker) and they will be available.
Caveat: This currently downloads the language server into the .elixir_ls directory in your repository, but it does install it into ~/.cache and will re-use it when needed.
elixir-tools.nvim should be able to properly set the root directory for umbrella and non-umbrella apps. The nvim-lspconfig project's root detection doesn't properly account for umbrella projects.
ElixirLS provides a codelens to identify and run your tests. If you configure enableTestLenses = true in the settings table, you will see the codelens as virtual text in your editor and can run them with vim.lsp.codelens.run().
:ElixirFromPipe
: Convert pipe operator to nested expressions.
:ElixirToPipe
: Convert nested expressions to the pipe operator.
:[range]ElixirExpandMacro
: For the given [range], expand any macros and display it in a floating window.
:ElixirRestart
: Restart ElixirLS, you must then reconnect your buffer with :edit.
:ElixirOutputPanel
: Open the output panel that displays logs and compiler information from the server.
require("elixir.elixirls").open_output_panel()
require("elixir.elixirls").open_output_panel({ window = "split" })
require("elixir.elixirls").open_output_panel({ window = "vsplit" })
require("elixir.elixirls").open_output_panel({ window = "float" })You can run any mix command in your project, complete with... autocomplete!
:Mix {args}
: Run any mix command.
vim-projectionist integration!
:Esource {args}
: Create or edit a regular source module.
```vim
Esource my_app/accounts/team
```
:Etest {args}
: Create or edit a regular test module.
```vim
Etest my_app/accounts/team
```
:Etask {args}
: Create or edit a Mix task module.
```vim
Etask server.start
```
:Econtroller {args}
: Create or edit a Phoenix controller module.
```vim
Econtroller my_project_web/users
```
:Eview {args}
: Create or edit a Phoenix view module.
```vim
Eview my_project_web/users
```
:Ehtml {args}
: Create or edit a Phoenix HTML module.
```vim
Ehtml my_project_web/users
```
:Ejson {args}
: Create or edit a Phoenix JSON module.
```vim
Ejson my_project_web/users
```
:Ecomponent {args}
: Create or edit a Phoenix.Component module.
```vim
Ecomponent my_project_web/users
```
:Eliveview {args}
: Create or edit a Phoenix.LiveView module.
```vim
Eliveview my_project_web/users
```
:Elivecomponent {args}
: Create or edit a Phoenix.LiveComponent module.
```vim
Elivecomponent my_project_web/users
```
:Echannel {args}
: Create or edit a Phoenix channel module.
:Efeature {args}
: Create or edit a Wallaby test module.