Neovim plugin improving access to clipboard history (mirror)
auto-generate vimdoc
+38
-36
+38
-36
doc/yankbank-nvim.txt
+38
-36
doc/yankbank-nvim.txt
···
44
44
INSTALLATION AND SETUP *yankbank-nvim-yankbank-installation-and-setup*
45
45
46
46
47
-
WITHOUT PERSISTENCE:
47
+
WITH PERSISTENCE (RECOMMENDED)
48
48
49
-
Lazy:
49
+
Using lazy.nvim
50
50
51
51
>lua
52
52
{
53
53
"ptdewey/yankbank-nvim",
54
+
dependencies = "kkharji/sqlite.lua",
54
55
config = function()
55
-
require('yankbank').setup()
56
+
require('yankbank').setup({
57
+
persist_type = "sqlite",
58
+
})
56
59
end,
57
60
}
58
61
<
59
62
60
63
61
-
WITH PERSISTENCE
64
+
WITHOUT PERSISTENCE:
62
65
63
-
Lazy:
66
+
Using lazy.nvim
64
67
65
68
>lua
66
69
{
67
70
"ptdewey/yankbank-nvim",
68
-
dependencies = "kkharji/sqlite.lua",
69
71
config = function()
70
-
require('yankbank').setup({
71
-
persist_type = "sqlite",
72
-
})
72
+
require('yankbank').setup()
73
73
end,
74
74
}
75
75
<
···
96
96
EXAMPLE CONFIGURATION
97
97
98
98
>lua
99
-
config = function()
100
-
require('yankbank').setup({
101
-
max_entries = 9,
102
-
sep = "",
103
-
num_behavior = "prefix",
104
-
focus_gain_poll = true,
105
-
keymaps = {
106
-
paste = "<CR>",
107
-
},
108
-
num_behavior = "prefix",
109
-
persist_type = "sqlite",
110
-
registers = {
111
-
yank_register = "+",
112
-
},
113
-
})
114
-
end,
99
+
{
100
+
"ptdewey/yankbank-nvim",
101
+
config = function()
102
+
require('yankbank').setup({
103
+
max_entries = 9,
104
+
sep = "-----",
105
+
num_behavior = "jump",
106
+
focus_gain_poll = true,
107
+
persist_type = "sqlite",
108
+
keymaps = {
109
+
paste = "<CR>",
110
+
},
111
+
registers = {
112
+
yank_register = "+",
113
+
},
114
+
})
115
+
end,
116
+
}
115
117
<
116
118
117
119
If no separator is desired, pass in an empty string for `sep`
···
123
125
entry 3) - Note: If 'max_entries' is a two-digit number, there will be a delay
124
126
upon pressing numbers that prefix a valid entry.
125
127
128
+
The 'focus_gain_poll' option allows for enabling an additional autocommand that
129
+
watches for focus gains (refocusing Neovim window), and checks for changes in
130
+
the unnamedplus ('+') register, adding to yankbank when new contents are found.
131
+
This allows for automatically adding text copied from other sources (like a
132
+
browser) to the yankbank without the bank opening trigger. Off by default, but
133
+
I highly recommend enabling it with `focus_gain_poll = true`.
134
+
126
135
127
136
PERSISTENCE ~
128
137
129
-
If persistence between sessions is desired, sqlite.lua will be used to create a
138
+
For the best experience with YankBank, enabling persistence is highly
139
+
recommended. If persistence is enabled, sqlite.lua will be used to create a
130
140
persistent store for recent yanks in the plugin root directory. To utilize
131
141
sqlite persistence, `"kkharji/sqlite.lua"` must be added as a dependency in
132
142
your config, and `persist_type` must be set to `"sqlite"`
···
145
155
}
146
156
<
147
157
148
-
The'focus_gain_poll' option allows for enabling an additional autocommand that
149
-
watches for focus gains (refocusing Neovim window), and checks for changes in
150
-
the unnamedplus ('+') register, adding to yankbank when new contents are found.
151
-
This allows for automatically adding text copied from other sources (like a
152
-
browser) to the yankbank without the bank opening trigger. Off by default, but
153
-
I highly recommend enabling it (`focus_gain_poll = true`)
154
-
155
158
156
159
USAGE *yankbank-nvim-yankbank-usage*
157
160
158
-
The popup menu can be opened with the command:`:YankBank`, an entry is pasted
159
-
at the current cursor position by hitting enter, and the menu can be closed by
161
+
Thepopup menu can be opened with the command:`:YankBank`, an entry is pasted at
162
+
the current cursor position by hitting enter, and the menu can be closed by
160
163
hitting escape, ctrl-c, or q. An entry from the menu can also be yanked into
161
164
the unnamedplus register by hitting yy.
162
165
···
170
173
171
174
POTENTIAL IMPROVEMENTS *yankbank-nvim-yankbank-potential-improvements*
172
175
173
-
- Polling on unnamedplus register to populate bank in more intuitive manner (could be enabled as option)
174
176
- nvim-cmp integration
175
177
- fzf integration
176
178
- telescope integration