Lspsaga

https://nvimdev.github.io/lspsaga
Admin
Lspsaga is a Neovim plugin that enhances the built-in LSP experience with features like diagnostic...
Tokens:10,967
Snippets:31
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Lspsaga Setup with Diagnostic Options

Source: https://nvimdev.github.io/lspsaga/diagnostic

Provides an example of configuring Lspsaga's diagnostic module. This includes setting the maximum height for diagnostic windows and customizing keybindings, such as the 'quit' key for the diagnostic jump window.

```lua
require('lspsaga').setup({
    diagnostic = {
        max_height = 0.8,
        keys = {
            quit = {'q', '<ESC>'}
        }
    },
})

```

--------------------------------

### Install lspsaga.nvim with packer.nvim

Source: https://nvimdev.github.io/lspsaga/index

This code snippet shows the installation of the lspsaga.nvim plugin using the packer.nvim package manager. It specifies that lspsaga.nvim should be loaded after nvim-lspconfig and includes a configuration function to set up the plugin.

```lua
use ({
    'nvimdev/lspsaga.nvim',
    after = 'nvim-lspconfig',
    config = function()
        require('lspsaga').setup({})
    end,
})

```

--------------------------------

### Install lspsaga.nvim with lazy.nvim

Source: https://nvimdev.github.io/lspsaga/index

This code snippet demonstrates how to install the lspsaga.nvim plugin using the lazy.nvim package manager for Neovim. It includes optional dependencies like nvim-treesitter and nvim-web-devicons and shows how to configure lspsaga upon setup. Lazy loading options are also mentioned.

```lua
require('lazy').setup({
    'nvimdev/lspsaga.nvim',
    config = function()
        require('lspsaga').setup({})
    end,
    dependencies = {
        'nvim-treesitter/nvim-treesitter', -- optional
        'nvim-tree/nvim-web-devicons',     -- optional
    }
})

```

--------------------------------

### Lspsaga Hover Usage and Keymap

Source: https://nvimdev.github.io/lspsaga/hover

Demonstrates how to use the `:Lspsaga hover_doc` command to display documentation in Neovim. It also provides an example of setting a keymap for this command.

```vimscript
vim.keymap.set('n', 'K', '<cmd>Lspsaga hover_doc')
```

--------------------------------

### Lspsaga Finder Command Usage

Source: https://nvimdev.github.io/lspsaga/finder

Shows examples of using the Lspsaga finder command in Neovim to search for LSP methods. It illustrates how to specify default search results and custom methods directly from the command line.

```vimscript
:Lspsaga finder ref
:Lspsaga finder def+ref
:Lspsaga finder tyd+ref+imp+def
:Lspsaga finder ++normal
```

--------------------------------

### Lspsaga Scrolling Keymaps

Source: https://nvimdev.github.io/lspsaga/misc

Defines keybindings for scrolling within the preview window for commands that support it. The example shows default mappings for scrolling down and up.

```lua
require('lspsaga').setup({
  scroll_preview = {
    scroll_down = '<C-f>',
    scroll_up = '<C-b>'
  }
})
```

--------------------------------

### Get Breadcrumb String for Statusline/Winbar

Source: https://nvimdev.github.io/lspsaga/breadcrumbs

This Lua function retrieves the formatted breadcrumb string suitable for use in a Neovim statusline or winbar. It's part of the Lspsaga plugin's symbol module.

```lua
require('lspsaga.symbol.winbar').get_bar()
```

--------------------------------

### Lspsaga Diagnostic Navigation and Preview

Source: https://nvimdev.github.io/lspsaga/diagnostic

Demonstrates how to navigate between diagnostics using custom keymaps and preview code actions within the diagnostic window. It shows setting up keybindings for `diagnostic_jump_next` and `diagnostic_jump_prev`, and using shortcuts like `<C-f>` and `<C-b>` for previewing actions.

```vimscript
vim.keymap.set('n', '[e', '<cmd>Lspsaga diagnostic_jump_next')

```

--------------------------------

### Lspsaga Implement Usage and Configuration

Source: https://nvimdev.github.io/lspsaga/implement

This snippet demonstrates how to use the Lspsaga 'Implement' feature to search and preview interface implementations within Neovim. It also outlines the default configuration options required for its functionality, such as enabling breadcrumbs and setting virtual text preferences.

```vimscript
function!LspsagaFinderImplement() abort
  call NvimSaga.finder.implement()
endfunction

" Enable the breadcrumbs feature
let g:lspsaga_options.symbols_in_winbar.enable = true

" Default options for implement module
let g:lspsaga_options.implement = {
      \ 'enable': true,
      \ 'sign': true,
      \ 'virtual_text': true,
      \ 'priority': 100
      \ }
```

--------------------------------

### Configure Lspsaga LightBulb Sign

Source: https://nvimdev.github.io/lspsaga/lightbulb

