:lang elixir

Erlang done right

1. Description

This module provides support for Elixir programming language via alchemist.el or elixir-ls.

1.1. Maintainers

This module has no dedicated maintainers. Become a maintainer?

1.2. Module flags

+lsp
Enable LSP support for elixir-mode. Requires :tools lsp and a langserver (supports elixir-ls).

1.4. Hacks

No hacks documented for this module.

2. Prerequisites

Elixir is required and can be acquired through most OS’s package managers, or through a version management tool such as asdf.

If you want to add support for LSP, be sure to install elixir-ls and enable :tools lsp in your init.el.

To support linting with credo, add :checkers syntax to your init.el.

2.1. Install Elixir

See https://elixir-lang.org/install.html for operating systems not listed here.

2.1.1. With asdf

# ⎘
$ asdf plugin-add elixir
$ asdf install elixir 1.9.1

2.1.2. Arch Linux

# ⎘
$ pacman -S elixir

2.1.3. Gentoo Linux

# ⎘
$ emerge -v dev-lang/elixir

2.1.4. openSUSE

# ⎘
$ zypper install elixir

3. Usage

This module’s usage documentation is incomplete. Complete it?

3.1. Commands

3.1.1. exunit-mode

The exunit-mode prefix is SPC m t. Here is some examples:

command keybind description
exunit-verify-all SPC m t a Runs exunit on all files
exunit-rerun SPC m t r Re-runs last exunit command
exunit-verify SPC m t v Runs exunit on current file
exunit-verify-single SPC m t s Runs exunit for the item on cursor
exunit-toggle-file-and-test SPC m t t Switch between implementation and test
exunit-toggle-file-and-test-other-window SPC m t T Switch between implementation and test in other window

4. TODO Configuration

This module has no configuration documentation yet. Write some?

5. Troubleshooting

There are no known problems with this module. Report one?

6. TODO Appendix

This module has no appendix yet. Write one?