Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisgrieser/nvim-dr-lsp
Status line component showing the number of LSP definition and reference of the token under the cursor.
https://github.com/chrisgrieser/nvim-dr-lsp
lsp nvim-plugin statusline
Last synced: 3 months ago
JSON representation
Status line component showing the number of LSP definition and reference of the token under the cursor.
- Host: GitHub
- URL: https://github.com/chrisgrieser/nvim-dr-lsp
- Owner: chrisgrieser
- License: mit
- Created: 2023-06-02T11:41:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-17T12:22:39.000Z (5 months ago)
- Last Synced: 2024-10-14T07:32:22.736Z (3 months ago)
- Topics: lsp, nvim-plugin, statusline
- Language: Lua
- Homepage:
- Size: 66.4 KB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - chrisgrieser/nvim-dr-lsp - Status line component showing the number of LSP definition and reference of the token under the cursor. (LSP / (requires Neovim 0.5))
README
# nvim-dr-lsp 👨⚕️👩⚕️
`D`efinitions and `R`eferences utility for the LSP.
Lightweight plugin that highlights definitions and references of the word under
the cursor and displays their count in the statusline.
- [Installation](#installation)
- [Configuration](#configuration)
- [Highlight references for the word under the cursor](#highlight-references-for-the-word-under-the-cursor)
- [Statusline: definition and reference count](#statusline-definition-and-reference-count)
- [Similar Plugins](#similar-plugins)
- [Credits](#credits)
## Installation
The plugin requires at least nvim 0.10.
```lua
-- lazy.nvim
{
"chrisgrieser/nvim-dr-lsp",
event = "LspAttach",
opts = {},
},
-- packer
use {
"chrisgrieser/nvim-dr-lsp",
config = function() require("dr-lsp").setup({}) end,
}
```
## Configuration
```lua
-- default config
require("dr-lsp").setup {
highlightCursorWordReferences = {
enable = true,
},
}
```
## Highlight references for the word under the cursor
- Definitions are under-dashed, references are under-dotted.
- The time for the highlights to show up depends on the [updatetime
option](https://neovim.io/doc/user/options.html#'updatetime'). It's
recommended to set it to something like 300 ms.
> [!NOTE]
> In a previous version of this plugin, the highlights were enabled
> automatically. Now, the highlights are only enabled when the `.setup()` call
> is made.
## Statusline: definition and reference count
Definitions and references **inside** current buffer:
```text
LSP: 2D 6R
```
Definitions or references **outside** current buffer
```text
LSP: 1(2)D 4(10)R
```
- 1 definition in the current buffer
- 2 definitions in the workspace
- 4 references in the current buffer
- 10 definitions in the workspace
```lua
-- adding the component to lualine.nvim
{
sections = {
lualine_c = {
{ require("dr-lsp").lspCount },
},
}
}
```
There are no built-in options to format the components, since formatting can
already be done with most statusline plugins. With `Lualine`, for example, you can
use the [`fmt` option](https://github.com/nvim-lualine/lualine.nvim#global-options):
```lua
lualine_c = {
{
require("dr-lsp").lspCount,
-- remove the letters from the component
fmt = function(str) return str:gsub("[RD]", "") end,
},
},
```
Alternatively, `require("dr-lsp").lspCountTable()` returns the `lspCount`
information as lua table for custom formatting:
```lua
{
file = {
definitions = 1,
references = 4,
},
workspace = {
definitions = 2,
references = 10,
},
}
```
## Similar Plugins
- [LSP-Lens](https://github.com/VidocqH/lsp-lens.nvim)
- [action-hints.nvim](https://github.com/roobert/action-hints.nvim)
- [symbol-usage.nvim](https://github.com/Wansmer/symbol-usage.nvim)
## Credits
In my day job, I am a sociologist studying the social mechanisms underlying the
digital economy. For my PhD project, I investigate the governance of the app
economy and how software ecosystems manage the tension between innovation and
compatibility. If you are interested in this subject, feel free to get in touch.
- [Academic Website](https://chris-grieser.de/)
- [Mastodon](https://pkm.social/@pseudometa)
- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)
- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)
