Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmagatti/goto-preview
A small Neovim plugin for previewing definitions using floating windows.
https://github.com/rmagatti/goto-preview
hacktoberfest lua neovim neovim-plugin
Last synced: 14 days ago
JSON representation
A small Neovim plugin for previewing definitions using floating windows.
- Host: GitHub
- URL: https://github.com/rmagatti/goto-preview
- Owner: rmagatti
- License: apache-2.0
- Created: 2021-06-07T05:46:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T07:04:39.000Z (4 months ago)
- Last Synced: 2024-07-31T20:36:01.414Z (3 months ago)
- Topics: hacktoberfest, lua, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 125 KB
- Stars: 791
- Watchers: 3
- Forks: 27
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - rmagatti/goto-preview - Previewing native LSP's goto definition calls in floating windows. (LSP / (requires Neovim 0.5))
README
## ⭐ Goto Preview
A small Neovim plugin for previewing native LSP's goto definition, type definition, implementation, declaration and references calls in floating windows.
### 🚀 Showcase
#### 🔗 References
### ⚠️ IMPORTANT NOTE
Make sure you use Neovim `0.5.1` or GUIs like [Goneovim](https://github.com/akiyosi/goneovim) and [Uivonim](https://github.com/smolck/uivonim).
There is a bug in [Neovim `0.5`](https://github.com/neovim/neovim/issues/14735) that prevents the correct positioning of more than one preview window.
### 📦 Installation
[Lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"rmagatti/goto-preview",
event = "BufEnter",
config = true, -- necessary as per https://github.com/rmagatti/goto-preview/issues/88
}
```
[Packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'rmagatti/goto-preview',
config = function()
require('goto-preview').setup {}
end
}
```
[vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'rmagatti/goto-preview'
" Then at some later point (outside of the plug block):
:lua require('goto-preview').setup {}
```
### ⚙️ Configuration
**Default**
```lua
require('goto-preview').setup {
width = 120, -- Width of the floating window
height = 15, -- Height of the floating window
border = {"↖", "─" ,"┐", "│", "┘", "─", "└", "│"}, -- Border characters of the floating window
default_mappings = false, -- Bind default mappings
debug = false, -- Print debug information
opacity = nil, -- 0-100 opacity level of the floating window where 100 is fully transparent.
resizing_mappings = false, -- Binds arrow keys to resizing the floating window.
post_open_hook = nil, -- A function taking two arguments, a buffer and a window to be ran as a hook.
post_close_hook = nil, -- A function taking two arguments, a buffer and a window to be ran as a hook.
references = { -- Configure the telescope UI for slowing the references cycling window.
telescope = require("telescope.themes").get_dropdown({ hide_preview = false })
},
-- These two configs can also be passed down to the goto-preview definition and implementation calls for one off "peak" functionality.
focus_on_open = true, -- Focus the floating window when opening it.
dismiss_on_move = false, -- Dismiss the floating window when moving the cursor.
force_close = true, -- passed into vim.api.nvim_win_close's second argument. See :h nvim_win_close
bufhidden = "wipe", -- the bufhidden option to set on the floating window. See :h bufhidden
stack_floating_preview_windows = true, -- Whether to nest floating windows
preview_window_title = { enable = true, position = "left" }, -- Whether to set the preview window title as the filename
zindex = 1, -- Starting zindex for the stack of floating windows
}
```
The `post_open_hook` function gets called right before setting the cursor position in the new floating window.
One can use this to set custom key bindings or really anything else they want to do when a new preview window opens.
The `post_close_hook` function gets called right before closing the preview window. This can be used to undo any
custom key bindings when you leave the preview window.
### ⌨️ Mappings
There are no mappings by default, you can set `default_mappings = true` in the config to make use of the mappings I use or define your own.
**Default**
```viml
nnoremap gpd lua require('goto-preview').goto_preview_definition()
nnoremap gpt lua require('goto-preview').goto_preview_type_definition()
nnoremap gpi lua require('goto-preview').goto_preview_implementation()
nnoremap gpD lua require('goto-preview').goto_preview_declaration()
nnoremap gP lua require('goto-preview').close_all_win()
nnoremap gpr lua require('goto-preview').goto_preview_references()
```
**Custom example**
```lua
vim.keymap.set("n", "gp", "lua require('goto-preview').goto_preview_definition()", {noremap=true})
```
### 📚 Custom Options
The `close_all_win` function takes an optional table as an argument.
Example usage:
```lua
require("goto-preview").close_all_win { skip_curr_window = true }
```
### Window manipulation
One can manipulate floating windows with the regular Vim window moving commands. See `:h window-moving`.
Example:
### Supported languages
Goto Preview should work with LSP responses for most languages now! If something doesn't work as expected, drop an issue and I'll be happy to check it out!
**Note:** different language servers have potentially different shapes for the result of the `textDocument/definition`, `textDocument/typeDefinition`, `textDocument/implementation` and `textDocument/declaration` calls.
Until more are added one can pass in custom responses through the `lsp_configs` config value. Just follow the same pattern returning two values, a `target (string)` and a `cursor_position ({line_num, col_num})`. The `data` parameter is the `[1]` of the LSP's `result` of the definition/implementation calls and is what gets passed into the custom `get_config` function.
### Tested with
```
NVIM v0.5.0-dev+7d4f890aa
Build type: Release
LuaJIT 2.1.0-beta3
```