Add descriptions to hunk keymaps

Closes #26

Author: julienvincent

lua/hunk/init.lua

@@ -113,6 +113,7 @@ local function set_global_bindings(layout, buf)
     ui.help.create()
   end, {
     buffer = buf,
+    desc = "Open hunk.nvim help",
   })
 
   for _, chord in ipairs(utils.into_table(config.keys.global.accept)) do
@@ -121,6 +122,7 @@ local function set_global_bindings(layout, buf)
       vim.cmd("qa")
     end, {
       buffer = buf,
+      desc = "Accept the current selection",
     })
   end
 
@@ -129,6 +131,7 @@ local function set_global_bindings(layout, buf)
       vim.cmd("cq")
     end, {
       buffer = buf,
+      desc = "Cancel selection and quit",
     })
   end
 
@@ -137,6 +140,7 @@ local function set_global_bindings(layout, buf)
       vim.api.nvim_set_current_win(layout.tree)
     end, {
       buffer = buf,
+      desc = "Focus hunk.nvim file-tree",
     })
   end
 end

lua/hunk/ui/file.lua

@@ -96,10 +96,13 @@ function M.create(window, params)
     change = params.change,
   }
 
-  local map_opts = {
-    buffer = buf,
-    nowait = true,
-  }
+  local function map_opts(desc)
+    return {
+      buffer = buf,
+      nowait = true,
+      desc = desc,
+    }
+  end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.toggle_line)) do
     vim.keymap.set("n", chord, function()
@@ -109,7 +112,7 @@ function M.create(window, params)
         lines = { line },
         file = File,
       })
-    end, map_opts)
+    end, map_opts("Toggle line under cursor"))
 
     vim.keymap.set("v", chord, function()
       local lines = get_selected_lines()
@@ -120,7 +123,7 @@ function M.create(window, params)
           file = File,
         })
       end)
-    end, map_opts)
+    end, map_opts("Toggle selected line(s)"))
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.toggle_line_pair)) do
@@ -132,7 +135,7 @@ function M.create(window, params)
         file = File,
         both_sides = true,
       })
-    end, map_opts)
+    end, map_opts("Toggle line pair under cursor (left + right)"))
 
     vim.keymap.set("v", chord, function()
       local lines = get_selected_lines()
@@ -144,7 +147,7 @@ function M.create(window, params)
           both_sides = true,
         })
       end)
-    end, map_opts)
+    end, map_opts("Toggle selected line pair(s) (left + right)"))
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.toggle_hunk)) do
@@ -154,7 +157,7 @@ function M.create(window, params)
         line = vim.api.nvim_win_get_cursor(window)[1],
         file = File,
       })
-    end, map_opts)
+    end, map_opts("Toggle entire hunk under cursor"))
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.prev_hunk)) do
@@ -168,7 +171,7 @@ function M.create(window, params)
           break
         end
       end
-    end, map_opts)
+    end, map_opts("Go to prev hunk"))
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.next_hunk)) do
@@ -181,7 +184,7 @@ function M.create(window, params)
           break
         end
       end
-    end, map_opts)
+    end, map_opts("Go to next hunk"))
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.diff.toggle_focus)) do
@@ -190,7 +193,7 @@ function M.create(window, params)
         type = "toggle-focus",
         side = params.side,
       })
-    end, map_opts)
+    end, map_opts("Toggle focused window between left/right"))
   end
 
   config.hooks.on_diff_mount({ buf = buf, win = window })

lua/hunk/ui/tree.lua

@@ -225,7 +225,10 @@ function M.create(opts)
       if node and node.type == "file" then
         opts.on_open(node.change, callback_opts)
       end
-    end, { buffer = buf })
+    end, {
+      buffer = buf,
+      desc = "Open file under cursor",
+    })
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.tree.expand_node)) do
@@ -241,7 +244,10 @@ function M.create(opts)
         node:expand()
         Component.render()
       end
-    end, { buffer = buf })
+    end, {
+      buffer = buf,
+      desc = "Expand or preview node under cursor",
+    })
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.tree.collapse_node)) do
@@ -251,7 +257,10 @@ function M.create(opts)
         node:collapse()
         Component.render()
       end
-    end, { buffer = buf })
+    end, {
+      buffer = buf,
+      desc = "Collapse node under cursor",
+    })
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.tree.toggle_file)) do
@@ -267,7 +276,10 @@ function M.create(opts)
       for _, change in ipairs(changeset) do
         opts.on_toggle(change, state ~= "all", callback_opts)
       end
-    end, { buffer = buf })
+    end, {
+      buffer = buf,
+      desc = "Toggle all hunks in file under cursor",
+    })
   end
 
   config.hooks.on_tree_mount({ buf = buf, tree = tree, opts = opts })