History

Henrik Lissner 1f8bf7accb merge: rewrite-docs I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.		2022-08-03 03:27:50 +02:00
..
config.el	refactor(:lang): move tree-sitter init	2022-07-25 17:34:44 +02:00
doctor.el	docs(tree-sitter): add doc checks for langs	2022-06-17 20:08:42 +01:00
packages.el	bump: :lang	2022-03-31 21:09:38 +02:00
README.org	fix(docs): set mode in file-local vars	2022-08-03 02:46:33 +02:00

README.org

:lang elixir

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
- Install Elixir
Usage
- exunit-mode
Configuration
Troubleshooting
Frequently asked questions
Appendix

Description unfold

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

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+lsp: Enable LSP support for elixir-mode. Requires :tools lsp and a langserver (supports elixir-ls).
+tree-sitter: Leverages tree-sitter for better syntax highlighting and structural text editing. Requires :tools tree-sitter.

Packages

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 :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 (:completion company)
Documentation lookup (:tools lookup)
Mix integration
Phoenix support
iex integration (:tools eval)
Syntax checking (:checkers syntax, using flycheck-credo)

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?