feat(keymaps): add descriptions (WIP) (#164)

Author: igorlfs

lua/dap-view/console/keymaps.lua

@@ -10,11 +10,11 @@ M.set_keymaps = function(buf)
 
     keymap(keys.next_session, function()
         require("dap-view").navigate({ count = vim.v.count1, wrap = true, type = "sessions" })
-    end, buf)
+    end, { buf = buf, desc = "go to next session" })
 
     keymap(keys.prev_session, function()
         require("dap-view").navigate({ count = -vim.v.count1, wrap = true, type = "sessions" })
-    end, buf)
+    end, { buf = buf, desc = "go to prev session" })
 end
 
 return M

lua/dap-view/hover/init.lua

@@ -31,11 +31,11 @@ M.set_buf_options = function(bufnr)
     buf.filetype = "dap-view-hover"
 end
 
----@param bufnr integer
-M.set_keymaps = function(bufnr)
+---@param buf integer
+M.set_keymaps = function(buf)
     local keys = setup.config.keymaps.hover
 
-    keymap(keys.quit, "<C-w>q", bufnr)
+    keymap(keys.quit, "<C-w>q", { buf = buf, desc = "close" })
 
     keymap(keys.toggle, function()
         local cursor_line = api.nvim_win_get_cursor(state.hover_winnr)[1]
@@ -44,19 +44,19 @@ M.set_keymaps = function(bufnr)
             if require("dap-view.hover.actions").expand_or_collapse(cursor_line) then
                 require("dap-view.hover.eval").evaluate_expression(state.hover)
 
-                local line, width = unpack(require("dap-view.hover.view").show(bufnr))
+                local line, width = unpack(require("dap-view.hover.view").show(buf))
 
                 api.nvim_win_set_height(state.hover_winnr, line)
                 api.nvim_win_set_width(state.hover_winnr, width)
             end
         end)()
-    end, bufnr)
+    end, { buf = buf, desc = "toggle" })
 
     keymap(keys.jump_to_parent, function()
         local cursor_line = api.nvim_win_get_cursor(state.hover_winnr)[1]
 
         require("dap-view.hover.actions").jump_to_parent(cursor_line)
-    end, bufnr)
+    end, { buf = buf, desc = "jump to parent" })
 
     keymap(keys.set_value, function()
         local cursor_line = api.nvim_win_get_cursor(state.hover_winnr)[1]
@@ -66,13 +66,13 @@ M.set_keymaps = function(bufnr)
                 -- This is a little redundant
                 require("dap-view.hover.eval").evaluate_expression(state.hover)
 
-                local line, width = unpack(require("dap-view.hover.view").show(bufnr))
+                local line, width = unpack(require("dap-view.hover.view").show(buf))
 
                 api.nvim_win_set_height(state.hover_winnr, line)
                 api.nvim_win_set_width(state.hover_winnr, width)
             end
         end)()
-    end, bufnr)
+    end, { buf = buf, desc = "set value" })
 end
 
 ---@param bufnr integer

lua/dap-view/views/keymaps/help.lua

@@ -78,7 +78,7 @@ M.show_help = function()
 
     keymap(setup.config.keymaps.help.quit, function()
         api.nvim_win_close(help_win, true)
-    end, help_buf)
+    end, { buf = help_buf, desc = "close" })
 
     util.set_lines(help_buf, 0, -1, true, content)
 

lua/dap-view/views/keymaps/init.lua

@@ -11,27 +11,27 @@ M.set_keymaps = function(buf)
 
     keymap(keys.next_view, function()
         require("dap-view").navigate({ count = vim.v.count1, wrap = true })
-    end, buf)
+    end, { buf = buf, desc = "go to next view" })
 
     keymap(keys.prev_view, function()
         require("dap-view").navigate({ count = -vim.v.count1, wrap = true })
-    end, buf)
+    end, { buf = buf, desc = "go to prev view" })
 
     keymap(keys.jump_to_last, function()
         require("dap-view").navigate({ count = vim._maxint, wrap = false })
-    end, buf)
+    end, { buf = buf, desc = "jump to last view" })
 
     keymap(keys.jump_to_first, function()
         require("dap-view").navigate({ count = -vim._maxint, wrap = false })
-    end, buf)
+    end, { buf = buf, desc = "jump to first view" })
 
     if not buf then
         require("dap-view.views.keymaps.views").views_keymaps()
     end
 
     keymap(keys.help, function()
         help.show_help()
-    end, buf)
+    end, { buf = buf, desc = "show help" })
 end
 
 return M

lua/dap-view/views/keymaps/util.lua

@@ -4,15 +4,20 @@ local M = {}
 
 ---@param lhs string|string[]
 ---@param rhs string|function
----@param buf? integer
+---@param opts? vim.keymap.set.Opts
 ---@param mode? string|string[]
-function M.keymap(lhs, rhs, buf, mode)
+function M.keymap(lhs, rhs, opts, mode)
     mode = mode or "n"
     if type(lhs) == "string" then
         lhs = { lhs }
     end
+
+    opts = opts or {}
+    opts.nowait = true
+    opts.buf = opts.buf or state.bufnr
+
     for _, v in ipairs(lhs) do
-        vim.keymap.set(mode, v, rhs, { buffer = buf or state.bufnr, nowait = true })
+        vim.keymap.set(mode, v, rhs, opts)
     end
 end