feat: Keybinding: delete_debug_lines - closes #87

Author: andrewferrier

README.md

@@ -143,6 +143,7 @@ return {
                 variable_above_alwaysprompt = nil,
                 textobj_below = "g?o",
                 textobj_above = "g?O",
+                delete_debug_prints = nil,
             },
             visual = {
                 variable_below = "g?v",

lua/debugprint/init.lua

@@ -233,107 +233,97 @@ M.deleteprints = function(opts)
     end
 end
 
-local map_key = function(mode, lhs, rhs, desc)
+local map_key = function(mode, lhs, opts)
     if lhs ~= nil then
-        if type(rhs) == "function" then
-            vim.api.nvim_set_keymap(
-                mode,
-                lhs,
-                "",
-                { expr = true, desc = desc, callback = rhs }
-            )
-        else
-            vim.api.nvim_set_keymap(mode, lhs, "", {
-                expr = true,
-                desc = desc,
-                callback = function()
-                    return M.debugprint(rhs)
-                end,
-            })
-        end
+        opts = vim.tbl_extend("force", { expr = true }, opts)
+
+        vim.api.nvim_set_keymap(mode, lhs, "", opts)
     end
 end
 
 M.setup = function(opts)
     global_opts =
         require("debugprint.options").get_and_validate_global_opts(opts)
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.plain_below,
-        {},
-        "Plain debug below current line"
-    )
+    map_key("n", global_opts.keymaps.normal.plain_below, {
+        callback = function()
+            return M.debugprint({})
+        end,
+        desc = "Plain debug below current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.plain_above,
-        { above = true },
-        "Plain debug below current line"
-    )
+    map_key("n", global_opts.keymaps.normal.plain_above, {
+        callback = function()
+            return M.debugprint({ above = true })
+        end,
+        desc = "Plain debug below current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.variable_below,
-        { variable = true },
-        "Variable debug below current line"
-    )
+    map_key("n", global_opts.keymaps.normal.variable_below, {
+        callback = function()
+            return M.debugprint({ variable = true })
+        end,
+        desc = "Variable debug below current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.variable_above,
-        { above = true, variable = true },
-        "Variable debug above current line"
-    )
+    map_key("n", global_opts.keymaps.normal.variable_above, {
+        callback = function()
+            return M.debugprint({ above = true, variable = true })
+        end,
+        desc = "Variable debug above current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.variable_below_alwaysprompt,
-        { variable = true, ignore_treesitter = true },
-        "Variable debug below current line (always prompt)"
-    )
+    map_key("n", global_opts.keymaps.normal.variable_below_alwaysprompt, {
+        callback = function()
+            return M.debugprint({ variable = true, ignore_treesitter = true })
+        end,
+        desc = "Variable debug below current line (always prompt})",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.variable_above_alwaysprompt,
-        { above = true, variable = true, ignore_treesitter = true },
-        "Variable debug above current line (always prompt)"
-    )
+    map_key("n", global_opts.keymaps.normal.variable_above_alwaysprompt, {
+        callback = function()
+            return M.debugprint({
+                above = true,
+                variable = true,
+                ignore_treesitter = true,
+            })
+        end,
+        desc = "Variable debug above current line (always prompt})",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.textobj_below,
-        { motion = true },
-        "Text-obj-selected variable debug below current line"
-    )
+    map_key("n", global_opts.keymaps.normal.textobj_below, {
+        callback = function()
+            return M.debugprint({ motion = true })
+        end,
+        desc = "Text-obj-selected variable debug below current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.textobj_above,
-        { motion = true, above = true },
-        "Text-obj-selected variable debug above current line"
-    )
+    map_key("n", global_opts.keymaps.normal.textobj_above, {
+        callback = function()
+            return M.debugprint({ motion = true, above = true })
+        end,
+        desc = "Text-obj-selected variable debug above current line",
+    })
 
-    map_key(
-        "n",
-        global_opts.keymaps.normal.delete_debug_prints,
-        M.deleteprints,
-        "Delete all debugprint statements in the current buffer"
-    )
+    map_key("n", global_opts.keymaps.normal.delete_debug_prints, {
+        callback = M.deleteprints,
+        desc = "Delete all debugprint statements in the current buffer",
+        expr = false,
+    })
 
-    map_key(
-        "x",
-        global_opts.keymaps.visual.variable_below,
-        { variable = true },
-        "Variable debug below current line"
-    )
+    map_key("x", global_opts.keymaps.visual.variable_below, {
+        callback = function()
+            return M.debugprint({ variable = true })
+        end,
+        desc = "Variable debug below current line",
+    })
 
-    map_key(
-        "x",
-        global_opts.keymaps.visual.variable_above,
-        { above = true, variable = true },
-        "Variable debug above current line"
-    )
+    map_key("x", global_opts.keymaps.visual.variable_above, {
+        callback = function()
+            return M.debugprint({ above = true, variable = true })
+        end,
+        desc = "Variable debug above current line",
+    })
 
     if global_opts.commands.delete_debug_prints then
         vim.api.nvim_create_user_command(

lua/debugprint/options.lua

@@ -11,6 +11,7 @@ local GLOBAL_OPTION_DEFAULTS = {
             variable_above_alwaysprompt = nil,
             textobj_below = "g?o",
             textobj_above = "g?O",
+            delete_debug_prints = nil,
         },
         visual = {
             variable_below = "g?v",
@@ -70,6 +71,7 @@ local validate_global_opts = function(o)
         },
         textobj_below = { normal.textobj_below, STRING_NIL },
         textobj_above = { normal.textobj_above, STRING_NIL },
+        delete_debug_prints = { normal.delete_debug_prints, STRING_NIL }
     })
 
     vim.validate({

tests/debugprint.lua

@@ -1381,6 +1381,25 @@ describe("delete lines command", function()
             "end",
         })
     end)
+
+    it("basic - with key binding", function()
+        debugprint.setup({ keymaps = { normal = { delete_debug_prints = "g?x" }}})
+
+        init_file({
+            "function x()",
+            "    local xyz = 3",
+            "end",
+        }, "lua", 2, 1)
+
+        feedkeys("g?p")
+        feedkeys("g?x")
+
+        check_lines({
+            "function x()",
+            "    local xyz = 3",
+            "end",
+        })
+    end)
 end)
 
 describe("don't display counter", function()