https://github.com/junkblocker/lsp_lines.nvim
Show nvim diagnostics using virtual lines (Unofficial mirror)
https://github.com/junkblocker/lsp_lines.nvim
Last synced: about 1 year ago
JSON representation
Show nvim diagnostics using virtual lines (Unofficial mirror)
- Host: GitHub
- URL: https://github.com/junkblocker/lsp_lines.nvim
- Owner: junkblocker
- License: isc
- Created: 2024-10-11T03:15:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-22T17:15:59.000Z (over 1 year ago)
- Last Synced: 2025-02-08T05:28:02.328Z (over 1 year ago)
- Language: Lua
- Homepage: https://git.sr.ht/~whynothugo/lsp_lines.nvim
- Size: 382 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lsp_lines.nvim
[Source](https://git.sr.ht/~whynothugo/lsp_lines.nvim) |
[Issues](https://todo.sr.ht/~whynothugo/lsp_lines.nvim) |
[Discussion/Patches](https://lists.sr.ht/~whynothugo/lsp_lines.nvim) |
[Chat](irc://ircs.libera.chat:6697/#whynothugo) |
[Sponsor](https://whynothugo.nl/sponsor/)
`lsp_lines` is a simple neovim plugin that renders diagnostics using virtual
lines on top of the real line of code.
Font is [Fira Code][font], a classic.
Theme is [tokyonight.nvim][theme].
[font]: https://github.com/tonsky/FiraCode
[theme]: https://github.com/folke/tokyonight.nvim
# Background
LSPs provide lots of useful diagnostics for code (typically: errors, warnings,
linting). By default they're displayed using virtual text at the end of the
line which in some situations might be good enough, but often the diagnostic
simply doesn't fit on screen. It's also quite common to have more than one
diagnostic per line, but there's no way to view more than the first.
`lsp_lines` solves this issue.
# Installation
Clone this repository into neovim's plug-in directory:
mkdir -p ~/.local/share/nvim/site/pack/plugins/start/
cd ~/.local/share/nvim/site/pack/plugins/start/
git clone git@git.sr.ht:~whynothugo/lsp_lines.nvim
You may also use a plug-in manager that does this for you.
## With packer.nvim
Using packer.nvim (this should probably be registered _after_ `lspconfig`):
```lua
use({
"https://git.sr.ht/~whynothugo/lsp_lines.nvim",
config = function()
require("lsp_lines").setup()
end,
})
```
# Setup
When using this plug-in, the regular virtual text diagnostics becomes
redundant. It is recommended to disable it:
```lua
-- Disable virtual_text since it's redundant due to lsp_lines.
vim.diagnostic.config({
virtual_text = false,
})
```
# Usage
This plugin's functionality can be disabled with:
```lua
vim.diagnostic.config({ virtual_lines = false })
```
And it can be re-enabled via:
```lua
vim.diagnostic.config({ virtual_lines = true })
```
To show virtual lines only for the current line's diagnostics:
```lua
vim.diagnostic.config({ virtual_lines = { only_current_line = true } })
```
If you don't want to highlight the entire diagnostic line, use:
```lua
vim.diagnostic.config({ virtual_lines = { highlight_whole_line = false } })
```
A helper is also provided to toggle, which is convenient for mappings:
```lua
vim.keymap.set(
"",
"l",
require("lsp_lines").toggle,
{ desc = "Toggle lsp_lines" }
)
```
# Development
It would be nice to show connecting lines when there's relationship between
diagnostics (as is the case with `rust_analyzer`). Or perhaps surface them via
`vim.lsp.buf.hover`.
# Licence
This project is licensed under the ISC licence. See LICENCE for more details.