Neovim plugin improving access to clipboard history (mirror)
auto-generate vimdoc
+33
-5
+33
-5
doc/yankbank-nvim.txt
+33
-5
doc/yankbank-nvim.txt
···
1
-
*yankbank-nvim.txt* For Neovim >= 0.7.0 Last change: 2024 June 14
1
+
*yankbank-nvim.txt* For Neovim >= 0.7.0 Last change: 2024 August 24
2
2
3
3
==============================================================================
4
4
Table of Contents *yankbank-nvim-table-of-contents*
···
54
54
55
55
>lua
56
56
use {
57
-
'ptdewey/yankbank-nvim',
57
+
"ptdewey/yankbank-nvim",
58
58
config = function()
59
59
require('yankbank').setup()
60
60
end,
···
75
75
strings | `{ "<Esc>", "<C-c>", "q" }` | | num_behavior | string defining jump
76
76
behavior "prefix" or "jump" | `"prefix"` | | focus_gain_poll | boolean | `nil`
77
77
| | registers | table container for register overrides | `{ }` | |
78
-
registers.yank_register | default register to yank from popup to | `"+"` |
78
+
registers.yank_register | default register to yank from popup to | `"+"` | |
79
+
persist_type | string defining persistence type "memory" or "sqlite" |
80
+
`"memory"` | | persist_path | string defining path for persistence file/db file
81
+
| `"~/.local/share/nvim/lazy/yankbank-nvim"` (if installed with lazy) |
79
82
80
83
81
84
EXAMPLE CONFIGURATION
···
91
94
navigation_next = "j",
92
95
navigation_prev = "k",
93
96
},
97
+
num_behavior = "prefix",
98
+
persist_type = "sqlite",
94
99
registers = {
95
100
yank_register = "+",
96
101
},
···
107
112
entry 3) - Note: If 'max_entries' is a two-digit number, there will be a delay
108
113
upon pressing numbers that prefix a valid entry.
109
114
110
-
The 'focus_gain_poll' option allows for enabling an additional autocommand that
115
+
116
+
PERSISTENCE
117
+
118
+
If persistence between sessions is desired, sqlite.lua will be used to create a
119
+
persistent store for recent yanks in the plugin root directory. To utilize
120
+
sqlite persistence, `"kkharji/sqlite.lua"` must be added as a dependency in
121
+
your config, and `persist_type` must be set to `"sqlite"`
122
+
123
+
>lua
124
+
-- lazy
125
+
return {
126
+
"ptdewey/yankbank-nvim",
127
+
dependencies = "kkharji/sqlite.lua",
128
+
config = function()
129
+
require('yankbank').setup({
130
+
-- other options...
131
+
persist_type = "sqlite"
132
+
})
133
+
end,
134
+
}
135
+
<
136
+
137
+
The'focus_gain_poll' option allows for enabling an additional autocommand that
111
138
watches for focus gains (refocusing Neovim window), and checks for changes in
112
139
the unnamedplus ('+') register, adding to yankbank when new contents are found.
113
140
This allows for automatically adding text copied from other sources (like a
···
132
159
133
160
POTENTIAL IMPROVEMENTS *yankbank-nvim-yankbank-potential-improvements*
134
161
135
-
- Persistence between sessions (through either sqlite database or just a file)
162
+
- Polling on unnamedplus register to populate bank in more intuitive manner (could be enabled as option)
136
163
- nvim-cmp integration
137
164
- fzf integration
165
+
- telescope integration
138
166
139
167
140
168
ALTERNATIVES *yankbank-nvim-yankbank-alternatives*