* refactor(#2787): replace deprecated
* refactor(#2787): enable deprecated checks
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): use inline deprecation disabling
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): replace deprecated
* refactor(#2787): deprecated are now warnings
* refactor(#2787): 0.9 is the minimum supported version
* Revert "refactor(#2787): replace deprecated"
This reverts commit b6b4c32fcb
.
* refactor(#2787): suppress deprecated until 0.11
* refactor(#2787): minimum nvim version 0.8 -> 0.9
* refactor(#2787): reset globals
* refactor(#2787): explicitly check for vim.diagnostic.is_enabled function presence
5.8 KiB
A File Explorer For Neovim Written In Lua
![](https://user-images.githubusercontent.com/1505378/232662694-8dc494e0-24da-497a-8541-29344293378c.png)
![](https://user-images.githubusercontent.com/1505378/232662698-2f321315-c67a-486b-85d8-8c391de52392.png)
Automatic updates
File type icons
Git integration
Diagnostics integration: LSP and COC
(Live) filtering
Cut, copy, paste, rename, delete, create
Highly customisable
Take a look at the wiki for Showcases, Tips, Recipes and more.
Questions and general support: Discussions
Requirements
nvim-web-devicons is optional and used to display file icons. It requires a patched font. Your terminal emulator must be configured to use that font, usually "Hack Nerd Font"
Install
Please install via your preferred package manager. See Installation for specific package manager instructions.
nvim-tree/nvim-tree.lua
Major or minor versions may be specified via tags: v<MAJOR>
e.g. v1
or v<MAJOR>.<MINOR>
e.g. v1.23
nvim-tree/nvim-web-devicons
optional, for file icons
Disabling netrw is strongly advised, see :help nvim-tree-netrw
Quick Start
Setup
Setup the plugin in your init.lua
-- disable netrw at the very start of your init.lua
vim.g.loaded_netrw = 1
vim.g.loaded_netrwPlugin = 1
-- optionally enable 24-bit colour
vim.opt.termguicolors = true
-- empty setup using defaults
require("nvim-tree").setup()
-- OR setup with some options
require("nvim-tree").setup({
sort = {
sorter = "case_sensitive",
},
view = {
width = 30,
},
renderer = {
group_empty = true,
},
filters = {
dotfiles = true,
},
})
Help
Open the tree: :NvimTreeOpen
Show the mappings: g?
Custom Mappings
:help nvim-tree-mappings-default are applied by default however you may customise via |nvim-tree.on_attach| e.g.
local function my_on_attach(bufnr)
local api = require "nvim-tree.api"
local function opts(desc)
return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
end
-- default mappings
api.config.mappings.default_on_attach(bufnr)
-- custom mappings
vim.keymap.set('n', '<C-t>', api.tree.change_root_to_parent, opts('Up'))
vim.keymap.set('n', '?', api.tree.toggle_help, opts('Help'))
end
-- pass to setup along with your other options
require("nvim-tree").setup {
---
on_attach = my_on_attach,
---
}
Highlight
Run :NvimTreeHiTest
to show all the highlights that nvim-tree uses.
They can be customised before or after setup is called and will be immediately applied at runtime. e.g.
vim.cmd([[
:hi NvimTreeExecFile guifg=#ffa0a0
:hi NvimTreeSpecialFile guifg=#ff80ff gui=underline
:hi NvimTreeSymlink guifg=Yellow gui=italic
:hi link NvimTreeImageFile Title
]])
See :help nvim-tree-highlight for details.
Commands
Basic commands:
:NvimTreeToggle
Open or close the tree. Takes an optional path argument.
:NvimTreeFocus
Open the tree if it is closed, and then focus on the tree.
:NvimTreeFindFile
Move the cursor in the tree for the current buffer, opening folders if needed.
:NvimTreeCollapse
Collapses the nvim-tree recursively.
Roadmap
nvim-tree is stable and new major features will not be added. The focus is on existing user experience.
Users are encouraged to add their own custom features via the public API.
Development is focused on:
- Bug fixes
- Performance
- Quality of Life improvements
- API / Events
- Enhancements to existing features
API
nvim-tree exposes a public API. This is non breaking, with additions made as necessary. See :help nvim-tree-api
See wiki Recipes and Tips for ideas and inspiration.
Please raise a feature request if the API is insufficient for your needs. Contributions are always welcome.
You may also subscribe to events that nvim-tree will dispatch in a variety of situations, see :help nvim-tree-events
Contributing
PRs are always welcome. See wiki to get started.
See bug and PR Please issues if you are looking for some work to get you started.
Screenshots
See Showcases wiki page for examples of user's configurations with sources.
Please add your own!
Team
- @alex-courtis Arch Linux
- @gegoune macOS
- @Akmadan23 Linux
- @dependabot[bot] Ubuntu Linux