A set of elixir extensions and configuration for neovim!

As mona doesn't use any fancy LSP shenanigans, it is blindingly fast (thanks to ripgrep!) but may prove to be naive in implementation

We rely on regular expressions and conventions in order to work things out - if you consider using mona, please report any inconsistencies!

• Browse project, application and current buffer directory modules and tests using telescope!

• Requires ripgrep

• Using lazy.nvim

return {
  'michael-a-grammar/mona.nvim',

  dependencies = {
    'nvim-lua/plenary.nvim',
    'nvim-telescope/telescope.nvim',
  },
}

• Create a elixir filetype plugin where your neovim configuration resides (typically ~/.config/nvim/) if one doesn't already exist

if [ ! -f ~/.config/nvim/after/ftplugin/elixir.lua ]; then
    mkdir -p ~/.config/nvim/after/ftplugin/
    touch ~/.config/nvim/after/ftplugin/elixir.lua
fi

• Add the following keymap to the above file to bind searching for elixir modules within your current project

local mona = require('telescope').extensions.mona
local bufnr = vim.api.nvim_get_current_buf()

vim.keymap.set({ 'n', 'x' }, '<leader>mp', mona.elixir_project_modules, {
  desc = 'Project Modules',
  buffer = bufnr, -- exclude setting this key if not defining the keymap within the `elixir` filetype plugin
  noremap = true,
})

• You can also call the telescope picker via the following vim command - :Telescope mona elixir_project_modules

local telescope = require('telescope')

telescope.load_extension('mona')

mona exposes the following telescope pickers as well as the elixir_project_modules picker shown in the example above

They each rely on convention to find relevant results, disclosed below

To discern the root, project directory:

• From the current working directory, we attempt to find a .git directory by searching upwards through the directory tree

• We relay an error message if a .git directory cannot be found

• Within the directory that the .git directory is found, we check for the existence of a mix.exs file

• From here, a simple ripgrep query is launched to populate a telescope picker with every descendant .ex file that contains one or more module definitions

To discern the application directory:

• From the current buffer directory, we attempt to find a mix.exs file by searching upwards through the directory tree

• We relay an error message if a mix.exs file cannot be found or if the found mix.exs file is the project-level one

• From here, a simple ripgrep query is launched to populate a telescope picker with every descendant .ex file that contains one or more module definitions

From the current buffer directory, a simple ripgrep query is launched to populate a telescope picker with every descendant .ex file that contains one or more module definitions

There are also equivalents to each of the above available specifically for tests

These work in much the same way except each ripgrep query is configured to find descendant .exs files that contain one or more module definitions suffixed with test

• elixir_project_tests
• elixir_application_tests
• elixir_buffer_directory_tests

• Improved module navigation

Projects that have either inspired or helped with the development of mona

• elixir-tools.nvim
• nvim-plugin-template
• neogit

mona is also a part of my personal neovim setup, vamp 🎷