feat: added options to configure mappings for multiple files gists

In a gist with multiple files you can cycle them, now the user can configure which keys (LHS) to use for the mappings

Author: lnc3l0t

README.md

@@ -72,7 +72,15 @@ You can also list your gists and edit their files on the fly.
 ```lua
     require("gist").setup({
         private = false, -- All gists will be private, you won't be prompted again
-        clipboard = "+" -- The registry to use for copying the Gist URL
+        clipboard = "+", -- The registry to use for copying the Gist URL
+        list = {
+            -- If there are multiple files in a gist you can scroll them,
+            -- with vim-like bindings n/p next previous
+            mappings = {
+                next_file = "<C-n>",
+                prev_file = "<C-p>"
+            }
+        }
     })
 ```
 

doc/gist.config.txt

@@ -2,11 +2,16 @@
 
 DESCRIPTION
     The `:CreateGist` command can be configured to avoid prompting the user for the privacy settings of the Gist and target clipboard.
-    This is done via the `setup()` function with the `clipboard` and `private`.
+    This is done via the `setup()` function with the `config.clipboard` and `config.private`.
+    The `:ListGists` command has mappings that allow you to cycle between files if a gist has multiple of them,
+    you can also type to fuzzy find them.
+    The mappings can be customized with the `config.list.mappings.{next_file, prev_file}` via the `setup()` function.
 
 OPTIONS
 	private = false, will set the privacy to `public` by default.
 	clipboard = "0", will set the clipboard to `+` by default, it is the unnamed_plus register `:h quoteplus`.
+    next_file = "<C-n>",
+    prev_file = "<C-p>",
 
 SEE ALSO
     :help gist

lua/gist/api/list.lua

@@ -1,4 +1,5 @@
 local core = require("gist.core.gh")
+local config = require("gist").config
 
 local M = {}
 
@@ -10,8 +11,8 @@ local function create_split_terminal(command)
 	vim.api.nvim_win_set_option(win, "number", false)
 	vim.api.nvim_win_set_option(win, "relativenumber", false)
 	vim.api.nvim_buf_set_name(buf, ("term://%s/%s"):format(buf, command[1]))
-	vim.keymap.set("t", "<C-n>", "<Down>", { buffer = buf })
-	vim.keymap.set("t", "<C-p>", "<Up>", { buffer = buf })
+	vim.keymap.set("t", config.list.mappings.next_file, "<Down>", { buffer = buf })
+	vim.keymap.set("t", config.list.mappings.prev_file, "<Up>", { buffer = buf })
 	vim.api.nvim_win_set_option(win, "winbar", "%=Use CTRL-{n,p} to cycle")
 	vim.cmd.startinsert()
 	return buf

lua/gist/init.lua

@@ -2,12 +2,18 @@ local M = {}
 
 M.config = {
 	private = false,
-	clipboard = "+"
+	clipboard = "+",
+	list = {
+		mappings = {
+			next_file = "<C-n>",
+			prev_file = "<C-p>"
+		}
+	}
 }
 
 function M.setup(opts)
-  M.config = vim.tbl_deep_extend('force', M.config, opts or {})
-  return M.config
+	M.config = vim.tbl_deep_extend('force', M.config, opts or {})
+	return M.config
 end
 
 return M