lsp_signature.nvim
A Neovim plugin that displays function signatures and parameter hints as you type, enhancing LSP integration.
What is lsp_signature.nvim?
lsp_signature.nvim is a Neovim plugin that enhances the built-in Language Server Protocol (LSP) signature help by providing real-time, visual function signature assistance while typing. It displays signatures in a floating window or as virtual text, highlights the current parameter, and supports multiple signatures for function overloads, improving coding efficiency for languages with complex APIs.
Neovim users (version 0.10+) who work with LSP-supported languages and want enhanced, non-intrusive signature help, particularly those using completion plugins that lack built-in signature support.
Developers choose this plugin for its lightweight, asynchronous design and high configurability, offering features like parameter highlighting, virtual text hints, and status line integration that go beyond Neovim's default LSP signature help without interfering with other plugins.
Overview
LSP signature hint as you type
Use Cases
Best For
- Enhancing Neovim's built-in LSP signature help with visual parameter highlighting and documentation.
- Working with languages that have complex function signatures or overloads, like Go, Lua, or Java.
- Integrating signature help into status lines or winbars for a persistent, non-intrusive view.
- Using virtual text for parameter hints to avoid floating window clutter during coding.
- Customizing signature display with floating window borders, positioning, and transparency to match editor themes.
- Troubleshooting signature help when using completion plugins that lack native support.
Not Ideal For
- Neovim users on versions below 0.10 who need stable, out-of-the-box signature help without managing legacy branches.
- Developers already using completion plugins like nvim-cmp with robust, integrated signature support, making this plugin redundant.
- Those seeking a plug-and-play experience; lsp_signature.nvim requires manual keymap setup and extensive UI configuration.
- Environments where terminal emoji support is lacking, causing virtual text hints (e.g., 🐼) to display incorrectly or crash.
Pros & Cons
Pros
Uses fully asynchronous LSP buffer requests to avoid blocking the editor, ensuring a smooth typing experience as highlighted in the README's 'Fully asynchronous lsp buf request' feature.
Provides parameter highlighting and virtual text hints, making it easier to track current parameters in complex signatures, demonstrated in the Golang and Lua examples with markdown and search highlighting.
Displays multiple signatures for function overloads and allows navigation with select_signature_key, essential for languages like Java or C++, as shown in the multiple signatures screenshots.
Offers extensive options for floating window borders, positioning, transparency, and keybindings, adaptable to various workflows, with detailed config examples covering over 30 settings.
Cons
No default keymaps are provided, and the extensive config options require manual tuning, as seen in the full configuration example, which can overwhelm users wanting a quick setup.
Floating windows can overlap with completion menus like cmp or coq, and virtual text emoji may not render correctly in all terminals, as noted in the Q&A section about troubleshooting.
Requires Neovim 0.10+ for full features, with older versions relying on separate, potentially less maintained branches, limiting compatibility for users on stable releases.
Frequently Asked Questions
Related Projects
nvim-lspconfigQuickstart configs for Nvim LSP
lspsaga.nvimimprove neovim lsp experience
none-ls.nvimnull-ls.nvim reloaded / Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
rustaceanvim🦀 Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.