# simple-tree.nvim

**Repository Path**: kkhuang/simple-tree.nvim

## Basic Information

- **Project Name**: simple-tree.nvim
- **Description**: 【neovim】文件目录树插件——侧边栏快捷操作浏览文件
- **Primary Language**: Lua
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-27
- **Last Updated**: 2025-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: nvim, Neovim, Lua, tree, 目录树

## README

# simple-tree.nvim

> [英文](./README.md) | 中文

<div align="center">
  <h3>一个用于 <code>Neovim</code> 的目录树插件。</h3>
  <img src="asset/image.png" alt="simple-tree" />
</div>

## 介绍

`simple-tree` 是一个 Neovim 插件，用于浏览文件系统。

## 要求

- 此插件仅在 Neovim 0.8 或更高版本中工作。
- [nerd 字体](https://www.nerdfonts.com/) 是可选的，用于显示文件图标。如果你需要它，请将其配置为你终端模拟器的字体。

## 安装

使用 [`lazy.nvim`](https://github.com/folke/lazy.nvim):

```lua
{'kkkkkHuang/simple-tree.nvim', opts = {--[[ 你的配置]]}}
```

使用 [`packer.nvim`](https://github.com/wbthomason/packer.nvim):

```lua
require('packer').use { 'kkkkkHuang/simple-tree.nvim' }
```

使用 [`vim-plug`](https://github.com/junegunn/vim-plug):

```vim
Plug 'kkkkkHuang/simple-tree.nvim'
lua require("simple-tree").setup()
```

使用 [`Vundle.vim`](https://github.com/VundleVim/Vundle.vim):

```vim
Plugin 'kkkkkHuang/simple-tree.nvim'
```


## 使用

### 命令

`:TreeToggle` 打开或关闭目录树

你也可以绑定到一个快捷键，比如 `<Leader>b`

```lua
vim.api.nvim_set_keymap('n', '<Leader>b', '<Cmd>TreeToggle<CR>', { noremap = true })
```

### 快捷键

| 键           | 描述                                 |
| ------------ | ------------------------------------ |
| `o`, `Enter` | 打开或关闭文件夹，如果是文件则编辑它 |
| `a`          | 创建文件夹或文件                     |
| `r`          | 重命名文件夹或文件                   |
| `d`          | 删除文件夹或文件                     |
| `c`          | 复制文件夹或文件                     |
| `m`          | 移动文件夹或文件                     |
| `p`          | 粘贴文件夹或文件                     |

## 配置

设置：

```lua
require("simple-tree").setup {
  -- 目录树窗口的宽度
  width=30,

  -- 启用或禁用自动聚焦到当前文件
  auto_focus_file=true,

  -- 你可以自定义文件图标
  file_icons={
    ['lua']="",
    ['py']="",
    -- ...
    ['default']=''
  },

  -- 你可以自定义文件夹图标
  folder_icons='',
  folder_open_icons='',

  -- 启用 git 状态显示
  enable_git_status=true

}
```

## 其他插件设置

- [`bufferline.nvim`](https://github.com/akinsho/bufferline.nvim)

设置侧边栏偏移

```lua
require("bufferline").setup({
  options = {
    -- ...
    offsets = {
      {
        filetype = "simple-tree",
        text = "文件管理器",
        separator = true,
      },
      -- ...
    }
  }
})
```

当你使用 `bufferline.nvim` 关闭缓冲区时，可能会出现整个 `simple-tree` 插件占据当前缓冲区的情况。你可以更改 `bufferline.nvim` 的配置以避免这种情况：

```lua
require("bufferline").setup({
  options = {
    -- ...
    -- 更改关闭命令
    close_command = function(bufnum)
    	if bufnum == vim.fn.bufnr() then
        vim.cmd("bp")
    	end
    	vim.api.nvim_buf_delete(bufnum, { force = true })
    end,

    right_mouse_command = function(bufnum)
    	if bufnum == vim.fn.bufnr() then
        vim.cmd("bp")
    	end
    	vim.api.nvim_buf_delete(bufnum, { force = true })
    end,
    -- ...
  }
})
```

同样地，如果你使用 `:bd` 命令关闭缓冲区时遇到这种情况，也可以使用命令 `:bp | bd #` 来代替，这个命令的意思是切换到当前窗口之前的缓冲区并删除最后编辑的文件的缓冲区。