Neovim plugin improving access to clipboard history (mirror)
doc: improved readme
+63
-45
+29
-22
README.md
+29
-22
README.md
···
9
9
10
10
Choosing an entry from the menu (by hitting enter) will paste it into the currently open buffer at the cursor position.
11
11
12
+
YankBank also offers persistence between sessions, meaning that you won't lose your yanks after closing and reopening a session (see [persistence](#Persistence)).
13
+
12
14
### Screenshots
13
15
14
16
···
17
19
It will be populated further for each yank or deletion in that session.
18
20
19
21
## Installation and Setup
22
+
23
+
#### Without persistence:
20
24
21
25
Lazy:
22
26
```lua
···
28
32
}
29
33
```
30
34
31
-
Packer:
35
+
#### With Persistence
36
+
37
+
Lazy:
32
38
```lua
33
-
use {
39
+
{
34
40
"ptdewey/yankbank-nvim",
41
+
dependencies = "kkharji/sqlite.lua",
35
42
config = function()
36
-
require('yankbank').setup()
43
+
require('yankbank').setup({
44
+
persist_type = "sqlite",
45
+
})
37
46
end,
38
47
}
39
48
```
···
56
65
| registers | table container for register overrides | `{ }` |
57
66
| registers.yank_register | default register to yank from popup to | `"+"` |
58
67
| persist_type | string defining persistence type "memory" or "sqlite" | `"memory"` |
59
-
| persist_path | string defining path for persistence file/db file | `"~/.local/share/nvim/lazy/yankbank-nvim"` (if installed with lazy) |
60
68
61
69
62
70
#### Example Configuration
63
71
64
72
```lua
65
-
config = function()
66
-
require('yankbank').setup({
67
-
max_entries = 9,
68
-
sep = "",
69
-
num_behavior = "prefix",
70
-
focus_gain_poll = true,
71
-
keymaps = {
72
-
navigation_next = "j",
73
-
navigation_prev = "k",
74
-
},
75
-
num_behavior = "prefix",
76
-
persist_type = "sqlite",
77
-
registers = {
78
-
yank_register = "+",
79
-
},
80
-
})
81
-
end,
73
+
config = function()
74
+
require('yankbank').setup({
75
+
max_entries = 9,
76
+
sep = "",
77
+
num_behavior = "prefix",
78
+
focus_gain_poll = true,
79
+
keymaps = {
80
+
paste = "<CR>",
81
+
},
82
+
num_behavior = "prefix",
83
+
persist_type = "sqlite",
84
+
registers = {
85
+
yank_register = "+",
86
+
},
87
+
})
88
+
end,
82
89
```
83
90
84
91
If no separator is desired, pass in an empty string for `sep`
···
88
95
- `num_behavior = "jump"` jumps to entry matching the pressed number key (i.e. '3' jumps to entry 3)
89
96
- Note: If 'max_entries' is a two-digit number, there will be a delay upon pressing numbers that prefix a valid entry.
90
97
91
-
#### Persistence
98
+
### Persistence
92
99
If persistence between sessions is desired, sqlite.lua will be used to create a persistent store for recent yanks in the plugin root directory.
93
100
To utilize sqlite persistence, `"kkharji/sqlite.lua"` must be added as a dependency in your config, and `persist_type` must be set to `"sqlite"`:
94
101
+34
-23
doc/yankbank-nvim.txt
+34
-23
doc/yankbank-nvim.txt
···
29
29
Choosing an entry from the menu (by hitting enter) will paste it into the
30
30
currently open buffer at the cursor position.
31
31
32
+
YankBank also offers persistence between sessions, meaning that you won’t
33
+
lose your yanks after closing and reopening a session (see
34
+
|yankbank-nvim-persistence|.
35
+
32
36
33
37
SCREENSHOTS ~
34
38
···
39
43
40
44
INSTALLATION AND SETUP *yankbank-nvim-yankbank-installation-and-setup*
41
45
46
+
47
+
WITHOUT PERSISTENCE:
48
+
42
49
Lazy:
43
50
44
51
>lua
···
50
57
}
51
58
<
52
59
53
-
Packer:
60
+
61
+
WITH PERSISTENCE
62
+
63
+
Lazy:
54
64
55
65
>lua
56
-
use {
66
+
{
57
67
"ptdewey/yankbank-nvim",
68
+
dependencies = "kkharji/sqlite.lua",
58
69
config = function()
59
-
require('yankbank').setup()
70
+
require('yankbank').setup({
71
+
persist_type = "sqlite",
72
+
})
60
73
end,
61
74
}
62
75
<
···
77
90
| | registers | table container for register overrides | `{ }` | |
78
91
registers.yank_register | default register to yank from popup to | `"+"` | |
79
92
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) |
93
+
`"memory"` |
82
94
83
95
84
96
EXAMPLE CONFIGURATION
85
97
86
98
>lua
87
-
config = function()
88
-
require('yankbank').setup({
89
-
max_entries = 9,
90
-
sep = "",
91
-
num_behavior = "prefix",
92
-
focus_gain_poll = true,
93
-
keymaps = {
94
-
navigation_next = "j",
95
-
navigation_prev = "k",
96
-
},
97
-
num_behavior = "prefix",
98
-
persist_type = "sqlite",
99
-
registers = {
100
-
yank_register = "+",
101
-
},
102
-
})
103
-
end,
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,
104
115
<
105
116
106
117
If no separator is desired, pass in an empty string for `sep`
···
113
124
upon pressing numbers that prefix a valid entry.
114
125
115
126
116
-
PERSISTENCE
127
+
PERSISTENCE ~
117
128
118
129
If persistence between sessions is desired, sqlite.lua will be used to create a
119
130
persistent store for recent yanks in the plugin root directory. To utilize