plugins.yanky.settings.ring.cancel_event

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.

Type: null or one of “update”, “move” or raw lua code

Default: null

Plugin default: "update"

Declared by:

plugins.yanky.settings.ring.history_length

Define the number of yanked items that will be saved and used for ring.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 100

Declared by:

plugins.yanky.settings.ring.ignore_registers

Define registers to be ignored. By default the black hole register is ignored.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "_"
]

Declared by:

plugins.yanky.settings.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.

Type: null or one of “shada”, “sqlite”, “memory” or raw lua code

Default: null

Plugin default: "shada"

Declared by:

plugins.yanky.settings.ring.storage_path

Only for sqlite storage.

Type: null or string or raw lua code

Default: null

Plugin default:

{
  __raw = "vim.fn.stdpath('data') .. '/databases/yanky.db'";
}

Declared by:

plugins.yanky.settings.ring.sync_with_numbered_registers

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.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.yanky.settings.ring.update_register_on_cycle

If true, when you cycle through the ring, the contents of the register used to update will be updated with the last content cycled.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: