https://github.com/ErichDonGubler/lsp_lines.nvim

GitHub mirror of https://git.sr.ht/~whynothugo/lsp_lines.nvim to work around Windows issues with `packer.nvim`.
https://github.com/ErichDonGubler/lsp_lines.nvim

Last synced: 4 days ago
JSON representation

GitHub mirror of https://git.sr.ht/~whynothugo/lsp_lines.nvim to work around Windows issues with `packer.nvim`.

• Host: GitHub
• URL: https://github.com/ErichDonGubler/lsp_lines.nvim
• Owner: ErichDonGubler
• License: isc
• Archived: true
• Created: 2022-01-27T00:25:36.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-23T16:17:16.000Z (over 2 years ago)
• Last Synced: 2024-08-02T13:33:09.225Z (4 months ago)
• Language: Lua
• Size: 365 KB
• Stars: 128
• Watchers: 4
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# lsp_lines.nvim

`lsp_lines` is a simple neovim plugin that renders diagnostics using virtual

lines on top of the real line of code.

![A screenshot of the plugin in action](screenshot.png)

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 is in many cases good enough, but often there's more than one

diagnostic per line. It's also quite common to have more than one diagnostic

per line, but again, there's no handy way to read the whole thing.

`lsp_lines` solves this issue.

# Installation

## 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,

})

```

## With git

You can algo just clone the repo into neovim's plug-in directory:

    mkdir -p $HOME/.local/share/nvim/site/pack/plugins/start/

    cd $HOME/.local/share/nvim/site/pack/plugins/start/

    git clone [email protected]:~whynothugo/lsp_lines.nvim

And then in `init.lua`:

    require("lsp_lines").setup()

# Setup

It's recommended to also remove the regular virtual text diagnostics to avoid

pointless duplication:

```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 })

```

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" }

)

```

# Contributing

- Discussion or patches: ~whynothugo/[email protected]

- Bugs / Issues: https://todo.sr.ht/~whynothugo/lsp_lines.nvim

- Tips: https://ko-fi.com/whynothugo

# Development

It would be nice to show connecting lines when there's relationship between

diagnostics (as is the case with `rust_analyzer`). Oh perhaps surface them via

hover().

# Licence

This project is licensed under the ISC licence. See LICENCE for more details.