feat: configurable keymaps (WIP) (#159)

Author: igorlfs

README.md

@@ -71,7 +71,7 @@ Start a regular debugging session. When desired, you can use `:DapViewOpen` to s
 
 Once you're done debugging, you can close the plugin with `:DapViewClose` and then terminate your session as usual.
 
-There's a lot more you can do: `nvim-dap-view` is highly customizable. To learn all the options, commands, tips and tricks, visit the full documentation on the [website](https://igorlfs.github.io/nvim-dap-view/home).
+There's a lot more you can do: `nvim-dap-view` is highly customizable. To learn all the options, commands, tips and tricks, visit the full documentation on the [website](https://igorlfs.github.io/nvim-dap-view/home) or use the built-in help doc via `:help dap-view.txt`.
 
 ## Contributing
 

doc/dap-view.txt

@@ -146,6 +146,29 @@ You don't have to copy and paste these options. Use them as a reference.
                 hide = {},
             },
         },
+        -- WIP: some keymaps are not overrideable yet!
+        keymaps = {
+            hover = {
+                quit = "q",
+                toggle = { "<CR>", "<2-LeftMouse>" },
+                jump_to_parent = "[[",
+                set_value = "s",
+            },
+            help = {
+                quit = "q",
+            },
+            console = {
+                next_session = "]s",
+                prev_session = "[s",
+            },
+            base = {
+                next_view = "]v",
+                prev_view = "[v",
+                jump_to_first = "[V",
+                jump_to_last = "]V",
+                help = "g?",
+            },
+        },
         icons = {
             collapsed = "󰅂 ",
             disabled = "",

docs/src/routes/configuration/+page.md

@@ -67,6 +67,29 @@ return {
             hide = {},
         },
     },
+    -- WIP: some keymaps are not overrideable yet!
+    keymaps = {
+        hover = {
+            quit = "q",
+            toggle = { "<CR>", "<2-LeftMouse>" },
+            jump_to_parent = "[[",
+            set_value = "s",
+        },
+        help = {
+            quit = "q",
+        },
+        console = {
+            next_session = "]s",
+            prev_session = "[s",
+        },
+        base = {
+            next_view = "]v",
+            prev_view = "[v",
+            jump_to_first = "[V",
+            jump_to_last = "]V",
+            help = "g?",
+        },
+    },
     icons = {
         collapsed = "󰅂 ",
         disabled = "",

docs/src/routes/keymaps/+page.md

@@ -8,6 +8,8 @@ There are also some default keybindings for navigating to other views.
 
 The help window itself has only 1 mapping: it can be closed with `q`.
 
+**Some keymaps are overridable**. Check the [config](configuration) for details.
+
 | Key    | Action                                       |
 | ------ | -------------------------------------------- |
 | **Threads**                                           |

lua/dap-view/config.lua

@@ -93,6 +93,34 @@ local M = {}
 ---@field threads dapview.RenderThreadsConfig
 ---@field breakpoints dapview.RenderBreakpointsConfig
 
+---@alias dapview.Keymap string|string[]
+
+---@class dapview.HoverKeymapsConfig
+---@field quit dapview.Keymap
+---@field toggle dapview.Keymap
+---@field jump_to_parent dapview.Keymap
+---@field set_value dapview.Keymap
+
+---@class dapview.HelpKeymapsConfig
+---@field quit dapview.Keymap
+
+---@class dapview.ConsoleKeymapsConfig
+---@field next_session dapview.Keymap
+---@field prev_session dapview.Keymap
+
+---@class dapview.BaseKeymapsConfig
+---@field next_view dapview.Keymap
+---@field prev_view dapview.Keymap
+---@field jump_to_first dapview.Keymap
+---@field jump_to_last dapview.Keymap
+---@field help dapview.Keymap
+
+---@class dapview.KeymapsConfig
+---@field hover dapview.HoverKeymapsConfig
+---@field help dapview.HelpKeymapsConfig
+---@field console dapview.ConsoleKeymapsConfig
+---@field base dapview.BaseKeymapsConfig
+
 ---@class dapview.VirtualTextConfig
 ---@field enabled boolean
 ---@field format fun(variable: dap.Variable, frame: dap.StackFrame, node: TSNode): string?
@@ -105,6 +133,7 @@ local M = {}
 ---@field windows dapview.WindowsConfig
 ---@field help dapview.HelpConfig
 ---@field render dapview.RenderConfig
+---@field keymaps dapview.KeymapsConfig
 ---@field icons dapview.IconsConfig Icons for each button
 ---@field virtual_text dapview.VirtualTextConfig
 ---@field switchbuf string|dapview.SwitchBufFun Control how to jump when selecting a breakpoint or a call in the stack
@@ -155,6 +184,28 @@ M.config = {
             hide = {},
         },
     },
+    keymaps = {
+        hover = {
+            quit = "q",
+            toggle = { "<CR>", "<2-LeftMouse>" },
+            jump_to_parent = "[[",
+            set_value = "s",
+        },
+        help = {
+            quit = "q",
+        },
+        console = {
+            next_session = "]s",
+            prev_session = "[s",
+        },
+        base = {
+            next_view = "]v",
+            prev_view = "[v",
+            jump_to_first = "[V",
+            jump_to_last = "]V",
+            help = "g?",
+        },
+    },
     icons = {
         collapsed = "󰅂 ",
         disabled = "",

lua/dap-view/console/keymaps.lua

@@ -1,14 +1,18 @@
+local setup = require("dap-view.setup")
+
 local keymap = require("dap-view.views.keymaps.util").keymap
 
 local M = {}
 
 ---@param buf integer
 M.set_keymaps = function(buf)
-    keymap("]s", function()
+    local keys = setup.config.keymaps.console
+
+    keymap(keys.next_session, function()
         require("dap-view").navigate({ count = vim.v.count1, wrap = true, type = "sessions" })
     end, buf)
 
-    keymap("[s", function()
+    keymap(keys.prev_session, function()
         require("dap-view").navigate({ count = -vim.v.count1, wrap = true, type = "sessions" })
     end, buf)
 end

lua/dap-view/hover/init.lua

@@ -1,4 +1,5 @@
 local state = require("dap-view.state")
+local setup = require("dap-view.setup")
 
 local keymap = require("dap-view.views.keymaps.util").keymap
 
@@ -32,9 +33,11 @@ end
 
 ---@param bufnr integer
 M.set_keymaps = function(bufnr)
-    keymap("q", "<C-w>q", bufnr)
+    local keys = setup.config.keymaps.hover
 
-    keymap({ "<CR>", "<2-LeftMouse>" }, function()
+    keymap(keys.quit, "<C-w>q", bufnr)
+
+    keymap(keys.toggle, function()
         local cursor_line = api.nvim_win_get_cursor(state.hover_winnr)[1]
 
         coroutine.wrap(function()
@@ -49,13 +52,13 @@ M.set_keymaps = function(bufnr)
         end)()
     end, bufnr)
 
-    keymap("[[", function()
+    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)
 
-    keymap("s", function()
+    keymap(keys.set_value, function()
         local cursor_line = api.nvim_win_get_cursor(state.hover_winnr)[1]
 
         coroutine.wrap(function()

lua/dap-view/setup/validate/init.lua

@@ -8,6 +8,7 @@ function M.validate(config)
         help = { config.help, "table" },
         render = { config.render, "table" },
         switchbuf = { config.switchbuf, { "string", "function" } },
+        keymaps = { config.keymaps, { "table" } },
         icons = { config.icons, "table" },
         virtual_text = { config.virtual_text, "table" },
         auto_toggle = { config.auto_toggle, { "boolean", "string" } },

lua/dap-view/setup/validate/keymaps.lua

@@ -0,0 +1,40 @@
+local M = {}
+
+local validate = require("dap-view.setup.validate.util").validate
+
+---@param config dapview.KeymapsConfig
+function M.validate(config)
+    validate("keymaps", {
+        hover = { config.hover, "table" },
+    }, config)
+
+    local hover = config.hover
+    validate("keymaps.hover", {
+        quit = { hover.quit, { "table", "string" } },
+        set_value = { hover.set_value, { "table", "string" } },
+        jump_to_parent = { hover.jump_to_parent, { "table", "string" } },
+        toggle = { hover.toggle, { "table", "string" } },
+    }, config)
+
+    local help = config.help
+    validate("keymaps.help", {
+        quit = { help.quit, { "table", "string" } },
+    }, config)
+
+    local console = config.console
+    validate("keymaps.console", {
+        next_session = { console.next_session, { "table", "string" } },
+        prev_session = { console.prev_session, { "table", "string" } },
+    }, config)
+
+    local base = config.base
+    validate("keymaps.base", {
+        next_view = { base.next_view, { "table", "string" } },
+        prev_view = { base.prev_view, { "table", "string" } },
+        jump_to_first = { base.jump_to_first, { "table", "string" } },
+        jump_to_last = { base.jump_to_last, { "table", "string" } },
+        help = { base.help, { "table", "string" } },
+    }, config)
+end
+
+return M

lua/dap-view/types.lua

@@ -25,6 +25,20 @@
 
 ---@class dapview.VirtualTextConfigPartial : dapview.VirtualTextConfig, {}
 
+---@class dapview.HoverKeymapsConfigPartial : dapview.HoverKeymapsConfig, {}
+
+---@class dapview.HelpKeymapsConfigPartial : dapview.HelpKeymapsConfig, {}
+
+---@class dapview.ConsoleKeymapsConfigPartial : dapview.ConsoleKeymapsConfig, {}
+
+---@class dapview.BaseKeymapsConfigPartial : dapview.BaseKeymapsConfig, {}
+
+---@class dapview.KeymapsConfigPartial : dapview.KeymapsConfig, {}
+---@field hover? dapview.HoverKeymapsConfigPartial
+---@field help? dapview.HelpKeymapsConfigPartial
+---@field console? dapview.ConsoleKeymapsConfigPartial
+---@field base? dapview.BaseKeymapsConfigPartial
+
 ---@class dapview.Config : dapview.ConfigStrict, {}
 ---@field winbar? dapview.WinbarConfigPartial
 ---@field windows? dapview.WindowsConfigPartial