doomemacs/modules/lang/elixir/README.org

:lang elixir

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
  • Install Elixir
    • With asdf
    • Arch Linux
    • Gentoo Linux
    • openSUSE
• Usage
  • exunit-mode
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

Description   unfold

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

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+lsp

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

+tree-sitter

Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.

Packages

• doom-package:elixir-mode
• doom-package:exunit
• doom-package:flycheck-credo if doom-module::checkers syntax

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires Elixir. Install it via your distribution's package manager or a version management tool such as asdf.

To add LSP support, install elixir-ls and enable doom-module::tools lsp.

To support linting with credo, add :checkers syntax to $DOOMDIR/init.el.

Install Elixir

(See https://elixir-lang.org/install.html for other operating systems)

With asdf

asdf plugin-add elixir
asdf install elixir 1.9.1

Arch Linux

pacman -S elixir

Gentoo Linux

emerge -v dev-lang/elixir

openSUSE

zypper install elixir

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

• Code completion (doom-module::completion company)
• Documentation lookup (doom-module::tools lookup)
• Mix integration
• Phoenix support
• iex integration (doom-module::tools eval)
• Syntax checking (doom-module::checkers syntax, using doom-package:flycheck-credo)
• Formatting for elixir files provided by doom-module::editor format.

exunit-mode

The exunit-mode prefix is <localleader> t. Here is some examples:

command	key / ex command	description
exunit-verify-all	<localleader> t a	Runs exunit on all files
exunit-rerun	<localleader> t r	Re-runs last exunit command
exunit-verify	<localleader> t v	Runs exunit on current file
exunit-verify-single	<localleader> t s	Runs exunit for the item on cursor
exunit-toggle-file-and-test	<localleader> t t	Switch between implementation and test
exunit-toggle-file-and-test-other-window	<localleader> t T	Switch between implementation and test in other window

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

Troubleshooting

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

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?