用 Lua 编写的 Neovim 文件浏览器

自动更新

文件类型图标

Git 集成

诊断集成：LSP 和 COC

（实时）过滤

剪切、复制、粘贴、重命名、删除、创建

高度可定制

查看 wiki 获取展示、技巧、使用方法等更多信息。

问题和一般支持：讨论

要求

neovim >=0.9.0

nvim-web-devicons 是可选的，用于显示文件图标。它需要一个修补字体。你的终端模拟器必须配置使用该字体，通常是 "Hack Nerd Font"

安装

请通过你喜欢的包管理器安装。有关特定包管理器的说明，请参阅安装。

nvim-tree/nvim-tree.lua

可以通过标签指定主要或次要版本：v<主版本号> 例如 v1 或 v<主版本号>.<次版本号> 例如 v1.23

nvim-tree/nvim-web-devicons 可选，用于文件图标

强烈建议禁用 netrw，请参阅 :help nvim-tree-netrw

快速开始

设置

在你的 init.lua 中设置插件

-- 在初始化的最开始禁用 netrw
vim.g.loaded_netrw = 1
vim.g.loaded_netrwPlugin = 1

-- 可选启用 24 位色彩
vim.opt.termguicolors = true

-- 使用默认配置的空白设置
require("nvim-tree").setup()

-- 或者使用一些选项进行设置
require("nvim-tree").setup({
  sort = {
    sorter = "case_sensitive",
  },
  view = {
    width = 30,
  },
  renderer = {
    group_empty = true,
  },
  filters = {
    dotfiles = true,
  },
})

帮助

打开树：:NvimTreeOpen

显示映射：g?

自定义映射

默认应用 :help nvim-tree-mappings-default，但你可以通过 |nvim-tree.on_attach| 进行自定义，例如：

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

  -- 默认映射
  api.config.mappings.default_on_attach(bufnr)

  -- 自定义映射
  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

-- 在其他选项中传递给 setup
require("nvim-tree").setup {
  ---
  on_attach = my_on_attach,
  ---
}

高亮

运行 :NvimTreeHiTest 显示 nvim-tree 使用的所有高亮。

可以在调用 setup 之前或之后自定义它们，并会立即在运行时应用。例如：

vim.cmd([[
    :hi      NvimTreeExecFile    guifg=#ffa0a0
    :hi      NvimTreeSpecialFile guifg=#ff80ff gui=underline
    :hi      NvimTreeSymlink     guifg=Yellow  gui=italic
    :hi link NvimTreeImageFile   Title
]])

详情请参阅 :help nvim-tree-highlight。