Issue a deprecation warning if busted_command is set

MisanthropicBit · Feb 6, 2025 · 848f684 · 848f684
1 parent 9dc788b
commit 848f684
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/lua/neotest-busted/config.lua b/lua/neotest-busted/config.lua
@@ -105,6 +105,13 @@ end
 function config.configure(user_config)
     _user_config = vim.tbl_deep_extend("keep", user_config or {}, default_config)
 
+    if _user_config.busted_command ~= nil then
+        vim.notify_once(
+            "[neotest-busted]: busted_command is deprecated and will be removed in a future version",
+            vim.log.levels.WARN
+        )
+    end
+
     -- Skip checking the executable when running setup to avoid the error
     -- message as neotest loads all adapters so users will see an error in a
     -- non-lua/neovim directory with a relative path in `busted_command`

diff --git a/tests/config_spec.lua b/tests/config_spec.lua
@@ -71,6 +71,13 @@ describe("config", function()
             assert
                 .stub(vim.notify_once).was
                 .called_with("[neotest-busted]: Invalid config: " .. tostring(error), vim.log.levels.ERROR)
+
+            if invalid_config_test.busted_command ~= nil then
+                assert.stub(vim.notify_once).was.called_with(
+                    "[neotest-busted]: busted_command is deprecated and will be removed in a future version",
+                    vim.log.levels.WARN
+                )
+            end
         end
 
         ---@diagnostic disable-next-line: undefined-field