barbecue.nvim
A VS Code inspired breadcrumbs plugin for Neovim that displays LSP context in the winbar.
What is barbecue.nvim?
barbecue.nvim is a Neovim plugin that adds Visual Studio Code-like breadcrumbs to the editor's winbar. It integrates with nvim-navic to fetch and display Language Server Protocol (LSP) context, helping developers quickly understand their code structure and navigate through deeply nested files.
Neovim users (version 0.8+) who want enhanced code navigation and structure visualization, particularly those working with language servers and deeply nested codebases.
It brings the intuitive breadcrumb navigation experience from modern IDEs to Neovim, offering clickable navigation, smart truncation for deep file trees, and extensive customization without cluttering the interface.
Overview
Visual Studio Code inspired breadcrumbs plugin for the Neovim editor
Use Cases
Best For
- Adding clickable breadcrumb navigation to Neovim's winbar for quick code navigation.
- Visualizing LSP-based code structure and context directly in the editor.
- Managing navigation in deeply nested file trees with smart truncation to keep the display clean.
- Customizing the winbar with custom sections and extensive theming to match any colorscheme.
- Improving file location awareness by showing paths and context in the winbar.
- Enhancing Neovim's UI with VS Code-like features while maintaining performance and configurability.
Not Ideal For
- Neovim users on versions below 0.8, as winbar support is unavailable
- Projects without Language Server Protocol support, since breadcrumbs depend on nvim-navic for context
- Developers seeking a plug-and-play winbar with zero configuration or external dependencies
Pros & Cons
Pros
Enables direct jumping to any code section by clicking on breadcrumb entries, mimicking VS Code's intuitive navigation as shown in the demo video.
Automatically truncates less useful parts of deeply nested file trees to keep the winbar clean, addressing clutter in complex codebases.
Supports custom sections, extensive theming, and configurable symbols, allowing seamless integration with any colorscheme or workflow preferences.
Integrates with nvim-navic to fetch document symbols from language servers, providing precise code structure visualization directly in the winbar.
Cons
Relies on nvim-navic for LSP data and optionally nvim-web-devicons, adding setup steps and potential compatibility issues to the plugin ecosystem.
Default autocmd setup may cause lag; the README includes a recipe to optimize performance by adjusting updatetime and manually defining autocmds.
Full customization requires editing Lua configuration tables and understanding Neovim's theming system, which can be daunting for casual users.
Open Source Alternative To
barbecue.nvim is an open-source alternative to the following products:
Frequently Asked Questions
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.