Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kkharji/lspsaga.nvim
The neovim language-server-client UI
https://github.com/kkharji/lspsaga.nvim
Last synced: about 2 months ago
JSON representation
The neovim language-server-client UI
- Host: GitHub
- URL: https://github.com/kkharji/lspsaga.nvim
- Owner: kkharji
- License: mit
- Created: 2021-02-14T05:19:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T04:37:39.000Z (3 months ago)
- Last Synced: 2024-06-25T22:41:54.267Z (3 months ago)
- Language: Lua
- Homepage:
- Size: 307 KB
- Stars: 409
- Watchers: 5
- Forks: 43
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# lspsaga.nvim
A maintained fork of glepnir/lspsaga.nvim.
Lspsaga is light-weight lsp plugin based on neovim built-in lsp with highly a performant UI. [SEE IN ACTION](https://github.com/tami5/lspsaga.nvim/wiki)
## Features
TODO .......
## Install
### Packer
```lua
use { 'kkharji/lspsaga.nvim' } -- nightly
use { 'kkharji/lspsaga.nvim', branch = 'nvim6.0' or 'nvim51' } -- for specific version
```
## Requirements
- neovim/nvim-lspconfig
## Setup
Lspsaga support use command `Lspsaga` with completion or use lua function.
```lua
local lspsaga = require 'lspsaga'
lspsaga.setup { -- defaults ...
debug = false,
use_saga_diagnostic_sign = true,
-- diagnostic sign
error_sign = "",
warn_sign = "",
hint_sign = "",
infor_sign = "",
diagnostic_header_icon = " ",
-- code action title icon
code_action_icon = " ",
code_action_prompt = {
enable = true,
sign = true,
sign_priority = 40,
virtual_text = true,
},
finder_definition_icon = " ",
finder_reference_icon = " ",
max_preview_lines = 10,
finder_action_keys = {
open = "o",
vsplit = "s",
split = "i",
quit = "q",
scroll_down = "",
scroll_up = "",
},
code_action_keys = {
quit = "q",
exec = "",
},
rename_action_keys = {
quit = "",
exec = "",
},
definition_preview_icon = " ",
border_style = "single",
rename_prompt_prefix = "➤",
rename_output_qflist = {
enable = false,
auto_open_qflist = false,
},
server_filetype_map = {},
diagnostic_prefix_format = "%d. ",
diagnostic_message_format = "%m %c",
highlight_prefix = false,
}
```
## Example Keymapings
```lua
--- In lsp attach function
local map = vim.api.nvim_buf_set_keymap
map(0, "n", "gr", "Lspsaga rename", {silent = true, noremap = true})
map(0, "n", "gx", "Lspsaga code_action", {silent = true, noremap = true})
map(0, "x", "gx", ":Lspsaga range_code_action", {silent = true, noremap = true})
map(0, "n", "K", "Lspsaga hover_doc", {silent = true, noremap = true})
map(0, "n", "go", "Lspsaga show_line_diagnostics", {silent = true, noremap = true})
map(0, "n", "gj", "Lspsaga diagnostic_jump_next", {silent = true, noremap = true})
map(0, "n", "gk", "Lspsaga diagnostic_jump_prev", {silent = true, noremap = true})
map(0, "n", "", "lua require('lspsaga.action').smart_scroll_with_saga(-1, '')", {})
map(0, "n", "", "lua require('lspsaga.action').smart_scroll_with_saga(1, '')", {})
```
## Customize Appearance
### Colors
Colors can be simply changed by overwriting the default highlights groups LspSaga is using.
```vim
highlight link LspSagaFinderSelection Search
" or
highlight link LspSagaFinderSelection guifg='#ff0000' guibg='#00ff00' gui='bold'
```
The available highlight groups are:
| Group Name | Description |
| :----------------------- | :----------------------------------------------------------------|
| `LspSagaFinderSelection` | Currently active entry in the finder window that gets previewed. |
| `LspFloatWinNormal` | |
| `LspFloatWinBorder` | |
| `LspSagaBorderTitle` | |
| `TargetWord` | |
| `ReferencesCount` | |
| `DefinitionCount` | |
| `TargetFileName` | |
| `DefinitionIcon` | |
| `ReferencesIcon` | |
| `ProviderTruncateLine` | |
| `SagaShadow` | |
| `LspSagaFinderSelection` | |
| `DiagnosticTruncateLine` | |
| `DiagnosticError` | |
| `DiagnosticWarning` | |
| `DiagnosticInformation` | |
| `DiagnosticHint` | |
| `DefinitionPreviewTitle` | |
| `LspSagaShTruncateLine` | |
| `LspSagaDocTruncateLine` | |
| `LineDiagTuncateLine` | |
| `LspSagaCodeActionTitle` | |
| `LspSagaCodeActionTruncateLine` | |
| `LspSagaCodeActionContent` | |
| `LspSagaRenamePromptPrefix` | |
| `LspSagaRenameBorder` | |
| `LspSagaHoverBorder` | |
| `LspSagaSignatureHelpBorder` | |
| `LspSagaCodeActionBorder` | |
| `LspSagaAutoPreview` | |
| `LspSagaDefPreviewBorder` | |
| `LspLinesDiagBorder` | |
## Filetypes
Autocmds can be added for dedicated filetypes of LspSaga floating windows.
For example, one can use `` to close the hover window when jumping into it by calling `:Lspsaga hover_doc` twice.
```vim
augroup lspsaga_filetypes
autocmd!
autocmd FileType LspsagaHover nnoremap close!
augroup END
```
The available filetypes are:
* `LspsagaCodeAction`
* `LspsagaDiagnostic`
* `LspsagaFinder`
* `LspsagaFloaterm`
* `LspsagaHover`
* `LspsagaRename`
* `LspsagaSignatureHelp`
# License
MIT