nvim-tree/nvim-tree.lua
Nvim Tree.lua
This project is a Lua-based file explorer plugin for Neovim that provides a sidebar tree interface for navigating project directories. It functions as a file system node manipulator and a Git-integrated file manager, allowing users to interact with their project structure directly within the editor.
The plugin distinguishes itself by integrating version control status into the visual tree, enabling users to track, stage, and unstage files through the explorer interface. It also features a public API that allows external scripts to trigger internal functions and subscribe to system events.
The project covers a broad range of file management capabilities, including the creation, renaming, moving, and deletion of files and folders. It includes tools for project organization such as bulk file operations, pattern-based visibility filtering, and custom entry sorting. The interface is highly configurable, supporting adaptive window widths, floating window layouts, and custom keyboard mappings.
Features
- File Explorers - Provides a dedicated sidebar tree interface for browsing and managing project file structures within Neovim.
- Git Integration - Integrates version control by allowing users to stage and unstage files directly through the visual tree.
- Terminal File Managers - Enables creating, renaming, moving, and deleting files and folders directly from the editor interface.
- Git Repository Explorers - Offers a Git-centric file explorer that visualizes version control status and enables direct file staging.
- Index Staging Operations - Provides the ability to stage and unstage files in version control directly from the visual tree.
- Neovim Plugins - Ships as a specialized plugin for Neovim providing a sidebar-based project file explorer.
- File System Buffer Manipulations - Renders the file system hierarchy as a specialized Neovim buffer for navigation and manipulation.
- Git Status Indicators - Polls version control metadata to apply visual highlight groups based on the staged or unstaged status of files.
- File System Operations - Supports standard file system operations including creating, removing, renaming, copying, and moving nodes.
- Bulk File Operations - Allows marking multiple files to execute collective actions such as bulk deleting or moving.
- File Listing Filters - Hides specific files or directories based on custom patterns to reduce visual clutter in the explorer.
- Tree View Filters - Supports live filtering of the directory tree using search strings to hide irrelevant files and folders.
- Custom Key Mappings - Enables users to define custom keyboard shortcuts to automate file navigation and management tasks.
- Editor Extensions - Implemented as a Lua-based extension that enhances the Neovim editor with file system navigation capabilities.
- Editor Layout Managers - Configures floating windows and adaptive sidebars to organize the file system display within the workspace.
- File Navigation Tools - Provides utilities to quickly locate specific files within the project tree and focus the cursor on them.
- File Pattern Matching - Excludes files and directories from the view by matching filenames against user-defined regular expressions.
- Plugin APIs - Provides a public API for external scripts to trigger internal functions and subscribe to system events.
- Sorting Utilities - Organizes directory entries by name, modification time, extension, or natural sorting algorithms.
- Lua-Based Plugin Architectures - Utilizes a Lua-based architecture to maintain the directory tree state, cursor position, and node expansion.
- Window Managers - Controls the explorer layout by calculating buffer widths and window positions using adaptive constraints.
- File Explorers - Simple and fast file explorer tree.
