trouble.nvim
A pretty Neovim plugin for displaying diagnostics, LSP results, quickfix lists, and telescope/fzf-lua results in a unified tree view.
What is trouble.nvim?
Trouble.nvim is a Neovim plugin that aggregates and displays code analysis information in a unified, tree-based list. It shows diagnostics, LSP results (like references and definitions), quickfix lists, and search results from Telescope or fzf-lua, helping developers efficiently navigate and fix issues in their code.
Neovim users who work with LSP servers, diagnostics, and external search tools like Telescope or fzf-lua, and want a centralized, pretty interface for code feedback.
It replaces multiple disjointed Neovim windows and lists with a single, highly configurable tree view that reduces visual clutter, improves navigation efficiency, and integrates seamlessly with popular Neovim plugins.
Overview
🚦 A pretty diagnostics, references, telescope results, quickfix and location list to help you solve all the trouble your code is causing.
Use Cases
Best For
- Viewing and filtering Neovim diagnostics in a structured list
- Browsing LSP references, definitions, and document symbols in a tree view
- Managing quickfix and location lists with better visualization
- Displaying Telescope or fzf-lua search results in a persistent window
- Tracking code issues across a project with multi-window support
- Adding a statusline component for real-time symbol visibility
Not Ideal For
- Neovim users who prefer minimal, dependency-free setups without extensive plugin configuration
- Projects not utilizing LSP servers or external search tools like Telescope, as core features rely on these integrations
- Developers who are fully satisfied with Neovim's native quickfix and location lists and seek no additional UI enhancements
Pros & Cons
Pros
Consolidates diagnostics, LSP references, quickfix lists, and search results into a single, tree-based view, reducing visual clutter and improving navigation efficiency, as emphasized in the unified display feature.
Directly integrates with popular Neovim plugins like Telescope and fzf-lua, allowing search results to be displayed and managed within Trouble.nvim using custom actions, as detailed in the integration sections.
Supports multiple windows, tree hierarchies with natural organization, and configurable formatters, filters, and sorters, enabling tailored displays for different use cases, highlighted in the flexible views and modes configuration.
Provides a comprehensive API and Trouble command for programmatic control, making automation and integration into workflows straightforward, as shown in the API and usage examples.
Cons
Requires configuring multiple options, modes, and key mappings, and depends on external tools like nvim-web-devicons and a patched font, which can be overwhelming for users seeking plug-and-play simplicity.
Limits items to 200 per section by default and uses throttle settings for updates, which may cause lag or incomplete displays in large codebases with many diagnostics or search results.
Requires Neovim >= 0.9.2 or specific Tree-sitter parsers, potentially causing compatibility issues with older or custom Neovim installations, as noted in the requirements section.
Frequently Asked Questions
Related Projects
wtf.nvimDelicious diagnostic debugging in Neovim 🤤
workspace-diagnostics.nvimPopulate diagnostics for _all_ projects files, not just opened ones.
nvim-rulebookAll-around helper for dealing with errors and diagnostics: Prettify typescript errors, add inline-comments to ignore rules, and lookup rule documentation online.
better-diagnostic-virtual-textEnhances the display of virtual text for diagnostics in Neovim. This function aims to provide a more user-friendly and informative presentation of diagnostic messages directly within the editor.
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.