neotest-elixir

Neotest adapter for Elixir

Installation

Using packer:

use({
  "nvim-neotest/neotest",
  requires = {
    ...,
    "jfpedroza/neotest-elixir",
  }
  config = function()
    require("neotest").setup({
      ...,
      adapters = {
        require("neotest-elixir"),
      }
    })
  end
})

Configuration

You can optionally specify some settings:

require("neotest").setup({
  adapters = {
    require("neotest-elixir")({
      -- The Mix task to use to run the tests
      -- Can be a function to return a dynamic value.
      -- Default: "test"
      mix_task = {"my_custom_task"},
      -- Other formatters to pass to the test command as the formatters are overridden
      -- Can be a function to return a dynamic value.
      -- Default: {"ExUnit.CLIFormatter"}
      extra_formatters = {"ExUnit.CLIFormatter", "ExUnitNotifier"},
      -- Extra test block identifiers
      -- Can be a function to return a dynamic value.
      -- Block identifiers "test", "feature" and "property" are always supported by default.
      -- Default: {}
      extra_block_identifiers = {"test_with_mock"},
      -- Extra arguments to pass to mix test
      -- Can be a function that receives the position, to return a dynamic value
      -- Default: {}
      args = {"--trace"},
      -- Command wrapper
      -- Must be a function that receives the mix command as a table, to return a dynamic value
      -- Default: function(cmd) return cmd end
      post_process_command = function(cmd)
        return vim.iter({{"env", "FOO=bar"}, cmd}):flatten():totable()
      end,
      -- Delays writes so that results are updated at most every given milliseconds
      -- Decreasing this number improves snappiness at the cost of performance
      -- Can be a function to return a dynamic value.
      -- Default: 1000
      write_delay = 1000,
      -- The pattern to match test files
      -- Default: "_test.exs$"
      test_file_pattern = ".test.exs$",
      -- Function to determine whether a directory should be ignored
      -- By default includes root test directory and umbrella apps' test directories
      -- Params:
      -- - name (string) - Name of directory
      -- - rel_path (string) - Path to directory, relative to root
      -- - root (string) - Root directory of project
      filter_dir = function(name, rel_path, root)
        return rel_path == "test"
            or rel_path == "lib"
            or vim.startswith(rel_path, 'test/')
            or vim.startswith(rel_path, 'lib/')
      end,
    }),
  }
})

extra_args are also supported, so you can use them to specify other arguments to mix test:

require("neotest").run.run({vim.fn.expand("%"), extra_args = {"--formatter", "ExUnitNotifier", "--timeout", "60"}}))

Integration with Elixir watchers

The adapter supports mix_test_interactive to watch and run tests. Simply set mix_task to test.interactive.

Caveats: When you save a file, there won't be any indicator that the tests are running again.

TODO

• Add integration with mix-test.watch

Development

In tests/sample_proj there is an Elixir project with to test that the adapter works