feat: Support variable insertion - closes #1

Author: Andrew Ferrier

lua/debugprint/init.lua

@@ -5,68 +5,104 @@ local opts
 OPTION_DEFAULTS = {
     create_keymaps = true,
     filetypes = {
-        ["lua"] = { "print('", "')" },
-        ["vim"] = { 'echo "', '"' },
+        ["lua"] = {
+            left = "print('",
+            right = "')",
+            mid_var = "' .. vim.inspect(",
+            right_var = "))",
+        },
+        ["vim"] = {
+            left = 'echo "',
+            right = '"',
+            mid_var = '" .. ',
+            right_var = "",
+        },
     },
 }
 
 local counter = 0
 
-local debuginfo = function()
+local debuginfo = function(variable_name)
     local current_line = vim.api.nvim_win_get_cursor(0)[1]
     counter = counter + 1
 
-    return "DEBUG: "
+    local line = "DEBUG: "
         .. vim.fn.expand("%:t")
         .. ":"
         .. current_line
         .. " ["
         .. counter
         .. "]"
+
+    if variable_name ~= nil then
+        line = line .. ": " .. variable_name .. "="
+    end
+
+    return line
 end
 
 local get_fix = function(filetype)
     if vim.tbl_contains(vim.tbl_keys(opts.filetypes), filetype) then
-        return opts.filetypes[filetype][1], opts.filetypes[filetype][2]
+        return opts.filetypes[filetype]
     else
         vim.notify(
             "Don't have debugprint configuration for filetype " .. filetype,
             vim.log.levels.WARN
         )
-        return nil, nil
+        return nil
     end
 end
 
-M.debugprint = function(above)
+M.debugprint = function(o)
+    local funcopts = vim.tbl_deep_extend(
+        "force",
+        { above = false, variable = false },
+        o or {}
+    )
+
+    vim.validate({
+        above = { funcopts.above, "boolean" },
+    })
+
     local current_line = vim.api.nvim_win_get_cursor(0)[1]
     local filetype = vim.api.nvim_get_option_value("filetype", {})
     local indent = string.rep(" ", vim.fn.indent(current_line))
-    local prefix, postfix = get_fix(filetype)
+    local fixes = get_fix(filetype)
 
-    if prefix == nil or postfix == nil then
+    if fixes == nil then
         return
+    end
+
+    local line_to_insert
+    local line_to_insert_on
+
+    if funcopts.variable then
+        local variable_name = vim.fn.input("Variable name: ")
+
+        line_to_insert = indent
+            .. fixes.left
+            .. debuginfo(variable_name)
+            .. fixes.mid_var
+            .. variable_name
+            .. fixes.right_var
     else
-        local line_to_insert = indent .. prefix .. debuginfo() .. postfix
-
-        local line_to_insert_on
-
-        if above then
-            line_to_insert_on = current_line - 1
-        else
-            line_to_insert_on = current_line
-        end
-
-        vim.api.nvim_buf_set_lines(
-            0,
-            line_to_insert_on,
-            line_to_insert_on,
-            true,
-            { line_to_insert }
-        )
+        line_to_insert = indent .. fixes.left .. debuginfo() .. fixes.right
     end
-end
 
-M.debugprintvar = function(above) end
+    if funcopts.above then
+        line_to_insert_on = current_line - 1
+    else
+        line_to_insert_on = current_line
+    end
+
+    vim.api.nvim_buf_set_lines(
+        0,
+        line_to_insert_on,
+        line_to_insert_on,
+        true,
+        { line_to_insert }
+    )
+end
 
 M.setup = function(o)
     opts = vim.tbl_deep_extend("force", OPTION_DEFAULTS, o or {})
@@ -77,16 +113,16 @@ M.setup = function(o)
 
     if opts.create_keymaps then
         vim.keymap.set("n", "dqp", function()
-            M.debugprint(false)
+            M.debugprint()
         end)
         vim.keymap.set("n", "dqP", function()
-            M.debugprint(true)
+            M.debugprint({ above = true })
         end)
         vim.keymap.set("n", "dQp", function()
-            M.debugprintvar(false)
+            M.debugprint({ variable = true })
         end)
         vim.keymap.set("n", "dQP", function()
-            M.debugprintvar(true)
+            M.debugprint({ above = true, variable = true })
         end)
     end
 

tests/debugprint.lua

@@ -107,6 +107,46 @@ describe("can do basic debug statement insertion", function()
     end)
 end)
 
+describe("can do variable debug statement insertion", function()
+    before_each(function()
+        debugprint.setup()
+    end)
+
+    it("can insert a variable statement below", function()
+        set_lines({
+            "foo",
+            "bar",
+        })
+
+        local filename = write_file("lua")
+        vim.api.nvim_win_set_cursor(0, { 1, 0 })
+        feedkeys("dQpbanana<CR>")
+
+        check_lines({
+            "foo",
+            "print('DEBUG: " .. filename .. ":1 [1]: banana=' .. vim.inspect(banana))",
+            "bar",
+        })
+    end)
+
+    it("can insert a variable statement above", function()
+        set_lines({
+            "foo",
+            "bar",
+        })
+
+        local filename = write_file("lua")
+        vim.api.nvim_win_set_cursor(0, { 1, 0 })
+        feedkeys("dQPbanana<CR>")
+
+        check_lines({
+            "print('DEBUG: " .. filename .. ":1 [1]: banana=' .. vim.inspect(banana))",
+            "foo",
+            "bar",
+        })
+    end)
+end)
+
 describe("can do various file types", function()
     before_each(function()
         debugprint.setup()
@@ -129,6 +169,23 @@ describe("can do various file types", function()
         })
     end)
 
+    it("can handle a .vim file variable", function()
+        set_lines({
+            "foo",
+            "bar",
+        })
+
+        local filename = write_file("vim")
+        vim.api.nvim_win_set_cursor(0, { 1, 0 })
+        feedkeys("dQpbanana<CR>")
+
+        check_lines({
+            "foo",
+            'echo "DEBUG: ' .. filename .. ':1 [1]: banana=" .. banana',
+            "bar",
+        })
+    end)
+
     it("can gracefully handle unknown filetypes", function()
         set_lines({
             "foo",