Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gennaro-tedesco/nvim-peekup
👀 dynamically interact with vim registers
https://github.com/gennaro-tedesco/nvim-peekup
lua neovim
Last synced: 28 days ago
JSON representation
👀 dynamically interact with vim registers
- Host: GitHub
- URL: https://github.com/gennaro-tedesco/nvim-peekup
- Owner: gennaro-tedesco
- License: mit
- Created: 2021-02-10T02:25:23.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T13:32:16.000Z (almost 2 years ago)
- Last Synced: 2024-10-19T11:14:28.639Z (about 2 months ago)
- Topics: lua, neovim
- Language: Lua
- Homepage:
- Size: 10.2 MB
- Stars: 297
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - gennaro-tedesco/nvim-peekup - Dynamically interact with Vim registers. (Register / PHP)
README
nvim-peekup
neovim registers made easy!
Installation •
Usage •
Features in short •
Customisation •
Feedback
Finally vim registers made easy and fun! No more headaches with cumbersome keystrokes `"p`, no more forgetting where the yanked text is: peek into the vim registers in floating window and pick up the text you want with `nvim-peekup`!
## Installation
Install it using your favourite plugin manager; for instance if you are using vim-plug
```
Plug 'gennaro-tedesco/nvim-peekup'
```
## Usage
Open the peekup window with the default keymapping `""`. Scroll and browse the list of registers ordered by type and select the register you want by simply pressing the corresponding character (letter or number, no need to prepend `"`): you receive visual confirmation for your choice and the text is copied into the default register. The peekup window automatically closes and you can now easily put (`p`) your yanked text anywhere you want.
`` to manually close the window otherwise (the peekup window closes automatically also when changing windows focus).
Default commands
| key | description |
| :--------------- | :----------------------------------------------------- |
| `""` | open peekup window |
| `` | close peekup window |
| any character | select and copy text from the corresponding " register |
| ``, `` | scroll the list up and down |
| ``, `` | move to next registers type |
| `"x` | empty all registers (outside the peekup window) |
Notice that since characters keystrokes copy the text from the corresponding register, the peekup window does not obey the standard vim motion commands. Arrow keys move among registers sections (they can also use the corresponding marks `'n, 'l, 's`).
To change default mapping to open the peekup window simply specify the right hand side of
```
let g:peekup_open = '"'
```
If you want to directly paste before or after the current cursor position (without having to issue `p` after the selection) simply specify values for the options
```
let g:peekup_paste_before = 'P'
let g:peekup_paste_after = 'p'
```
Exposed interfaces
| option | method | description |
| :----------------------- | :--------------------------- | :------------------------------------------ |
| g:peekup_open | `PeekupOpen` | open peekup window and interact |
| g:peekup_paste_before | `PeekupPasteBefore` | directly paste before cursor upon selection |
| g:peekup_paste_after | `PeekupPasteAfter` | directly paste after cursor upon selection |
| g:peekup_empty_registers | `PeekupEmptyRegisters` | clear all registers |
see also `:help peekup-usage`.
## Features in short
- peekup floating window with registers content
- visual confirmation of selected text
- peekup closes automatically, put (`p`) the yanked text anywhere
- keymap to empty all registers
- fully customisable layout and behaviour
## Customisation
The look and the behaviour of the registers floating window is fully customisable. In order to do so simply override the [dictionary configuration entries](https://github.com/gennaro-tedesco/nvim-peekup/blob/master/lua/nvim-peekup/config.lua) specifying the below in your nvim configurations (init.vim or any other option file being sourced at start-up), say
```
" geometry configuration
lua require('nvim-peekup.config').geometry["height"] = 0.8
lua require('nvim-peekup.config').geometry["title"] = 'An awesome window title'
lua require('nvim-peekup.config').geometry["wrap"] = false
```
`width` and `height` are to be expressed as ratios of the entire window size, therefore 0 < x < 1.
```
" behaviour of the peekup window on keystroke
lua require('nvim-peekup.config').on_keystroke["delay"] = '300ms'
lua require('nvim-peekup.config').on_keystroke["autoclose"] = false
lua require('nvim-peekup.config').on_keystroke["paste_reg"] = '"'
```
`delay` expresses the delay before the peekup window closes automatically, after selecting the register. Obviously, `autoclose` set to false prevents such behaviour (and the user must close the window manually).
`delay` can be set to the empty string to not delay at all, i.e.:
```
lua require('nvim-peekup.config').on_keystroke["delay"] = ''
```
The selected paste goes into the default register `*`: change accordingly if needed (notice you may need to `set clipboard+=unnamed` for this to work).
## Help tags
Access the documentation with `:h nvim-peekup`.
## Unit tests
We make use of the busted framework for unit tests; run them with
```
busted -C lua
```
## Feedback
If you find this plugin useful consider awarding it a ⭐, it is a great way to give feedback! Otherwise, any additional suggestions or merge request is warmly welcome!
This plugin was inspired by [vim-peekaboo](https://github.com/junegunn/vim-peekaboo), which in addition also allows to paste in insert mode. However, `nvim-peekup` offers a fresh interactive and visual experience with registers and, not that it matters, is in average more than 4 times faster at start-up:
```
nvim --startuptime start.log -c quit && grep "peekup|peekaboo" start.log
elapsed
000.051 000.051: sourcing ~/.config/nvim/plugged/nvim-peekup/plugin/nvim-peekup.vim
000.212 000.212: sourcing ~/.config/nvim/plugged/vim-peekaboo/plugin/peekaboo.vim
000.195 000.195: sourcing ~/.config/nvim/plugged/vim-peekaboo/autoload/peekaboo.vim
```