Configure mappings (#73)

* feat: allow for action keymaps to be configured

Author: gennaro-tedesco

README.md

@@ -47,12 +47,12 @@ Install `nvim-possession` with your favourite plugin manager (`fzf-lua` is requi
 
 Exposed interfaces
 
-| function            | description                                                                 | interaction                                                         |
+| function | description | interaction |
 | :------------------ | :-------------------------------------------------------------------------- | :------------------------------------------------------------------ |
-| possession.list()   | list all the existing sessions with fzf-lua; preview shows files in session | `<CR>` load selected session<br>`<Ctrl-x>` delete selection session |
-| possession.new()    | prompt for name to create new session                                       | session folder must alredy exist, return a message error otherwise  |
-| possession.update() | update current session (if new buffers are open)                            | do nothing if no session is loaded                                  |
-| possession.delete() | delete current session (without prompt)                                     | do nothing if no session is loaded                                  |
+| possession.list() | list all the existing sessions with fzf-lua; preview shows files in session | `<CR>` load selected session<br>`<Ctrl-x>` delete selection session<br>`<Ctrl-r>` rename selected session<br>`<Ctrl-n>` create new session |
+| possession.new() | prompt for name to create new session | session folder must alredy exist, return a message error otherwise |
+| possession.update() | update current session (if new buffers are open) | do nothing if no session is loaded |
+| possession.delete() | delete current session (without prompt) | do nothing if no session is loaded |
 
 ## 🛠 Usage and advanced configuration
 
@@ -101,6 +101,12 @@ require("nvim-possession").setup({
             vertical = "right:30%"
         }
     }
+    ---@type possession.Mapopts
+    mappings = { -- configure action keymaps on possession.list() picker
+        action_delete = "ctrl-x",
+        action_rename = "ctrl-r",
+        action_new = "ctrl-n",
+    }
     sort = require("nvim-possession.sorting").alpha_sort -- callback, sorting function to list sessions
                                                          -- require("nvim-possession.sorting").time_sort
                                                          -- to sort by last updated instead

doc/possession.txt

@@ -1,4 +1,4 @@
-*possession.txt*       For Neovim >= 0.8.0      Last change: 2025 September 03
+*possession.txt*       For Neovim >= 0.8.0      Last change: 2025 September 04
 
 ==============================================================================
 Table of Contents                               *possession-table-of-contents*
@@ -60,7 +60,10 @@ Exposed interfaces
   --------------------- --------------------------------- -----------------------------
   possession.list()     list all the existing sessions    <CR> load selected
                         with fzf-lua; preview shows files session<Ctrl-x> delete
-                        in session                        selection session
+                        in session                        selection session<Ctrl-r>
+                                                          rename selected
+                                                          session<Ctrl-n> create new
+                                                          session
 
   possession.new()      prompt for name to create new     session folder must alredy
                         session                           exist, return a message error
@@ -130,6 +133,12 @@ however if you really want to do so:
                 vertical = "right:30%"
             }
         }
+        ---@type possession.Mapopts
+        mappings = { -- configure action keymaps on possession.list() picker
+            action_delete = "ctrl-x",
+            action_rename = "ctrl-r",
+            action_new = "ctrl-n",
+        }
         sort = require("nvim-possession.sorting").alpha_sort -- callback, sorting function to list sessions
                                                              -- require("nvim-possession.sorting").time_sort
                                                              -- to sort by last updated instead

lua/nvim-possession/config.lua

@@ -54,6 +54,16 @@ M.fzf_winopts = {
 	},
 }
 
+---@class possession.Mapopts
+---@field delete? string
+---@field rename? string
+---@field new? string
+M.mappings = {
+	action_delete = "ctrl-x",
+	action_rename = "ctrl-r",
+	action_new = "ctrl-n",
+}
+
 ---@type function
 M.sort = sort.alpha_sort
 

lua/nvim-possession/init.lua

@@ -172,21 +172,21 @@ M.setup = function(user_opts)
 			cwd = user_config.sessions.sessions_path,
 			actions = {
 				["enter"] = M.load,
-				["ctrl-x"] = {
+				[user_config.mappings.action_delete] = {
 					fn = function(selected)
 						M.delete_selected(selected)
 						M.list()
 					end,
 					header = "delete session",
 				},
-				["ctrl-r"] = {
+				[user_config.mappings.action_rename] = {
 					fn = function(selected)
 						M.rename_selected(selected)
 						M.list()
 					end,
 					header = "rename session",
 				},
-				["ctrl-n"] = { fn = M.new, header = "new session" },
+				[user_config.mappings.action_new] = { fn = M.new, header = "new session" },
 			},
 		}
 		opts = require("fzf-lua.config").normalize_opts(opts, {})