Neovim plugin improving access to clipboard history (mirror)
refactor/feat: switched to global opts table and added new api functionality
+127
-107
+22
-6
lua/yankbank/api.lua
+22
-6
lua/yankbank/api.lua
···
1
1
local M = {}
2
2
3
-
-- TODO: figure out how api should get 'yanks' and 'reg_types'
4
-
-- - possibly rewrite these to be global variables
5
-
6
-
--- DOC:
3
+
--- get a table containg a single yankbank entry by index
7
4
---@param i integer
8
5
---@return table
9
6
function M.get_entry(i)
10
-
-- TODO: figure out how tables are being populated for the api
11
7
return {
12
8
yank_text = YANKS[i],
13
9
reg_type = REG_TYPES[i],
14
10
}
15
11
end
16
12
17
-
--- DOC:
13
+
--- get a table containing all yankbank entries
18
14
---@return table
19
15
function M.get_all()
20
16
local out = {}
···
26
22
end
27
23
return out
28
24
end
25
+
26
+
--- add an entry to yankbank
27
+
---@param yank_text string yank text to add to YANKS table
28
+
---@param reg_type string register type "v", "V", or "^V" for visual, visual-linewise, and visual-block modes respectively.
29
+
function M.add_entry(yank_text, reg_type)
30
+
require("yankbank.clipboard").add_yank(yank_text, reg_type)
31
+
end
32
+
33
+
--- remove entry from yankbank by index
34
+
---@param i integer index to remove
35
+
function M.remove_entry(i)
36
+
local yank_text = table.remove(YANKS, i)
37
+
table.remove(REG_TYPES, i)
38
+
if OPTS.persist_type == "sqlite" then
39
+
require("yankbank.persistence.sql").data():remove_match(yank_text)
40
+
end
41
+
end
42
+
43
+
-- TODO: individual popup keymap setting functions
44
+
-- - could just update opts table that is passed into set_keymaps
29
45
30
46
return M
+7
-9
lua/yankbank/clipboard.lua
+7
-9
lua/yankbank/clipboard.lua
···
6
6
--- Function to add yanked text to table
7
7
---@param text string
8
8
---@param reg_type string
9
-
---@param opts table
10
-
function M.add_yank(text, reg_type, opts)
9
+
function M.add_yank(text, reg_type)
11
10
-- avoid adding empty strings
12
11
if text == "" and text == " " and text == "\n" then
13
12
return
···
28
27
table.insert(REG_TYPES, 1, reg_type)
29
28
30
29
-- trim table size if necessary
31
-
if #YANKS > opts.max_entries then
30
+
if #YANKS > OPTS.max_entries then
32
31
table.remove(YANKS)
33
32
table.remove(REG_TYPES)
34
33
end
35
34
36
35
-- add entry to persistent store
37
-
persistence.add_entry(text, reg_type, opts)
36
+
persistence.add_entry(text, reg_type)
38
37
end
39
38
40
39
--- autocommand to listen for yank events
41
-
---@param opts table
42
-
function M.setup_yank_autocmd(opts)
40
+
function M.setup_yank_autocmd()
43
41
vim.api.nvim_create_autocmd("TextYankPost", {
44
42
callback = function()
45
43
-- get register information
···
58
56
return
59
57
end
60
58
61
-
M.add_yank(yank_text, reg_type, opts)
59
+
M.add_yank(yank_text, reg_type)
62
60
end
63
61
end,
64
62
})
65
63
66
64
-- poll registers when vim is focused (check for new clipboard activity)
67
-
if opts.focus_gain_poll == true then
65
+
if OPTS.focus_gain_poll == true then
68
66
vim.api.nvim_create_autocmd("FocusGained", {
69
67
callback = function()
70
68
-- get register information
···
79
77
return
80
78
end
81
79
82
-
M.add_yank(yank_text, reg_type, opts)
80
+
M.add_yank(yank_text, reg_type)
83
81
end,
84
82
})
85
83
end
+3
-4
lua/yankbank/data.lua
+3
-4
lua/yankbank/data.lua
···
1
1
local M = {}
2
2
3
3
--- reformat yanks table for popup
4
-
---@param opts table
5
4
---@return table, table
6
-
function M.get_display_lines(opts)
5
+
function M.get_display_lines()
7
6
local display_lines = {}
8
7
local line_yank_map = {}
9
8
local yank_num = 0
···
51
50
52
51
if i < #YANKS then
53
52
-- Add a visual separator between yanks, aligned with the yank content
54
-
if opts.sep ~= "" then
53
+
if OPTS.sep ~= "" then
55
54
table.insert(
56
55
display_lines,
57
-
string.rep(" ", max_digits + 2) .. opts.sep
56
+
string.rep(" ", max_digits + 2) .. OPTS.sep
58
57
)
59
58
end
60
59
table.insert(line_yank_map, false)
+14
-22
lua/yankbank/init.lua
+14
-22
lua/yankbank/init.lua
···
5
5
local clipboard = require("yankbank.clipboard")
6
6
local persistence = require("yankbank.persistence")
7
7
8
-
-- initialize tables
9
8
YANKS = {}
10
9
REG_TYPES = {}
10
+
OPTS = {}
11
11
12
12
-- default plugin options
13
13
local default_opts = {
···
23
23
}
24
24
25
25
--- wrapper function for main plugin functionality
26
-
---@param opts table
27
-
local function show_yank_bank(opts)
28
-
YANKS = persistence.get_yanks(opts) or YANKS
26
+
local function show_yank_bank()
27
+
YANKS = persistence.get_yanks() or YANKS
29
28
30
29
-- initialize buffer and populate bank
31
-
local bufnr, display_lines, line_yank_map =
32
-
menu.create_and_fill_buffer(opts)
33
-
34
-
-- handle empty bank case
35
-
if not bufnr or not display_lines or not line_yank_map then
30
+
local buf_data = menu.create_and_fill_buffer()
31
+
if not buf_data then
36
32
return
37
33
end
38
34
39
-
-- open window and set keybinds
40
-
local win_id = menu.open_window(bufnr, display_lines)
41
-
menu.set_keymaps(win_id, bufnr, line_yank_map, opts)
35
+
-- open popup window
36
+
buf_data.win_id = menu.open_window(buf_data)
37
+
38
+
-- set popup keybinds
39
+
menu.set_keymaps(buf_data)
42
40
end
43
41
44
42
-- plugin setup
45
43
---@param opts? table
46
44
function M.setup(opts)
47
45
-- merge opts with default options table
48
-
opts = vim.tbl_deep_extend("keep", opts or {}, default_opts)
46
+
OPTS = vim.tbl_deep_extend("keep", opts or {}, default_opts)
49
47
50
48
-- enable persistence based on opts (needs to be called before autocmd setup)
51
-
YANKS, REG_TYPES = persistence.setup(opts)
49
+
YANKS, REG_TYPES = persistence.setup()
52
50
53
51
-- create clipboard autocmds
54
-
clipboard.setup_yank_autocmd(opts)
52
+
clipboard.setup_yank_autocmd()
55
53
56
54
-- create user command
57
55
vim.api.nvim_create_user_command("YankBank", function()
58
-
show_yank_bank(opts)
56
+
show_yank_bank()
59
57
end, { desc = "Show Recent Yanks" })
60
-
61
-
-- TODO: remove
62
-
local api = require("yankbank.api")
63
-
vim.api.nvim_create_user_command("YankBankApi", function()
64
-
print(vim.inspect(api.get_all()))
65
-
end, {})
66
58
end
67
59
68
60
return M
+9
-12
lua/yankbank/persistence.lua
+9
-12
lua/yankbank/persistence.lua
···
3
3
local persistence = {}
4
4
5
5
---add entry from bank to
6
-
---@param entry string|table
6
+
---@param entry string
7
7
---@param reg_type string
8
-
---@param opts table
9
-
function M.add_entry(entry, reg_type, opts)
10
-
if opts.persist_type == "sqlite" then
8
+
function M.add_entry(entry, reg_type)
9
+
if OPTS.persist_type == "sqlite" then
11
10
persistence:insert_yank(entry, reg_type)
12
11
end
13
12
end
14
13
15
14
--- get current state of yanks in persistent storage
16
-
---@param opts table
17
-
function M.get_yanks(opts)
18
-
if opts.persist_type == "sqlite" then
15
+
function M.get_yanks()
16
+
if OPTS.persist_type == "sqlite" then
19
17
return persistence:get_bank()
20
18
end
21
19
end
22
20
23
21
---initialize bank persistence
24
-
---@param opts table
25
22
---@return table
26
23
---@return table
27
-
function M.setup(opts)
28
-
if not opts.persist_type then
24
+
function M.setup()
25
+
if not OPTS.persist_type then
29
26
return {}, {}
30
-
elseif opts.persist_type == "sqlite" then
31
-
persistence = require("yankbank.persistence.sql").setup(opts)
27
+
elseif OPTS.persist_type == "sqlite" then
28
+
persistence = require("yankbank.persistence.sql").setup()
32
29
return persistence:get_bank()
33
30
else
34
31
return {}, {}
+20
-4
lua/yankbank/persistence/sql.lua
+20
-4
lua/yankbank/persistence/sql.lua
···
82
82
return yanks, reg_types
83
83
end
84
84
85
+
--- remove an entry from the banks table matching input text
86
+
---@param text string
87
+
function data:remove_match(text)
88
+
db:with_open(function()
89
+
return db:eval(
90
+
"DELETE FROM bank WHERE yank_text = :yank_text",
91
+
{ yank_text = text }
92
+
)
93
+
end)
94
+
end
95
+
96
+
--- get data in sqlite_tbl form (for api use only)
97
+
---@return sqlite_tbl
98
+
function M.data()
99
+
return data
100
+
end
101
+
85
102
--- set up database persistence
86
-
---@param opts table
87
103
---@return sqlite_tbl data
88
-
function M.setup(opts)
89
-
max_entries = opts.max_entries
104
+
function M.setup()
105
+
max_entries = OPTS.max_entries
90
106
91
107
vim.api.nvim_create_user_command("YankBankClearDB", function()
92
108
data:remove()
···
94
110
REG_TYPES = {}
95
111
end, {})
96
112
97
-
if opts.debug == true then
113
+
if OPTS.debug == true then
98
114
vim.api.nvim_create_user_command("YankBankViewDB", function()
99
115
print(vim.inspect(data:get()))
100
116
end, {})