feat: support custom keybinding for diff view

Also adds documentation to README.md

README.md

@@ -62,7 +62,7 @@ The create function takes 1 optional argument that can be one of the following v
 * floating (This currently doesn't work with popups)
 * split
 
-## Status Keybindings
+## Default Status Keybindings
 
 | Keybinding   | Function                                         |
 |--------------|--------------------------------------------------|
@@ -85,6 +85,15 @@ The create function takes 1 optional argument that can be one of the following v
 | \<enter>     | Go to file                                       |
 | \<C-r>       | Refresh Buffer                                   |
 
+## Default Diff View Keybindings
+
+| Keybinding   | Function                                         |
+|--------------|--------------------------------------------------|
+| q            | Close                                            |
+| <c-s>        | Save                                             |
+| ]f           | Next file                                        |
+| [f           | Prev file                                        |
+
 ## Configuration
 
 You can configure neogit by running the `neogit.setup` function.
@@ -112,14 +121,14 @@ neogit.setup {
       ["B"] = "BranchPopup",
       -- Removes the default mapping of "s"
       ["s"] = "",
-    }
+    },
+    diff_view = {}
   }
 }
 ```
 
-Right now only the status buffer supports custom mappings. The other popups will follow shortly.
-
-List of status commands:
+<details>
+<summary>Status Commands</summary>
 
 * Close
 * Depth1 (Set foldlevel to 1)
@@ -143,6 +152,19 @@ List of status commands:
 * LogPopup
 * StashPopup
 * BranchPopup
+</details>
+
+<details>
+<summary>Diff View Commands</summary>
+
+* Close
+* Save
+* NextFile
+* CloseFile
+* Noop (Override mapping but don't do anything)
+
+</details>
+
 
 ## Notification Highlighting
 

lua/neogit/config.lua

@@ -37,6 +37,12 @@ M.values = {
       ["L"] = "LogPopup",
       ["Z"] = "StashPopup",
       ["b"] = "BranchPopup",
+    },
+    diff_view = {
+      ["q"] = "Close",
+      ["<c-s>"] = "Save",
+      ["]f"] = "NextFile",
+      ["[f"] = "PrevFile",
     }
   }
 }

lua/neogit/diff.lua

@@ -1,4 +1,5 @@
 local M = {}
+local config = require 'neogit.config'
 local a = require 'plenary.async_lib'
 local await, void, async, scheduler = a.await, a.void, a.async, a.scheduler
 local MappingsManager = require("neogit.lib.mappings_manager")
@@ -249,12 +250,16 @@ function M.open(opts)
   end
 end
 
+local cmd_cb_map = {
+  ["NextFile"] = M.next_file,
+  ["PrevFile"] = M.prev_file,
+  ["Save"] = M.save_lhs,
+  ["Close"] = M.close,
+  ["Noop"] = M.close,
+}
+
 M.mappings = {
   lhs = {
-    ["q"] = M.close,
-    ["<c-s>"] = M.save_lhs,
-    ["]f"] = M.next_file,
-    ["[f"] = M.prev_file,
     ["<c-w>l"] = M.focus_rhs,
     ["<c-w><c-l>"] = M.focus_rhs,
     ["<c-w>k"] = M.noop,
@@ -265,7 +270,6 @@ M.mappings = {
     ["<c-w><c-h>"] = M.noop,
   },
   rhs = {
-    ["q"] = M.close,
     ["<c-w>h"] = M.focus_lhs,
     ["<c-w><c-h>"] = M.focus_lhs,
     ["<c-w>l"] = M.noop,
@@ -277,10 +281,12 @@ M.mappings = {
   },
 }
 
+for key, val in pairs(config.values.mappings.diff_view) do
+  local cb = cmd_cb_map[val]
+  M.mappings.lhs[key] = cb
+  M.mappings.rhs[key] = cb
+end
+
 D = M
 
 return M
-
-
-
-