nvim-tree.lua
A file explorer tree plugin for Neovim, written in Lua, offering git integration, diagnostics, and high customizability.
What is nvim-tree.lua?
nvim-tree.lua is a file explorer plugin for Neovim that provides a tree-style interface to navigate and manage files and directories within the editor. It replaces the default netrw file browser and integrates seamlessly with Neovim's ecosystem, enhancing developer workflow with modern features like automatic updates, Git integration, and diagnostics display.
Neovim users, particularly developers who want a modern, customizable, and integrated file explorer to replace netrw for efficient project navigation and management.
Developers choose nvim-tree.lua for its stability, performance, and rich feature set including live filtering, file type icons, and deep integration with Git and LSP diagnostics, all while offering extensive customization through a public API and events system.
Overview
A file explorer tree for neovim written in lua
Use Cases
Best For
- Neovim users seeking a modern, tree-style file explorer to replace the default netrw browser.
- Developers who need real-time file status visibility with integrated Git indicators (e.g., modified, staged files).
- Teams requiring LSP or COC diagnostics (errors, warnings) displayed directly on files in the explorer.
- Users who prioritize high customizability in their editor plugins, with configurable appearance, behavior, and key mappings.
- Workflows that benefit from live filtering to quickly navigate large project directories as you type.
- Environments where automatic updates to the file tree are essential when files change externally.
Not Ideal For
- Vim users who haven't migrated to Neovim, as it's exclusively built for Neovim's ecosystem.
- Developers preferring a completely dependency-free setup, since it requires nvim-web-devicons for icons and a patched font for full visual appeal.
- Users needing built-in terminal emulation or advanced multi-pane file management, as it focuses on core navigation without these extras.
- Environments stuck on older Neovim versions (<0.10), as compatibility is limited and unsupported for legacy releases.
Pros & Cons
Pros
Includes automatic updates, Git integration, LSP/COC diagnostics, and live filtering, which enhance workflow efficiency as highlighted in the key features list.
Offers extensive configuration via setup options, custom mappings through on_attach, and highlight groups, allowing tailored appearance and behavior as per the README's examples.
Emphasizes stability and performance in its philosophy, with a roadmap focused on bug fixes and quality-of-life improvements, indicating a mature project.
Seamlessly replaces netrw and integrates with Neovim's LSP and Git systems, providing a native feel for modern developer workflows as described in the requirements.
Cons
Requires nvim-web-devicons and a patched font for icons, adding complexity and potential compatibility issues if terminals lack support.
Only supports Neovim >=0.10, excluding Vim users and older Neovim versions, which the README notes receive no updates or support.
Lacks built-in file previews, terminal integration, or advanced multi-instance management, focusing solely on core navigation compared to some competitors.
Customization involves Lua configuration and understanding Neovim's API, which can be daunting for those unfamiliar with Lua or plugin ecosystems.
Frequently Asked Questions
Related Projects
oil.nvimNeovim file explorer: edit your filesystem like a buffer
neo-tree.nvimNeovim plugin to manage the file system and other tree like structures.
yazi.nvimA Neovim Plugin for the yazi terminal file manager
chadtreeFile manager for Neovim. Better than NERDTree.
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.