This snippet shows how to configure the sign used for code actions in the Lspsaga plugin. It demonstrates modifying the `ui.code_action` setting within the `lspsaga.setup` function.

```lua
require('lspsaga').setup({
    ui = {
        code_action = 'your icon'
    }
})

```

--------------------------------

### Configure Lspsaga Finder

Source: https://nvimdev.github.io/lspsaga/finder

Demonstrates how to configure the Lspsaga Finder in Neovim using Lua. This includes setting the maximum height, customizing keymaps, and defining custom LSP methods for search.

```lua
require('lspsaga').setup({
  finder = {
    max_height = 0.6,
    keys = {
      vsplit = 'v',
    },
    methods = {
      'tyd' = 'textDocument/typeDefinition'
    }
  }
})
```

--------------------------------

### Lspsaga Rename Command

Source: https://nvimdev.github.io/lspsaga/rename

Executes the Lspsaga rename functionality. It opens a float input window and highlights references in the current buffer. The `++project` flag integrates with project-wide replace after LSP rename.

```vimscript
:Lspsaga rename
:Lspsaga lsp_rename mode=n
:Lspsaga project_replace old_name new_name
:Lspsaga lsp_rename ++project
```

--------------------------------

### Lspsaga Code Action Usage

Source: https://nvimdev.github.io/lspsaga/codeaction

This snippet shows how to invoke the Lspsaga code action command in Neovim. It also provides tips on using action shortcuts and navigating through available actions.

```vimscript
Usage:
Use `:Lspsaga code_action` to invoke.

Tips:
  * If you know the action do, just press the action number.
  * If you don’t know what the action do, move to it. Take a look at the action preview, then press `<CR>`.
```

--------------------------------

### Lspsaga Code Action Default Options

Source: https://nvimdev.github.io/lspsaga/codeaction

This section outlines the default configuration options for the Lspsaga code action feature. These options control aspects like number shortcuts and server name display.

```vimscript
Default Options in `code_action` section:
  * `num_shortcut = true` whether number shortcut for code actions are enabled
  * `show_server_name = false` show language server name
  * `extend_gitsigns = false` extend gitsigns plugin diff action
```

--------------------------------

### Lspsaga Outline Default Keymaps

Source: https://nvimdev.github.io/lspsaga/outline

This snippet lists the default keybindings for interacting with the Lspsaga outline window. These keymaps allow users to navigate, toggle, and close the outline view.

```vimscript
-- Default keymaps in `outline.keys` section:
-- `toggle_or_jump = 'o'` toggle or jump
-- `quit = 'q'` quit outline window
-- `jump = 'e'` jump to pos even on a expand/collapse node
```

--------------------------------

### Lspsaga Rename Default Keymaps

Source: https://nvimdev.github.io/lspsaga/rename

Defines default key mappings for interacting with the rename and project replace float windows. Includes keys for quitting, executing, and selecting items.

```vimscript
rename.keys = {
  quit = '<C-k>',
  exec = '<CR>',
  select = 'x',
}
```

--------------------------------

### Lspsaga Beacon Configuration

Source: https://nvimdev.github.io/lspsaga/misc

Enables and configures the beacon feature in Lspsaga, which visually indicates the cursor's position when navigating between buffers. Users can enable the feature and set its update frequency.

```lua
require('lspsaga').setup({
  beacon = {
    enable = true,
    frequency = 7
  }
})
```

--------------------------------

### Lspsaga Outline Usage

Source: https://nvimdev.github.io/lspsaga/outline

This snippet shows the basic command to open the Lspsaga outline feature in Neovim. It is used to display the outline of the current code file.

```vimscript
:Lspsaga outline
```

--------------------------------

### Lspsaga UI Configuration

Source: https://nvimdev.github.io/lspsaga/misc

Configures the visual appearance of Lspsaga UI elements. Options include border styles, devicon integration, title display, custom icons for various features like code actions and implementations, and line drawing characters for virtual text.

```lua
require('lspsaga').setup({
  ui = {
    border = 'single', -- or 'none', 'double', 'rounded', 'solid', 'shadow'
    devicon = true,
    title = true,
    expand = '⊞',
    collapse = '⊟',
    code_action = '💡',
    actionfix = ' ',
    lines = { '┗', '┣', '┃', '━', '┏' },
    kind = {},
    imp_sign = '󰳛 '
  }
})
```

--------------------------------

### Lspsaga Callhierarchy Default Keymaps

Source: https://nvimdev.github.io/lspsaga/callhierarchy

Lists the default keybindings for interacting with the callhierarchy layout, including navigation and actions like editing or quitting.

```vimscript
edit = 'e'
vsplit = 's'
split = 'i'
tabe = 't'
quit = 'q'
shuttle = '[w'
toggle_or_req = 'u'
close = '<C-c>k'
```

--------------------------------

