inf-elixir

This is a package to allow you to pop open and interact with Elixir REPL (IEx, presently).

Features

• Run IEx normally (inf-elixir)
• Run IEx in a project setting (inf-elixir-project)
• Ability to send commands to the inf buffer from a code file (inf-elixir-send-line, inf-elixir-send-region, inf-elixir-send-buffer)

Work in progress

• Completion candidates provided by Eglot works, but is a bit slow for "live" auto-completion via Corfu (fine for TAB-completion though). Doesn't insert whole snippets.
• Completion directly by IEx, without language server.

TODO

• Got a feature you want to see? Open an issue! 😄

Installation

inf-elixir is proudly distributed by MELPA and MELPA Stable. I would also strongly encourage folks to use MELPA Stable, as the releases there will be more, well, stable. In order to install the package, follow the Getting Started instructions on the MELPA website or the Getting Started instructions on the MELPA Stable website.

Once your installation is configured to use MELPA, inf-elixir can be installed with M-x package-install RET inf-elixir RET.

use-package can be used to install and/or configure inf-elixir:

(use-package inf-elixir
  :bind (("C-c i i" . 'inf-elixir)
         ("C-c i p" . 'inf-elixir-project)
         ("C-c i l" . 'inf-elixir-send-line)
         ("C-c i r" . 'inf-elixir-send-region)
         ("C-c i b" . 'inf-elixir-send-buffer)
         ("C-c i R" . 'inf-elixir-reload-module)))

Or with Doom Emacs:

packages.el

(package! inf-elixir)

config.el

(map! :after elixir-mode
        :localleader
        :map elixir-mode-map
        :prefix ("i" . "inf-elixir")
        "i" 'inf-elixir
        "p" 'inf-elixir-project
        "l" 'inf-elixir-send-line
        "r" 'inf-elixir-send-region
        "b" 'inf-elixir-send-buffer
        "R" 'inf-elixir-reload-module)

Keybindings

inf-elixir intentionally ships with no keybindings by default. This grants the user the freedom to specify whatever keybindings they would like. Functions that users would probably have an interest in binding are:

• inf-elixir :: Starts an IEx shell in a new buffer, or switches to an existing IEx shell buffer.
• inf-elixir-project :: Starts an IEx shell in the context of the project (by default by passing the -S mix argument to iex), or switches to an existing IEx shell buffer.
• inf-elixir-send-line :: Send the current line to the IEx shell buffer as input.
• inf-elixir-send-region :: Send the selected region to the IEx shell buffer as input.
• inf-elixir-send-buffer :: Send the entire current buffer to the IEx shell as input.
• inf-elixir-reload-module :: Reload modules from current buffer using IEx.Helpers.r/1.

An example of keybindings is included in the use-package declaration above.

Completion (WIP)

Completion works with the Completions buffer, Consult and Corfu.

1. inf-elixir can offer completions directly in the REPL buffer. By default it asks Eglot (when available and connected to a project).

2. WIP: To ask the running IEx process for completions, set the custom variable inf-elixir-completion-provider to iex (or to nil to disable completion integration entirely).

Development

I am not yet using any kind of build tool (like Eldev or Cask) to develop this plugin. Generally speaking, working with the code involves:

1. Clone the git repository
2. Make some changes
3. Load your changes with M-x load-file RET inf-elixir.el RET
4. Verify your changes worked
5. Send a PR 🙏

There are some tests written with ERT that can be run with this command:

$ emacs -batch -l ert -l inf-elixir.el -l tests/inf-elixir-test.el -f ert-run-tests-batch-and-exit