cseickel/goto-preview

⭐ Goto Preview

A small Neovim plugin for previewing native LSP's goto definition calls in floating windows.

🚀 Showcase

🔗 References

⚠️ IMPORTANT NOTE

There is currently an open Neovim TUI bug that prevents the correct positioning of more than one preview window. One singular preview window should work fine but jumping to a subsequent preview will position it in an undesired spot.

🎉 GUIs like Goneovim and Uivonim implement the correct positioning behaviour and will behave as intended.

⚠️ UPDATE

The issue is fixed in Neovim v0.6.0-dev (master) and is set for the milestone 0.5.1 at the time of writing. neovim/neovim#14770

📦 Installation

Packer.nvim

use {
  'rmagatti/goto-preview',
  config = function()
    require('goto-preview').setup {}
  end
}

⚙️ Configuration

Default

require('goto-preview').setup {
    width = 120; -- Width of the floating window
    height = 15; -- Height 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.
    post_open_hook = nil -- A function taking two arguments, a buffer and a window to be ran as a hook.
  }

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.

⌨️ 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

nnoremap gpd <cmd>lua require('goto-preview').goto_preview_definition()<CR>
nnoremap gpi <cmd>lua require('goto-preview').goto_preview_implementation()<CR>
nnoremap gP <cmd>lua require('goto-preview').close_all_win()<CR>

Custom example

vim.api.nvim_set_keymap("n", "gp", "<cmd>lua require('goto-preview').goto_preview_definition()<CR>", {noremap=true})

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 and textDocument/implementation 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

cseickel / goto-preview