Skip to content

README.md

Latest commit

 

History

History
295 lines (227 loc) · 6.71 KB

README.md

File metadata and controls

295 lines (227 loc) · 6.71 KB

hover.nvim

General framework for context aware hover providers (similar to vim.lsp.buf.hover).

Requires Nvim v0.11.0

Screenshots

LSP Github Issues
Dictionary Github User

Configuration

require('hover').config({
  --- List of modules names to load as providers.
  --- @type (string|Hover.Config.Provider)[]
  providers = {
    'hover.providers.diagnostic',
    'hover.providers.lsp',
    'hover.providers.dap',
    'hover.providers.man',
    'hover.providers.dictionary',
    -- Optional, disabled by default:
    -- 'hover.providers.gh',
    -- 'hover.providers.gh_user',
    -- 'hover.providers.jira',
    -- 'hover.providers.fold_preview',
    -- 'hover.providers.highlight',
  },
  preview_opts = {
    border = 'single'
  },
  -- Whether the contents of a currently open hover window should be moved
  -- to a :h preview-window when pressing the hover keymap.
  preview_window = false,
  title = true,
  mouse_providers = {
    'hover.providers.lsp',
  },
  mouse_delay = 1000
})

-- Setup keymaps
vim.keymap.set('n', 'K', function()
  require('hover').open()
end, { desc = 'hover.nvim (open)' })

vim.keymap.set('n', 'gK', function()
  require('hover').enter()
end, { desc = 'hover.nvim (enter)' })

vim.keymap.set('n', '<C-p>', function()
    require('hover').switch('previous')
end, { desc = 'hover.nvim (previous source)' })

vim.keymap.set('n', '<C-n>', function()
    require('hover').switch('next')
end, { desc = 'hover.nvim (next source)' })

-- Mouse support
vim.keymap.set('n', '<MouseMove>', function()
  require('hover').mouse()
end, { desc = 'hover.nvim (mouse)' })

vim.o.mousemoveevent = true

Appearance

The appearance of the hover window can be customized with the following highlight groups:

  • HoverWindow (defaults to: NormalFloat)
  • HoverBorder (defaults to: FloatBorder)
  • HoverSourceLine (defaults to: TabLine)
  • HoverActiveSource (defaults to: TabLineSel)
  • HoverInactiveSource (defaults to: TabLineFill)
  • HoverFloatingError (defaults to: DiagnosticFloatingError)
  • HoverFloatingWarn (defaults to: DiagnosticFloatingWarn)
  • HoverFloatingInfo (defaults to: DiagnosticFloatingInfo)
  • HoverFloatingHint (defaults to: DiagnosticFloatingHint)

Customising providers

Note: Only supported for providers created with passive registration.

Instead of passing a string entry to providers in config(), an object can be passed with additional keys to customise fields.

require('hover').config({
  providers = {
    {
      module = 'hover.providers.diagnostic',
      priority = 2000,
      name = 'Diags'
    }
  }
})

Built in Providers

LSP

Module: hover.providers.lsp Priority: 1000

Builtin LSP. Suppors multiple clients.

Diagnostics

Module: hover.providers.diagnostic Priority: 1001

Diagnostics using vim.diagnostic

DAP

Module: hover.providers.dap Priority: 1002

DAP hover

Fold Previewing

Module: hover.providers.fold_preview Priority: 1003

Preview closed fold under cursor

Github: Issues and PR's

Module: hover.providers.gh Priority: 200

Opens issue/PR's for symbols like #123.

Note: Requires the gh command.

Github: Users

Module: hover.providers.gh_user Priority: 200

Information for github users in TODO comments. Matches TODO(<user>) and TODO(@<user>).

Note: Requires the gh command.

Jira

Module: hover.providers.jira Priority: 175

Opens issue for symbols like ABC-123.

Requires the jira command.

Man

Module: hover.providers.man Priority: 150

man entries

Dictionary

Module: hover.providers.dictionary Priority: 100

Definitions for valid words

Highlight

Module: hover.providers.highlight

Highlight group preview using vim.inspect_pos

Creating a hover provider

Create a module in runtimepath which returns a Hover.Provider or Hover.ProviderGroup object. This module will be loaded by hover.nvim when hover is triggered.

Hover.ProviderGroup can be used to create multiple providers. These providers can even be added/removed at runtime by modifying the groups providers field. E.g. LSP providers are added on the LspAttach autocommand event.

Example: Hover.Provider:

In myplugin/simple_provider.lua

return {
   name = 'Simple',
   priority = 1000,
   --- @param bufnr integer
   enabled = function(bufnr)
     return true
   end,
   --- @param params Hover.Provider.Params
   --- @param done fun(result?: false|Hover.Result)
   execute = function(params, done)
     done{lines={'TEST'}, filetype="markdown"}
   end
}
require('hover').config({
    providers = {
        'myplugin.simple_provider'
    }
})

Example: Hover.ProviderGroup:

In myplugin/simple_provider.lua

local simple_provider = {
  name = 'Simple',
  --- @param bufnr integer
  enabled = function(bufnr)
    return true
  end,
  --- @param params Hover.Provider.Params
  --- @param done fun(result?: false|Hover.Result)
  execute = function(params, done)
    done{lines={'TEST'}, filetype="markdown"}
  end
}

return {
   priority = 1000,
   providers = { simple_provider }
}
require('hover').config({
    providers = {
        'myplugin.simple_provider'
    }
})

API

--- @class Hover.Provider
--- @field name string
---
--- Whether the hover is active for the current context
--- @field enabled? fun(bufnr: integer, opts?: Hover.Options): boolean
---
--- Executes the hover
--- If the hover should not be shown for whatever reason call done with `nil` or
--- `false`.
--- @field execute fun(params: Hover.Provider.Params, done: fun(result?: false|Hover.Provider.Result))
--- @field priority? integer

--- @class Hover.Provider.Params
--- @field bufnr integer
--- @field pos [integer, integer]

--- @class Hover.Provider.Result
---
--- @field lines? string[]
---
--- @field filetype? string
---
--- Use a pre-populated buffer for the hover window. Ignores `lines`.
--- @field bufnr? integer

--- @class Hover.ProviderGroup
--- @field name? string
--- @field priority? integer -- overrides individual priorities
--- @field providers Hover.Provider[]