feat(projectionist): allow disabling the projectionist integration (#221)

fix: nvim test runner breaking changes

fix(projectionist): do not overwrite existing projections

chore(ci): attempt to fix CI nvim url

Author: dkarter

.github/workflows/ci.yml

@@ -42,7 +42,7 @@ jobs:
             manager: sudo apt-get
             packages: -y fd-find esl-erlang elixir
           - os: macos-14
-            url: https://github.com/neovim/neovim/releases/download/nightly/nvim-macos.tar.gz
+            url: https://github.com/neovim/neovim/releases/download/nightly/nvim-macos-x86_64.tar.gz
             manager: brew
             packages: fd elixir
           - os: macos-14
@@ -96,19 +96,19 @@ jobs:
           - os: ubuntu-20.04
             manager: sudo apt-get
             packages: -y fd-find esl-erlang elixir
-            nvim-version: 0.8.3
+            nvim-version: v0.8.3
           - os: ubuntu-20.04
             manager: sudo apt-get
             packages: -y fd-find esl-erlang elixir
-            nvim-version: 0.9.5
+            nvim-version: v0.9.5
           - os: macos-14
             manager: brew
             packages: fd elixir
-            nvim-version: 0.8.3
+            nvim-version: v0.8.3
           - os: macos-14
             manager: brew
             packages: fd elixir
-            nvim-version: 0.9.5
+            nvim-version: v0.9.5
     steps:
       - uses: actions/checkout@v4
       - uses: extractions/setup-just@v2

README.md

@@ -50,6 +50,9 @@ Requires 0.8
           vim.keymap.set("n", "<space>tp", ":ElixirToPipe<cr>", { buffer = true, noremap = true })
           vim.keymap.set("v", "<space>em", ":ElixirExpandMacro<cr>", { buffer = true, noremap = true })
         end,
+      },
+      projectionist = {
+        enable = true
       }
     }
   end,
@@ -75,14 +78,15 @@ The minimal setup will configure both ElixirLS but not Next LS.
 require("elixir").setup()
 ```
 
-Next LS and ElixirLS can be enabled/disabled by setting the `enable` flag in the respective options table.
+Next LS, ElixirLS, and Projectionist can be enabled/disabled by setting the `enable` flag in the respective options table.
 
 The defaults are shown below.
 
 ```lua
 require("elixir").setup({
   nextls = {enable = false},
   elixirls = {enable = true},
+  projectionist = {enable = true},
 })
 ```
 

justfile

@@ -13,7 +13,7 @@ init: deps
   #!/usr/bin/env bash
   nvim-test/bin/nvim-test --init
 
-test nvim_version="0.9.5": init
+test nvim_version="v0.9.5": init
   #!/usr/bin/env bash
   nvim-test/bin/nvim-test --target_version {{nvim_version}} busted --lpath="$PWD/lua/?.lua"
 

lua/elixir/init.lua

@@ -89,6 +89,7 @@ function M.setup(opts)
   opts.elixirls = opts.elixirls or {}
   opts.credo = opts.credo or {}
   opts.nextls = opts.nextls or {}
+  opts.projectionist = opts.projectionist or {}
 
   define_user_command()
 
@@ -107,7 +108,11 @@ function M.setup(opts)
   end
 
   mix.setup()
-  projectionist.setup()
+
+  if enabled(opts.projectionist.enable) then
+    projectionist.setup(opts.projectionist)
+  end
+
   if enabled(opts.elixirls.enable) then
     elixirls.setup(opts.elixirls)
   end

lua/elixir/projectionist/init.lua

@@ -225,7 +225,7 @@ local config = {
 function M.setup()
   local new_heuristics
   if vim.g.projectionist_heuristics then
-    new_heuristics = vim.tbl_extend("force", vim.g.projectionist_heuristics, config)
+    new_heuristics = vim.tbl_deep_extend("keep", vim.g.projectionist_heuristics, config)
   else
     new_heuristics = config
   end

tests/projectionist_spec.lua

@@ -11,6 +11,30 @@ describe("projectionist", function()
 
   after_each(function()
     vim.cmd.cd("../../../")
+    vim.g.projectionist_heuristics = {}
+  end)
+
+  it("does not overwrite existing projections", function()
+    vim.g.projectionist_heuristics = {
+      ["mix.exs"] = {
+        ["lib/*_test.ex"] = {
+          type = "test",
+          alternate = "lib/{}.ex",
+        },
+      },
+    }
+
+    local test_projection_before_setup = vim.g.projectionist_heuristics["mix.exs"]["lib/*_test.ex"]
+
+    require("elixir.projectionist").setup()
+
+    local test_projection_after_setup = vim.g.projectionist_heuristics["mix.exs"]["lib/*_test.ex"]
+
+    -- existing projections not overwritten
+    assert.are.same(test_projection_before_setup, test_projection_after_setup)
+
+    -- new projections added
+    assert.not_nil(vim.g.projectionist_heuristics["mix.exs"]["lib/*.ex"])
   end)
 
   it("Eview", function()