Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soulis-1256/hoverhints.nvim
Show diagnostics and lsp info inside a custom window, following the mouse position
https://github.com/soulis-1256/hoverhints.nvim
lua neovim neovim-plugin
Last synced: about 2 months ago
JSON representation
Show diagnostics and lsp info inside a custom window, following the mouse position
- Host: GitHub
- URL: https://github.com/soulis-1256/hoverhints.nvim
- Owner: soulis-1256
- License: apache-2.0
- Created: 2023-10-24T14:03:00.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-17T13:50:40.000Z (5 months ago)
- Last Synced: 2024-05-23T00:13:50.979Z (4 months ago)
- Topics: lua, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 145 KB
- Stars: 187
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# eagle.nvim
***To soar like an eagle is to rise above all the obstacles that come your way.***
Following your mouse cursor, this plugin introduces a custom floating (popup) window that displays any Diagnostic (Error, Warning, Hint) with the help of the Diagnostic API of Neovim, along with LSP Information, from the LSP API.
### Overview
Enhance your Neovim experience by utilizing the following features:
- Detect when the mouse hovers over an underlined part of code. Once it goes idle (for a [configurable](./lua/eagle/config.lua) amount of time), the window will be invoked. I tried to mirror the way conventional GUI Editors like VS Code work.
- Display the Diagnostics under the current mouse position. If there are multiple diagnostics on the same position (ie Error and Warning), display them all in a numbered list. For better user experience, the window is re-rendered only once the mouse encounters a "special" character (like "{}.?:" and more). This means that it stays open if it detects mouse movement and you are still hovering over the same variable/function/operator name.
- Show LSP information (the same contents as with vim.lsp.buf.hover()).
This was a C++ workspace, with clangd and clang-tidy configured. You can also shift+click the href links to open them in your browser.
### Installation
Using [Lazy](https://github.com/folke/lazy.nvim):
```lua
{
"soulis-1256/eagle.nvim"
},
```
> [!IMPORTANT]\
> Until I test it and add it here, don't try setting additional Lazy properties (like main, config, opts) as an alternative way to setup the plugin.
### Setup
```lua
require("eagle").setup({
-- override the default values found in config.lua
})
-- make sure mousemoveevent is enabled
vim.o.mousemoveevent = true
```
You can find the description of all the options in [config.lua](./lua/eagle/config.lua).
> [!NOTE]\
> The plugin has been tested on Neovim versions 0.9.4, 0.9.5 and 0.10.0
### Support
You can support me by donating through [PayPal](https://www.paypal.com/paypalme/soulis1256) and by providing your feedback. You can message me on [Discord](https://discord.com/users/319490489411829761).