Repository files navigation

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

• 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)

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

inf-elixir is proudly distributed byMELPA andMELPA 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, followthe Getting Started instructions on the MELPA website orthe Getting Started instructions on the MELPA Stable website.

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

use-package can be used to install and/or configureinf-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)))

(package! inf-elixir)

(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)

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 toiex), 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 usingIEx.Helpers.r/1.

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

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

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

There are some tests written withERT 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