plugins.yanky.ring.cancelEvent
Define the event used to cancel ring activation.
update
will cancel ring on next buffer update, move
will cancel ring when moving
cursor or content changed.
Plugin default: "update"
Type: null or one of “update”, “move” or raw lua code
Default:
null
Declared by:
plugins.yanky.ring.historyLength
Define the number of yanked items that will be saved and used for ring.
Plugin default: 100
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Declared by:
plugins.yanky.ring.ignoreRegisters
Define registers to be ignored. By default the black hole register is ignored.
Plugin default: ["_"]
Type: null or (list of string)
Default:
null
Declared by:
plugins.yanky.ring.storage
Define the storage mode for ring values.
Using shada
, this will save pesistantly using Neovim ShaDa feature.
This means that history will be persisted between each session of Neovim.
You can also use this feature to sync the yank history across multiple running instances
of Neovim by updating shada file.
If you execute :wshada
in the first instance and then :rshada
in the second instance,
the second instance will be synced with the yank history in the first instance.
Using memory
, each Neovim instance will have his own history and il will be lost between
sessions.
Sqlite is more reliable than ShaDa but requires more dependencies.
You can change the storage path using ring.storagePath
option.
Plugin default: "shada"
Type: null or one of “shada”, “sqlite”, “memory” or raw lua code
Default:
null
Declared by:
plugins.yanky.ring.storagePath
Only for sqlite storage.
Plugin default: {__raw = "vim.fn.stdpath('data') .. '/databases/yanky.db'";}
Type: null or string or raw lua code
Default:
null
Declared by:
plugins.yanky.ring.syncWithNumberedRegisters
History can also be synchronized with numbered registers. Every time the yank history changes the numbered registers 1 - 9 will be updated to sync with the first 9 entries in the yank history. See here for an explanation of why we would want do do this.
Plugin default: true
Type: null or boolean or raw lua code
Default:
null
Declared by:
plugins.yanky.ring.updateRegisterOnCycle
If true, when you cycle through the ring, the contents of the register used to update will be updated with the last content cycled.
Plugin default: false
Type: null or boolean or raw lua code
Default:
null
Declared by: