pdewey.com
Neovim plugin improving access to clipboard history (mirror)
feat: added options to plugin setup
+17
README.md
+17
README.md
···
35
}
36
```
37
38
+
The setup function also supports taking in a table of options:
39
+
| Option | Type | Default |
40
+
|-------------|--------------------------------------------|----------------|
41
+
| max_entries | integer number of entries to show in popup | 10 |
42
+
| sep | string separator to show between table entries | "-----" |
43
+
44
+
45
+
If no separator is desired, pass in an empty string for sep:
46
+
```lua
47
+
config = function()
48
+
require('yankbank').setup({
49
+
max_entries = 12,
50
+
sep = "",
51
+
})
52
+
end,
53
+
```
54
+
55
## Usage
56
57
The popup menu can be opened with the command:`:YankBank`, an entry is pasted at the current cursor position by hitting enter, and the menu can be closed by hitting escape, ctrl-c, or q.
+5
-4
lua/yankbank/data.lua
+5
-4
lua/yankbank/data.lua
···
2
local M = {}
3
4
-- reformat yanks table for popup
5
-
function M.get_display_lines(yanks)
6
local display_lines = {}
7
local line_yank_map = {}
8
local yank_num = 0
···
39
table.insert(line_yank_map, i)
40
end
41
42
-
-- Add a visual separator between yanks, aligned with the yank content
43
-
-- TODO: allow turning off/on in plugin setup
44
if i < #yanks then
45
-
table.insert(display_lines, string.rep(" ", max_digits + 2) .. "------")
46
table.insert(line_yank_map, false)
47
end
48
end
···
2
local M = {}
3
4
-- reformat yanks table for popup
5
+
function M.get_display_lines(yanks, sep)
6
local display_lines = {}
7
local line_yank_map = {}
8
local yank_num = 0
···
39
table.insert(line_yank_map, i)
40
end
41
42
if i < #yanks then
43
+
-- Add a visual separator between yanks, aligned with the yank content
44
+
if sep ~= "" then
45
+
table.insert(display_lines, string.rep(" ", max_digits + 2) .. sep)
46
+
end
47
table.insert(line_yank_map, false)
48
end
49
end
+25
-12
lua/yankbank/init.lua
+25
-12
lua/yankbank/init.lua
···
8
-- initialize yanks tables
9
local yanks = {}
10
local max_entries = 10
11
12
-- wrapper function for main plugin functionality
13
-
local function show_yank_bank()
14
-
-- TODO: update max entries with passed in options
15
-
local bufnr, display_lines, line_yank_map = menu.create_and_fill_buffer(yanks, max_entries)
16
local win_id = menu.open_window(bufnr, display_lines)
17
menu.set_keymaps(win_id, bufnr, yanks, line_yank_map)
18
end
19
20
-- plugin setup
21
function M.setup(opts)
22
-
local o = {}
23
24
-- parse opts
25
-
if opts ~= nil then
26
-
o.max_entries = opts.max_entries or max_entries
27
-
else
28
-
o.max_entries = max_entries
29
-
end
30
31
-- create clipboard autocmds
32
-
clipboard.setup_yank_autocmd(yanks, o.max_entries)
33
34
-- Create user command
35
-- TODO: allow params (i.e. keymaps/max_entries/separator)
36
-
vim.api.nvim_create_user_command("YankBank", show_yank_bank,
37
-
{ desc = "Show Recent Yanks" })
38
end
39
40
return M
···
8
-- initialize yanks tables
9
local yanks = {}
10
local max_entries = 10
11
+
local sep = "-----"
12
13
-- wrapper function for main plugin functionality
14
+
local function show_yank_bank(args)
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
25
+
26
+
-- Fallback to defaults if necessary
27
+
local max_entries_opt = opts.max_entries or max_entries
28
+
local sep_opt = opts.sep or sep
29
+
30
+
local bufnr, display_lines, line_yank_map = menu.create_and_fill_buffer(yanks, max_entries_opt, sep_opt)
31
local win_id = menu.open_window(bufnr, display_lines)
32
menu.set_keymaps(win_id, bufnr, yanks, line_yank_map)
33
end
34
35
-- plugin setup
36
function M.setup(opts)
37
+
opts = opts or {}
38
39
-- parse opts
40
+
max_entries = opts.max_entries or max_entries
41
+
sep = opts.sep or sep
42
43
-- create clipboard autocmds
44
+
clipboard.setup_yank_autocmd(yanks, max_entries)
45
46
-- Create user command
47
-- TODO: allow params (i.e. keymaps/max_entries/separator)
48
+
vim.api.nvim_create_user_command("YankBank", function(args)
49
+
show_yank_bank(args.args)
50
+
end, { desc = "Show Recent Yanks", nargs = "*" })
51
end
52
53
return M