nvim-navbuddy
A Neovim plugin that provides keyboard-centric breadcrumb navigation using LSP symbols in a popup display.
What is nvim-navbuddy?
nvim-navbuddy is a Neovim plugin that displays a hierarchical popup of code symbols (like classes, functions, and variables) from the Language Server Protocol (LSP). It enables developers to navigate and understand code structure efficiently without leaving the keyboard, similar to a file manager's breadcrumb view.
Neovim users who work with LSP-enabled languages and want a keyboard-centric interface for exploring and navigating code structure.
It provides a focused, minimalistic interface with vim-like keybindings inspired by the ranger file manager, offering interactive symbol actions and seamless integration with Neovim's LSP ecosystem for enhanced workflow efficiency.
Overview
A simple popup display that provides breadcrumbs feature using LSP server
Use Cases
Best For
- Navigating complex codebases with hierarchical symbol trees using LSP data.
- Keyboard-driven developers who prefer minimal mouse interaction for code exploration.
- Performing quick symbol actions like renaming, yanking, commenting, or creating folds directly from a navigation popup.
- Integrating fuzzy finding at the current navigation level via Telescope for rapid symbol searching.
- Customizing the display of LSP symbols with configurable icons, borders, and window layouts to match user themes.
- Automatically attaching to LSP servers or manually configuring them for specific buffers to maintain a streamlined setup.
Not Ideal For
- Users on Neovim versions below 0.8.0 or those avoiding dependency-heavy setups with nvim-lspconfig, nvim-navic, and nui.nvim.
- Developers working with languages that have poor or no LSP symbol support, as the plugin relies entirely on LSP data.
- Teams preferring mouse-driven interfaces or graphical IDEs with built-in navigation panels, due to its keyboard-centric design.
- Projects needing out-of-the-box functionality without Lua configuration, since setup requires manual LSP attachment or careful auto-attach settings.
Pros & Cons
Pros
Uses Language Server Protocol to extract symbol hierarchies, ensuring accurate and language-agnostic code structure representation from supported LSP servers.
Inspired by ranger file manager, it provides vim-like keybindings for all navigation and editing actions, minimizing mouse usage and enhancing workflow speed.
Supports actions like renaming, yanking, commenting, and creating folds directly from the popup, reducing context switches and improving productivity.
Offers configurable window layout, borders, icons, and node markers, allowing users to seamlessly match their Neovim themes and personal preferences.
Includes a fuzzy finder at the current navigation level for quick symbol searching, leveraging the popular Telescope plugin for enhanced discoverability.
Cons
Requires nvim-lspconfig, nvim-navic, and nui.nvim as core dependencies, adding setup overhead and potential for conflicts with other plugins.
Auto-attach is disabled by default, necessitating manual configuration for each LSP server, which can be tedious in multi-language environments.
The project has moved to a new GitHub repository, indicating a change in maintenance that might lead to breaking changes or reduced support continuity.
Setup and customization are done entirely in Lua, which may be less accessible for Vimscript purists or those new to Neovim's Lua API.
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.