DNLHC/glance.nvim

github github
lspneovim-0.5
stars 629
issues 11
subscribers 4
forks 15
CREATED

2022-11-24

UPDATED

2 months ago


Glance

A pretty window for previewing, navigating and editing your LSP locations in one place, inspired by vscode's peek preview.

Glance references screenshot

Features

  • Supports following LSP methods: definitions, type definitions, references, implementations
  • Automatically sets up highlights based on your colorscheme colors
  • Allows editing previewed buffer inside the floating window
  • Intuitive UI

Requirements

  • Properly configured LSP client
  • Neovim >= 0.7.0

Install

Install the plugin with your preferred plugin manager.

Vim Plug

Plug 'dnlhc/glance.nvim'

Packer

use({
  "dnlhc/glance.nvim",
  config = function()
    require('glance').setup({
      -- your configuration
    })
  end,
})

Configuration

The following is the default configuration:

-- Lua configuration
local glance = require('glance')
local actions = glance.actions

glance.setup({
  height = 18, -- Height of the window
  zindex = 45,

  -- By default glance will open preview "embedded" within your active window
  -- when `detached` is enabled, glance will render above all existing windows
  -- and won't be restiricted by the width of your active window
  detached = true,

  -- Or use a function to enable `detached` only when the active window is too small
  -- (default behavior)
  detached = function(winid)
    return vim.api.nvim_win_get_width(winid) < 100
  end,

  preview_win_opts = { -- Configure preview window options
    cursorline = true,
    number = true,
    wrap = true,
  },
  border = {
    enable = false, -- Show window borders. Only horizontal borders allowed
    top_char = '―',
    bottom_char = '―',
  },
  list = {
    position = 'right', -- Position of the list window 'left'|'right'
    width = 0.33, -- 33% width relative to the active window, min 0.1, max 0.5
  },
  theme = { -- This feature might not work properly in nvim-0.7.2
    enable = true, -- Will generate colors for the plugin based on your current colorscheme
    mode = 'auto', -- 'brighten'|'darken'|'auto', 'auto' will set mode based on the brightness of your colorscheme
  },
  mappings = {
    list = {
      ['j'] = actions.next, -- Bring the cursor to the next item in the list
      ['k'] = actions.previous, -- Bring the cursor to the previous item in the list
      ['<Down>'] = actions.next,
      ['<Up>'] = actions.previous,
      ['<Tab>'] = actions.next_location, -- Bring the cursor to the next location skipping groups in the list
      ['<S-Tab>'] = actions.previous_location, -- Bring the cursor to the previous location skipping groups in the list
      ['<C-u>'] = actions.preview_scroll_win(5),
      ['<C-d>'] = actions.preview_scroll_win(-5),
      ['v'] = actions.jump_vsplit,
      ['s'] = actions.jump_split,
      ['t'] = actions.jump_tab,
      ['<CR>'] = actions.jump,
      ['o'] = actions.jump,
      ['l'] = actions.open_fold,
      ['h'] = actions.close_fold,
      ['<leader>l'] = actions.enter_win('preview'), -- Focus preview window
      ['q'] = actions.close,
      ['Q'] = actions.close,
      ['<Esc>'] = actions.close,
      ['<C-q>'] = actions.quickfix,
      -- ['<Esc>'] = false -- disable a mapping
    },
    preview = {
      ['Q'] = actions.close,
      ['<Tab>'] = actions.next_location,
      ['<S-Tab>'] = actions.previous_location,
      ['<leader>l'] = actions.enter_win('list'), -- Focus list window
    },
  },
  hooks = {},
  folds = {
    fold_closed = '',
    fold_open = '',
    folded = true, -- Automatically fold list on startup
  },
  indent_lines = {
    enable = true,
    icon = '│',
  },
  winbar = {
    enable = true, -- Available strating from nvim-0.8+
  },
  use_trouble_qf = false -- Quickfix action will open trouble.nvim instead of built-in quickfix list window
})

Hooks

before_open

Runs after getting the results and before opening the window. Can be used to alter the default opening behavior or to modify the results (for example: filter out the unwanted locations)

Important: This is a blocking hook which means glance will not open unless you call the open callback.

Examples:

Don't open glance when there is only one result instead jump to that location

hooks = {
  before_open = function(results, open, jump, method)
    if #results == 1 then
      jump(results[1]) -- argument is optional
    else
      open(results) -- argument is optional
    end
  end,
}

Don't open glance when there is only one result and it is located in the current buffer, open otherwise

hooks = {
  before_open = function(results, open, jump, method)
    local uri = vim.uri_from_bufnr(0)
    if #results == 1 then
      local target_uri = results[1].uri or results[1].targetUri

      if target_uri == uri then
        jump(results[1])
      else
        open(results)
      end
    else
      open(results)
    end
  end,
}

before_close

Triggered right before the window is closed

after_close

Triggered after the window is closed

Usage

Commands

  • :Glance references show references of the word under the cursor from the LSP server
  • :Glance definitions show definitions of the word under the cursor from the LSP server
  • :Glance type_definitions show type definitions of the word under the cursor from the LSP server
  • :Glance implementations show implementations of the word under the cursor from the LSP server

Example keybindings

" VimScript
nnoremap gR <CMD>Glance references<CR>
nnoremap gD <CMD>Glance definitions<CR>
nnoremap gY <CMD>Glance type_definitions<CR>
nnoremap gM <CMD>Glance implementations<CR>
-- Lua
vim.keymap.set('n', 'gD', '<CMD>Glance definitions<CR>')
vim.keymap.set('n', 'gR', '<CMD>Glance references<CR>')
vim.keymap.set('n', 'gY', '<CMD>Glance type_definitions<CR>')
vim.keymap.set('n', 'gM', '<CMD>Glance implementations<CR>')

Highlights

The following list shows all the highlight groups defined for glance.nvim

  • GlancePreviewNormal
  • GlancePreviewMatch
  • GlancePreviewCursorLine
  • GlancePreviewSignColumn
  • GlancePreviewEndOfBuffer
  • GlancePreviewLineNr
  • GlancePreviewBorderBottom
  • GlanceWinBarFilename
  • GlanceWinBarFilepath
  • GlanceWinBarTitle
  • GlanceListNormal
  • GlanceListFilename
  • GlanceListFilepath
  • GlanceListCount
  • GlanceListMatch
  • GlanceListCursorLine
  • GlanceListEndOfBuffer
  • GlanceListBorderBottom
  • GlanceFoldIcon
  • GlanceIndent
  • GlanceBorderTop

Alternatives