Merge branch 'mikavilpas-add-types-for-keymaps'

Author: andrewferrier

lua/debugprint/init.lua

@@ -213,8 +213,8 @@ M.debugprint_regular = function(opts)
     return "g@l"
 end
 
----@param opts DebugprintFunctionOptions
----@return nil
+---@param opts? DebugprintFunctionOptions
+---@return string | nil
 M.debugprint = function(opts)
     local func_opts =
         require("debugprint.options").get_and_validate_function_opts(opts)

lua/debugprint/options.lua

@@ -162,7 +162,7 @@ M.get_and_validate_global_opts = function(opts)
     return global_opts
 end
 
----@param opts DebugprintFunctionOptions
+---@param opts? DebugprintFunctionOptions
 ---@return DebugprintFunctionOptions
 M.get_and_validate_function_opts = function(opts)
     local func_opts = vim.tbl_deep_extend(

lua/debugprint/types.lua

@@ -10,8 +10,8 @@
 ---@field find_treesitter_variable? function
 
 ---@class DebugprintGlobalOptions
----@field keymaps? table
----@field commands? table
+---@field keymaps? DebugprintKeymapOptions
+---@field commands? DebugprintCommandOptions
 ---@field display_counter? boolean
 ---@field display_location? boolean
 ---@field display_snippet? boolean
@@ -23,6 +23,30 @@
 ---@field create_commands? boolean
 ---@field ignore_treesitter? boolean
 
+---@class DebugprintKeymapOptions
+---@field normal? DebugprintKeymapNormalOptions
+---@field visual? DebugprintKeymapVisualOptions
+
+---@class DebugprintKeymapNormalOptions
+---@field plain_below? string
+---@field plain_above? string
+---@field variable_below? string
+---@field variable_above? string
+---@field variable_below_alwaysprompt? string
+---@field variable_above_alwaysprompt? string
+---@field textobj_below? string
+---@field textobj_above? string
+---@field delete_debug_prints? string
+---@field toggle_comment_debug_prints? string
+
+---@class DebugprintKeymapVisualOptions
+---@field variable_below? string
+---@field variable_above? string
+
+---@class DebugprintCommandOptions
+---@field delete_debug_prints? string
+---@field toggle_comment_debug_prints? string
+
 ---@class DebugprintFunctionOptions
 ---@field above boolean
 ---@field variable boolean

tests/debugprint.lua

@@ -170,7 +170,11 @@ end)
 
 describe("can do basic debug statement insertion (custom keys)", function()
     before_each(function()
-        debugprint.setup({ keymaps = { normal = { plain_below = "zdp" } } })
+        debugprint.setup({
+            keymaps = {
+                normal = { plain_below = "zdp" },
+            },
+        })
     end)
 
     after_each(teardown)
@@ -971,7 +975,9 @@ describe("can handle treesitter identifiers", function()
 
     it("always prompt below", function()
         debugprint.setup({
-            keymaps = { normal = { variable_below_alwaysprompt = "zxa" } },
+            keymaps = {
+                normal = { variable_below_alwaysprompt = "zxa" },
+            },
         })
 
         local filename = init_file({