pdewey.com
Neovim plugin improving access to clipboard history (mirror)
feat: remove globals and lazy load modules for better startup time
+31
-15
lua/yankbank/api.lua
+31
-15
lua/yankbank/api.lua
···
1
local M = {}
2
3
--- get a table containg a single yankbank entry by index
4
---@param i integer
5
---@return table
6
function M.get_entry(i)
7
return {
8
-
yank_text = YB_YANKS[i],
9
-
reg_type = YB_REG_TYPES[i],
10
}
11
end
12
···
14
---@return table
15
function M.get_all()
16
local out = {}
17
-
for i, v in ipairs(YB_YANKS) do
18
table.insert(out, {
19
yank_text = v,
20
-
reg_type = YB_REG_TYPES[i],
21
})
22
end
23
return out
···
34
--- remove entry from yankbank by index
35
---@param i integer index to remove
36
function M.remove_entry(i)
37
-
local yank_text = table.remove(YB_YANKS, i)
38
-
local reg_type = table.remove(YB_REG_TYPES, i)
39
-
if YB_OPTS.persist_type == "sqlite" then
40
require("yankbank.persistence.sql")
41
.data()
42
.remove_match(yank_text, reg_type)
···
47
---
48
---@param i integer index to pin
49
function M.pin_entry(i)
50
-
if i > #YB_PINS then
51
return
52
end
53
54
-- TODO: show pins differently in popup (could use different hl_groups for pinned entries?)
55
-
YB_PINS[i] = 1
56
57
-
if YB_OPTS.persist_type == "sqlite" then
58
return require("yankbank.persistence.sql")
59
.data()
60
-
.pin(YB_YANKS[i], YB_REG_TYPES[i])
61
end
62
end
63
···
65
---
66
---@param i integer index to unpin
67
function M.unpin_entry(i)
68
-
if i > #YB_PINS then
69
return
70
end
71
72
-- TODO: update popup pin highlight
73
-
YB_PINS[i] = 0
74
75
-
if YB_OPTS.persist_type == "sqlite" then
76
return require("yankbank.persistence.sql")
77
.data()
78
-
.unpin(YB_YANKS[i], YB_REG_TYPES[i])
79
end
80
end
81
···
1
local M = {}
2
3
+
local state = require("yankbank.state")
4
+
5
--- get a table containg a single yankbank entry by index
6
---@param i integer
7
---@return table
8
function M.get_entry(i)
9
return {
10
+
yank_text = state.get_yanks()[i],
11
+
reg_type = state.get_reg_types()[i],
12
}
13
end
14
···
16
---@return table
17
function M.get_all()
18
local out = {}
19
+
local yanks = state.get_yanks()
20
+
local reg_types = state.get_reg_types()
21
+
for i, v in ipairs(yanks) do
22
table.insert(out, {
23
yank_text = v,
24
+
reg_type = reg_types[i],
25
})
26
end
27
return out
···
38
--- remove entry from yankbank by index
39
---@param i integer index to remove
40
function M.remove_entry(i)
41
+
local yanks = state.get_yanks()
42
+
local reg_types = state.get_reg_types()
43
+
local yank_text = table.remove(yanks, i)
44
+
local reg_type = table.remove(reg_types, i)
45
+
state.set_yanks(yanks)
46
+
state.set_reg_types(reg_types)
47
+
48
+
local opts = state.get_opts()
49
+
if opts.persist_type == "sqlite" then
50
require("yankbank.persistence.sql")
51
.data()
52
.remove_match(yank_text, reg_type)
···
57
---
58
---@param i integer index to pin
59
function M.pin_entry(i)
60
+
local pins = state.get_pins()
61
+
if i > #pins then
62
return
63
end
64
65
-- TODO: show pins differently in popup (could use different hl_groups for pinned entries?)
66
+
pins[i] = 1
67
+
state.set_pins(pins)
68
69
+
local opts = state.get_opts()
70
+
if opts.persist_type == "sqlite" then
71
return require("yankbank.persistence.sql")
72
.data()
73
+
.pin(state.get_yanks()[i], state.get_reg_types()[i])
74
end
75
end
76
···
78
---
79
---@param i integer index to unpin
80
function M.unpin_entry(i)
81
+
local pins = state.get_pins()
82
+
if i > #pins then
83
return
84
end
85
86
-- TODO: update popup pin highlight
87
+
pins[i] = 0
88
+
state.set_pins(pins)
89
90
+
local opts = state.get_opts()
91
+
if opts.persist_type == "sqlite" then
92
return require("yankbank.persistence.sql")
93
.data()
94
+
.unpin(state.get_yanks()[i], state.get_reg_types()[i])
95
end
96
end
97
+42
-13
lua/yankbank/clipboard.lua
+42
-13
lua/yankbank/clipboard.lua
···
1
local M = {}
2
3
--- Function to add yanked text to table
4
---@param text string
5
---@param reg_type string
···
11
end
12
13
local is_pinned = 0
14
15
-- check for duplicate values already inserted
16
-
for i, entry in ipairs(YB_YANKS) do
17
if entry == text then
18
-- remove matched entry so it can be inserted at 1st position
19
-
table.remove(YB_YANKS, i)
20
-
table.remove(YB_REG_TYPES, i)
21
-
is_pinned = table.remove(YB_PINS, i)
22
break
23
end
24
end
···
29
or is_pinned
30
31
-- add entry to bank
32
-
table.insert(YB_YANKS, 1, text)
33
-
table.insert(YB_REG_TYPES, 1, reg_type)
34
-
table.insert(YB_PINS, 1, is_pinned)
35
36
-- trim table size if necessary
37
-
if #YB_YANKS > YB_OPTS.max_entries then
38
-
local i = require("yankbank.utils").last_zero_entry(YB_PINS)
39
40
if not i or i == 1 then
41
-- WARN: undefined behavior
···
44
)
45
else
46
-- remove last non-pinned entry
47
-
table.remove(YB_YANKS, i)
48
-
table.remove(YB_REG_TYPES, i)
49
-
table.remove(YB_PINS, i)
50
end
51
end
52
53
-- add entry to persistent store
54
require("yankbank.persistence").add_entry(text, reg_type, pin)
···
74
return
75
end
76
77
M.add_yank(yank_text, reg_type)
78
end
79
end,
80
})
81
82
-- poll registers when vim is focused (check for new clipboard activity)
83
-
if YB_OPTS.focus_gain_poll == true then
84
vim.api.nvim_create_autocmd("FocusGained", {
85
callback = function()
86
-- get register information
···
95
return
96
end
97
98
M.add_yank(yank_text, reg_type)
99
end,
100
})
···
1
local M = {}
2
3
+
local state = require("yankbank.state")
4
+
5
+
--- get the last zero entry in a table
6
+
---
7
+
---@param t table
8
+
---@return integer?
9
+
local function last_zero_entry(t)
10
+
for i = #t, 1, -1 do
11
+
if t[i] == 0 then
12
+
return i
13
+
end
14
+
end
15
+
return nil
16
+
end
17
+
18
--- Function to add yanked text to table
19
---@param text string
20
---@param reg_type string
···
26
end
27
28
local is_pinned = 0
29
+
local yanks = state.get_yanks()
30
+
local reg_types = state.get_reg_types()
31
+
local pins = state.get_pins()
32
33
-- check for duplicate values already inserted
34
+
for i, entry in ipairs(yanks) do
35
if entry == text then
36
-- remove matched entry so it can be inserted at 1st position
37
+
table.remove(yanks, i)
38
+
table.remove(reg_types, i)
39
+
is_pinned = table.remove(pins, i)
40
break
41
end
42
end
···
47
or is_pinned
48
49
-- add entry to bank
50
+
table.insert(yanks, 1, text)
51
+
table.insert(reg_types, 1, reg_type)
52
+
table.insert(pins, 1, is_pinned)
53
54
-- trim table size if necessary
55
+
local opts = state.get_opts()
56
+
if #yanks > opts.max_entries then
57
+
local i = last_zero_entry(pins)
58
59
if not i or i == 1 then
60
-- WARN: undefined behavior
···
63
)
64
else
65
-- remove last non-pinned entry
66
+
table.remove(yanks, i)
67
+
table.remove(reg_types, i)
68
+
table.remove(pins, i)
69
end
70
end
71
+
72
+
-- update state
73
+
state.set_yanks(yanks)
74
+
state.set_reg_types(reg_types)
75
+
state.set_pins(pins)
76
77
-- add entry to persistent store
78
require("yankbank.persistence").add_entry(text, reg_type, pin)
···
98
return
99
end
100
101
+
-- lazy load initialization when first yank happens
102
+
require("yankbank").ensure_initialized()
103
M.add_yank(yank_text, reg_type)
104
end
105
end,
106
})
107
108
-- poll registers when vim is focused (check for new clipboard activity)
109
+
local opts = state.get_opts()
110
+
if opts.focus_gain_poll == true then
111
vim.api.nvim_create_autocmd("FocusGained", {
112
callback = function()
113
-- get register information
···
122
return
123
end
124
125
+
-- lazy load initialization when first focus gain happens
126
+
require("yankbank").ensure_initialized()
127
M.add_yank(yank_text, reg_type)
128
end,
129
})
-66
lua/yankbank/data.lua
-66
lua/yankbank/data.lua
···
1
-
local M = {}
2
-
3
-
--- reformat yanks table for popup
4
-
---@return table, table
5
-
function M.get_display_lines()
6
-
local display_lines = {}
7
-
local line_yank_map = {}
8
-
local yank_num = 0
9
-
10
-
-- calculate the maximum width needed for the yank numbers
11
-
local max_digits = #tostring(#YB_YANKS)
12
-
13
-
-- assumes yanks is table of strings
14
-
for i, yank in ipairs(YB_YANKS) do
15
-
yank_num = yank_num + 1
16
-
17
-
local yank_lines = yank
18
-
if type(yank) == "string" then
19
-
-- remove trailing newlines
20
-
yank = yank:gsub("\n$", "")
21
-
yank_lines = vim.split(yank, "\n", { plain = true })
22
-
end
23
-
24
-
local leading_space, leading_space_length
25
-
26
-
-- determine the number of leading whitespaces on the first line
27
-
if #yank_lines > 0 then
28
-
leading_space = yank_lines[1]:match("^(%s*)")
29
-
leading_space_length = #leading_space
30
-
end
31
-
32
-
for j, line in ipairs(yank_lines) do
33
-
if j == 1 then
34
-
-- Format the line number with uniform spacing
35
-
local lineNumber =
36
-
string.format("%" .. max_digits .. "d: ", yank_num)
37
-
line = line:sub(leading_space_length + 1)
38
-
table.insert(display_lines, lineNumber .. line)
39
-
else
40
-
-- Remove the same amount of leading whitespace as on the first line
41
-
line = line:sub(leading_space_length + 1)
42
-
-- Use spaces equal to the line number's reserved space to align subsequent lines
43
-
table.insert(
44
-
display_lines,
45
-
string.rep(" ", max_digits + 2) .. line
46
-
)
47
-
end
48
-
table.insert(line_yank_map, i)
49
-
end
50
-
51
-
if i < #YB_YANKS then
52
-
-- Add a visual separator between yanks, aligned with the yank content
53
-
if YB_OPTS.sep ~= "" then
54
-
table.insert(
55
-
display_lines,
56
-
string.rep(" ", max_digits + 2) .. YB_OPTS.sep
57
-
)
58
-
end
59
-
table.insert(line_yank_map, false)
60
-
end
61
-
end
62
-
63
-
return display_lines, line_yank_map
64
-
end
65
-
66
-
return M
···
+58
-43
lua/yankbank/init.lua
+58
-43
lua/yankbank/init.lua
···
1
local M = {}
2
3
-- plugin setup
4
---@param opts? table
5
function M.setup(opts)
6
-
-- define global variables
7
-
YB_YANKS = {}
8
-
YB_REG_TYPES = {}
9
-
YB_PINS = {}
10
-
YB_OPTS = {}
11
-
12
-
-- local imports
13
-
local clipboard = require("yankbank.clipboard")
14
-
local persistence = require("yankbank.persistence")
15
-
16
-- default plugin options
17
local default_opts = {
18
max_entries = 10,
···
27
db_path = nil,
28
bind_indices = nil,
29
}
30
-
31
-
--- wrapper function for main plugin functionality
32
-
local function show_yank_bank()
33
-
local menu = require("yankbank.menu")
34
-
35
-
-- set up menu keybinds from defaults and YB_OPTS.keymaps
36
-
menu.setup()
37
-
38
-
YB_YANKS = persistence.get_yanks() or YB_YANKS
39
-
40
-
-- initialize buffer and populate bank
41
-
local buf_data = menu.create_and_fill_buffer()
42
-
if not buf_data then
43
-
return
44
-
end
45
-
46
-
-- open popup window
47
-
buf_data.win_id = menu.open_window(buf_data)
48
-
49
-
-- set popup keybinds
50
-
menu.set_keymaps(buf_data)
51
-
end
52
53
-- merge opts with default options table
54
-
YB_OPTS = vim.tbl_deep_extend("keep", opts or {}, default_opts)
55
56
-
-- enable persistence based on opts (needs to be called before autocmd setup)
57
-
YB_YANKS, YB_REG_TYPES, YB_PINS = persistence.setup()
58
-
59
-
-- create clipboard autocmds
60
-
clipboard.setup_yank_autocmd()
61
62
-- create user command
63
vim.api.nvim_create_user_command("YankBank", function()
64
show_yank_bank()
65
end, { desc = "Show Recent Yanks" })
66
67
-- Bind 1-n if `bind_indices` is set to a string
68
-
if YB_OPTS.bind_indices then
69
-
for i = 1, YB_OPTS.max_entries do
70
-
vim.keymap.set("n", YB_OPTS.bind_indices .. i, function()
71
require("yankbank.helpers").smart_paste(
72
-
YB_YANKS[i],
73
-
YB_REG_TYPES[i],
74
true
75
)
76
end, {
···
1
local M = {}
2
3
+
local initialized = false
4
+
5
+
function M.ensure_initialized()
6
+
if initialized then
7
+
return
8
+
end
9
+
10
+
local state = require("yankbank.state")
11
+
local persistence = require("yankbank.persistence")
12
+
13
+
-- enable persistence based on opts (needs to be called before autocmd setup)
14
+
local yanks, reg_types, pins = persistence.setup()
15
+
state.init(yanks, reg_types, pins, state.get_opts())
16
+
17
+
initialized = true
18
+
end
19
+
20
+
--- wrapper function for main plugin functionality
21
+
local function show_yank_bank()
22
+
M.ensure_initialized()
23
+
24
+
local state = require("yankbank.state")
25
+
local menu = require("yankbank.menu")
26
+
27
+
-- set up menu keybinds from defaults and state.get_opts().keymaps
28
+
menu.setup()
29
+
30
+
local persistence = require("yankbank.persistence")
31
+
local yanks = persistence.get_yanks() or state.get_yanks()
32
+
state.set_yanks(yanks)
33
+
34
+
-- initialize buffer and populate bank
35
+
local buf_data = menu.create_and_fill_buffer()
36
+
if not buf_data then
37
+
return
38
+
end
39
+
40
+
-- open popup window
41
+
buf_data.win_id = menu.open_window(buf_data)
42
+
43
+
-- set popup keybinds
44
+
menu.set_keymaps(buf_data)
45
+
end
46
+
47
-- plugin setup
48
---@param opts? table
49
function M.setup(opts)
50
-- default plugin options
51
local default_opts = {
52
max_entries = 10,
···
61
db_path = nil,
62
bind_indices = nil,
63
}
64
65
-- merge opts with default options table
66
+
local merged_opts = vim.tbl_deep_extend("keep", opts or {}, default_opts)
67
68
+
-- store config in state module (lazy loaded when needed)
69
+
local state = require("yankbank.state")
70
+
state.set_opts(merged_opts)
71
72
-- create user command
73
vim.api.nvim_create_user_command("YankBank", function()
74
show_yank_bank()
75
end, { desc = "Show Recent Yanks" })
76
+
77
+
-- create clipboard autocmds
78
+
require("yankbank.clipboard").setup_yank_autocmd()
79
80
-- Bind 1-n if `bind_indices` is set to a string
81
+
if merged_opts.bind_indices then
82
+
for i = 1, merged_opts.max_entries do
83
+
vim.keymap.set("n", merged_opts.bind_indices .. i, function()
84
+
M.ensure_initialized()
85
+
local state = require("yankbank.state")
86
require("yankbank.helpers").smart_paste(
87
+
state.get_yanks()[i],
88
+
state.get_reg_types()[i],
89
true
90
)
91
end, {
+8
-4
lua/yankbank/persistence.lua
+8
-4
lua/yankbank/persistence.lua
···
1
local M = {}
2
3
local persistence = {}
4
5
---add entry from bank to
···
7
---@param reg_type string
8
---@param pin integer|boolean?
9
function M.add_entry(entry, reg_type, pin)
10
-
if YB_OPTS.persist_type == "sqlite" then
11
persistence:insert_yank(entry, reg_type, pin)
12
end
13
end
14
15
--- get current state of yanks in persistent storage
16
function M.get_yanks()
17
-
if YB_OPTS.persist_type == "sqlite" then
18
return persistence:get_bank()
19
end
20
end
···
24
---@return table
25
---@return table
26
function M.setup()
27
-
if not YB_OPTS.persist_type then
28
return {}, {}, {}
29
-
elseif YB_OPTS.persist_type == "sqlite" then
30
persistence = require("yankbank.persistence.sql").setup()
31
return persistence:get_bank()
32
else
···
1
local M = {}
2
3
+
local state = require("yankbank.state")
4
local persistence = {}
5
6
---add entry from bank to
···
8
---@param reg_type string
9
---@param pin integer|boolean?
10
function M.add_entry(entry, reg_type, pin)
11
+
local opts = state.get_opts()
12
+
if opts.persist_type == "sqlite" then
13
persistence:insert_yank(entry, reg_type, pin)
14
end
15
end
16
17
--- get current state of yanks in persistent storage
18
function M.get_yanks()
19
+
local opts = state.get_opts()
20
+
if opts.persist_type == "sqlite" then
21
return persistence:get_bank()
22
end
23
end
···
27
---@return table
28
---@return table
29
function M.setup()
30
+
local opts = state.get_opts()
31
+
if not opts.persist_type then
32
return {}, {}, {}
33
+
elseif opts.persist_type == "sqlite" then
34
persistence = require("yankbank.persistence.sql").setup()
35
return persistence:get_bank()
36
else
+14
-9
lua/yankbank/persistence/sql.lua
+14
-9
lua/yankbank/persistence/sql.lua
···
1
local M = {}
2
3
local sqlite = require("sqlite")
4
5
-
local dbdir = YB_OPTS.db_path
6
-
or debug.getinfo(1).source:sub(2):match("(.*/).*/.*/.*/")
7
-
or "./"
8
-
-- or vim.fn.stdpath("data")
9
local max_entries = 10
10
11
---@class YankBankDB:sqlite_db
12
---@field bank sqlite_tbl
13
---@field bank sqlite_tbl
14
local db = sqlite({
15
-
uri = dbdir .. "/yankbank.db",
16
bank = {
17
-- yanked text should be unique and be primary key
18
yank_text = { "text", unique = true, primary = true, required = true },
···
178
--- set up database persistence
179
---@return sqlite_tbl data
180
function M.setup()
181
-
max_entries = YB_OPTS.max_entries
182
183
vim.api.nvim_create_user_command("YankBankClearDB", function()
184
data:drop()
185
-
YB_YANKS = {}
186
-
YB_REG_TYPES = {}
187
end, {})
188
189
-
if YB_OPTS.debug == true then
190
vim.api.nvim_create_user_command("YankBankViewDB", function()
191
print(vim.inspect(data:get()))
192
end, {})
···
1
local M = {}
2
3
local sqlite = require("sqlite")
4
+
local state = require("yankbank.state")
5
6
+
local function get_db_path()
7
+
local opts = state.get_opts()
8
+
return opts.db_path
9
+
or debug.getinfo(1).source:sub(2):match("(.*/).*/.*/.*/")
10
+
or "./"
11
+
end
12
+
13
local max_entries = 10
14
15
---@class YankBankDB:sqlite_db
16
---@field bank sqlite_tbl
17
---@field bank sqlite_tbl
18
local db = sqlite({
19
+
uri = get_db_path() .. "/yankbank.db",
20
bank = {
21
-- yanked text should be unique and be primary key
22
yank_text = { "text", unique = true, primary = true, required = true },
···
182
--- set up database persistence
183
---@return sqlite_tbl data
184
function M.setup()
185
+
local opts = state.get_opts()
186
+
max_entries = opts.max_entries
187
188
vim.api.nvim_create_user_command("YankBankClearDB", function()
189
data:drop()
190
+
state.set_yanks({})
191
+
state.set_reg_types({})
192
end, {})
193
194
+
if opts.debug == true then
195
vim.api.nvim_create_user_command("YankBankViewDB", function()
196
print(vim.inspect(data:get()))
197
end, {})
+49
lua/yankbank/state.lua
+49
lua/yankbank/state.lua
···
···
1
+
local M = {}
2
+
3
+
local state = {
4
+
yanks = {},
5
+
reg_types = {},
6
+
pins = {},
7
+
opts = {}
8
+
}
9
+
10
+
function M.get_yanks()
11
+
return state.yanks
12
+
end
13
+
14
+
function M.set_yanks(yanks)
15
+
state.yanks = yanks
16
+
end
17
+
18
+
function M.get_reg_types()
19
+
return state.reg_types
20
+
end
21
+
22
+
function M.set_reg_types(reg_types)
23
+
state.reg_types = reg_types
24
+
end
25
+
26
+
function M.get_pins()
27
+
return state.pins
28
+
end
29
+
30
+
function M.set_pins(pins)
31
+
state.pins = pins
32
+
end
33
+
34
+
function M.get_opts()
35
+
return state.opts
36
+
end
37
+
38
+
function M.set_opts(opts)
39
+
state.opts = opts
40
+
end
41
+
42
+
function M.init(yanks, reg_types, pins, opts)
43
+
state.yanks = yanks or {}
44
+
state.reg_types = reg_types or {}
45
+
state.pins = pins or {}
46
+
state.opts = opts or {}
47
+
end
48
+
49
+
return M
-16
lua/yankbank/utils.lua
-16
lua/yankbank/utils.lua