### Lspsaga Code Action Default Keymaps

Source: https://nvimdev.github.io/lspsaga/codeaction

This snippet details the default key mappings configured for the Lspsaga code action feature. These keymaps are used for interacting with the floating window, such as quitting or executing an action.

```vimscript
Default Keymaps in `code_action.keys` section:
  * `quit = 'q'` quit the float window
  * `exec = '<CR>'` execute action
```

--------------------------------

### Open File in Existing Split/Vsplit Window

Source: https://nvimdev.github.io/lspsaga/finder

Use the '++inexist' flag with the Lspsaga finder command to open files within an already existing split or vsplit window. This is useful when managing multiple windows and wanting to direct file openings to a specific pane.

```vimscript
:Lspsaga finder ++inexist

```

--------------------------------

### Lspsaga Outline Default Options

Source: https://nvimdev.github.io/lspsaga/outline

This section details the default configuration options for the Lspsaga outline feature. These options control the appearance and behavior of the outline window, such as its position, size, and auto-preview functionality. The breadcrumbs feature must be enabled for this module to work.

```vimscript
symbols_in_winbar.enable = true

-- Default options of `outline` section:
-- `win_position = 'right'` window position
-- `win_width = 30` window width
-- `auto_preview = true` auto preview when cursor moved in outline window
-- `detail = true` show detail
-- `auto_close = true` auto close itself when outline window is last window
-- `close_after_jump = false` close after jump
-- `layout = 'normal'` float or normal default is normal when is float above options will ignored
-- `max_height = 0.5` height of outline float layout
-- `left_width = 0.3` width of outline float layout left window
```

--------------------------------

### Lspsaga Callhierarchy Commands

Source: https://nvimdev.github.io/lspsaga/callhierarchy

Provides the primary commands for the callhierarchy module to view incoming and outgoing calls within Neovim.

```vimscript
:Lspsaga incoming_calls
:Lspsaga outgoing_calls
```

--------------------------------

### Configure Lspsaga Definition Keymaps

Source: https://nvimdev.github.io/lspsaga/definition

This Lua code snippet shows how to configure the keymaps for the definition feature in the Lspsaga Neovim plugin. It specifically demonstrates how to set a single character keymap for the 'edit' action to avoid conflicts with default keybindings.

```lua
require('lspsaga').setup({
    definition = {
        keys = {
            edit = 'o'
        }
    }
})

```

--------------------------------

### Lspsaga Rename Default Options

Source: https://nvimdev.github.io/lspsaga/rename

Configures default behavior for the rename feature. Options include `in_select` for selecting text in the float window, `auto_save` to save files after renaming, and `project_max_width`/`project_max_height` for the project replace float window.

```vimscript
rename = {
  in_select = true,
  auto_save = false,
  project_max_width = 0.5,
  project_max_height = 0.5,
}
```

--------------------------------

### Lspsaga Diagnostic Jump Filter by Severity

Source: https://nvimdev.github.io/lspsaga/diagnostic

Illustrates how to create a custom keymap to jump only over diagnostics of a specific severity level, such as ERROR. This uses the `goto_prev` function from the `lspsaga.diagnostic` module.

```lua
keymap("n", "[E", function()
  require("lspsaga.diagnostic"):goto_prev({ severity = vim.diagnostic.severity.ERROR })
end)

```

--------------------------------

### Toggle Float Terminal in Neovim

Source: https://nvimdev.github.io/lspsaga/floaterm

This snippet shows how to bind the Lspsaga term_toggle command to a keymap in Neovim. It allows users to easily open and close the float terminal with a keyboard shortcut.

```vimscript
vim.keymap.set({'n','t', '<A-d>', '<cmd>Lspsaga term_toggle'})
```

--------------------------------

### Lspsaga Callhierarchy Layout Override

Source: https://nvimdev.github.io/lspsaga/callhierarchy

Demonstrates how to override the default layout option for callhierarchy commands by appending a layout argument.

```vimscript
:Lspsaga incoming_calls ++normal
```

--------------------------------

### Disable Neovim Default Virtual Text

Source: https://nvimdev.github.io/lspsaga/diagnostic

Shows how to disable Neovim's default virtual text for diagnostics to avoid redundancy when Lspsaga's virtual text is enabled. This is done by configuring Neovim's diagnostic settings.

```lua
vim.diagnostic.config({
    virtual_text = false
})

```

--------------------------------

### Filter LSP Search Results with Lua

Source: https://nvimdev.github.io/lspsaga/finder

Configure the LSP Saga finder to filter results for specific methods using Lua functions. The function receives client ID and the result, returning a boolean to determine inclusion. This allows custom logic for displaying search results.

```lua
require('lspsaga').setup({
  finder = {
    filter = {
      ['textDocument/references']  = function(client_id, result) -- your logic
        return true
      end
    }
  }
})

```
Tokens:
Raw