Neovim plugin improving access to clipboard history (mirror)
Merge pull request #3 from ptdewey/dev
feat(added custom keymap support)
+51
-34
+20
-7
README.md
+20
-7
README.md
···
38
38
The setup function also supports taking in a table of options:
39
39
| Option | Type | Default |
40
40
|-------------|--------------------------------------------|----------------|
41
-
| max_entries | integer number of entries to show in popup | 10 |
42
-
| sep | string separator to show between table entries | "-----" |
41
+
| max_entries | integer number of entries to show in popup | `10` |
42
+
| sep | string separator to show between table entries | `"-----"` |
43
+
| keymaps | table containing keymap overrides | `{}` |
44
+
| keymaps.navigation_next | string | `"j"` |
45
+
| keymaps.navigation_prev | string | `"k"` |
46
+
| keymaps.paste | string | `"<CR>"` |
47
+
| keymaps.yank | string | `"yy"` |
48
+
| keymaps.close | table of strings | `{ "<Esc>", "<C-c>", "q" }` |
43
49
44
50
45
51
If no separator is desired, pass in an empty string for sep:
···
48
54
require('yankbank').setup({
49
55
max_entries = 12,
50
56
sep = "",
57
+
keymaps = {
58
+
navigation_next = "j",
59
+
navigation_prev = "k",
60
+
},
51
61
})
52
62
end,
53
63
```
···
60
70
I would personally also recommend setting a keybind to open the menu.
61
71
```lua
62
72
-- map to '<leader>y'
63
-
vim.keymap.set("n", "<leader>y", ":YankBank<CR>", { noremap = true })
73
+
vim.keymap.set("n", "<leader>y", "<cmd>YankBank<CR>", { noremap = true })
64
74
```
65
75
66
76
## Potential Improvements
67
-
- Expose popup keybind behavior through setup options
68
-
- Access to other registers (number/letter registers?)
77
+
- Persistence between sessions (through either sqlite database or just a file)
69
78
- Polling on unnamedplus register to populate bank in more intuitive manner (could be enabled as option)
79
+
- Number based navigation of menu
80
+
- nvim-cmp integration
81
+
- fzf integration
82
+
- Setup options configuring which registers are included
70
83
71
84
## Alternatives
72
-
- [neoclip](https://github.com/AckslD/nvim-neoclip.lua)
73
-
- [Yanky](https://github.com/gbprod/yanky.nvim)
85
+
- [nvim-neoclip](https://github.com/AckslD/nvim-neoclip.lua)
86
+
- [yanky.nvim](https://github.com/gbprod/yanky.nvim)
+8
-16
lua/yankbank/init.lua
+8
-16
lua/yankbank/init.lua
···
11
11
local sep = "-----"
12
12
13
13
-- wrapper function for main plugin functionality
14
-
local function show_yank_bank(args)
14
+
local function show_yank_bank(opts)
15
15
-- Parse command arguments directly if args are provided as a string
16
-
local opts = {}
17
-
if type(args) == "string" and args ~= "" then
18
-
local parts = vim.split(args, "%s+", {true})
19
-
opts.max_entries = tonumber(parts[1])
20
-
opts.sep = parts[2]
21
-
elseif type(args) == "table" then
22
-
-- If opts is already a table, use it directly (for programmatic calls)
23
-
opts = args
24
-
end
16
+
opts = opts or {}
25
17
26
18
-- Fallback to defaults if necessary
27
19
local max_entries_opt = opts.max_entries or max_entries
28
20
local sep_opt = opts.sep or sep
21
+
opts.keymaps = opts.keymaps or {}
29
22
30
23
local bufnr, display_lines, line_yank_map = menu.create_and_fill_buffer(yanks, max_entries_opt, sep_opt)
31
24
-- handle empty bank case
···
33
26
return
34
27
end
35
28
local win_id = menu.open_window(bufnr, display_lines)
36
-
menu.set_keymaps(win_id, bufnr, yanks, line_yank_map)
29
+
menu.set_keymaps(win_id, bufnr, yanks, line_yank_map, opts)
37
30
end
38
31
39
32
-- plugin setup
···
42
35
43
36
-- parse opts
44
37
max_entries = opts.max_entries or max_entries
45
-
sep = opts.sep or sep
38
+
-- sep = opts.sep or sep
46
39
47
40
-- create clipboard autocmds
48
41
clipboard.setup_yank_autocmd(yanks, max_entries)
49
42
50
43
-- Create user command
51
-
-- TODO: allow params (i.e. keymaps/max_entries/separator)
52
-
vim.api.nvim_create_user_command("YankBank", function(args)
53
-
show_yank_bank(args.args)
54
-
end, { desc = "Show Recent Yanks", nargs = "*" })
44
+
vim.api.nvim_create_user_command("YankBank", function()
45
+
show_yank_bank(opts)
46
+
end, { desc = "Show Recent Yanks" })
55
47
end
56
48
57
49
return M