NeoTree.nvim 在 macOS 上实现文件删除到回收站功能的技术方案

背景介绍

NeoTree.nvim 是一款流行的 Neovim 文件树插件，提供了丰富的文件管理功能。在 macOS 系统上，用户经常需要将文件删除到回收站而不是永久删除，这需要特殊的处理方式。

问题分析

原文档提供的回收站功能实现方案在某些情况下无法正常工作，特别是在 macOS Ventura 系统上使用 Neovim 0.10.0 版本时。主要问题出现在文件路径处理和系统命令调用方式上。

解决方案

经过社区验证，以下实现方案可以稳定工作：

1. 核心函数实现：

local function trash(state)
  local path = state.tree:get_node().path
  local utils = require("neo-tree.utils")
  local _, name = utils.split_path(path)

  local msg = string.format("Are you sure you want to trash '%s'?", name)

  inputs.confirm(msg, function(confirmed)
    if not confirmed then
      return
    end

    pcall(function()
      vim.fn.system({ "trash", vim.fn.fnameescape(path) })
      if vim.v.shell_error ~= 0 then
        msg = "trash command failed."
        vim.notify(msg, vim.log.levels.ERROR, { title = "Neo-tree" })
      end
    end)

    require("neo-tree.sources.manager").refresh(state.name)
  end)
end

2. 批量删除支持：

local function trash_visual(state, selected_nodes)
  local msg = "Are you sure you want to trash " .. #selected_nodes .. " files ?"

  inputs.confirm(msg, function(confirmed)
    if not confirmed then
      return
    end

    for _, node in ipairs(selected_nodes) do
      pcall(function()
        vim.fn.system({ "trash", vim.fn.fnameescape(node.path) })
        if vim.v.shell_error ~= 0 then
          msg = "trash command failed."
          vim.notify(msg, vim.log.levels.ERROR, { title = "Neo-tree" })
        end
      end)
    end

    require("neo-tree.sources.manager").refresh(state.name)
  end)
end

实现要点

1. 系统依赖：

   • 需要预先安装 macOS 的 trash 命令行工具（可通过 Homebrew 安装）
   • 命令：brew install trash

2. 安全特性：

   • 使用 pcall 包裹系统调用，防止命令执行失败导致插件崩溃
   • 添加了确认对话框，防止误操作
   • 使用 fnameescape 处理路径中的特殊字符

3. 刷新机制：

   • 操作完成后自动刷新文件树视图
   • 错误时显示通知提醒用户

配置方法

在 NeoTree 配置中添加以下内容：

filesystem = {
  window = {
    mappings = {
      ["d"] = "trash",  -- 单个文件删除到回收站
      ["D"] = "Delete", -- 永久删除
    },
  },
  commands = {
    trash = trash,
    trash_visual = trash_visual,
  },
}

最佳实践

1. 建议同时保留永久删除功能（如映射到大写 D）
2. 对于团队协作，建议统一文档中的实现方案
3. 定期检查 trash 命令行工具的更新

总结

通过这种实现方式，NeoTree.nvim 可以在 macOS 系统上提供稳定可靠的回收站功能，既保留了文件安全性，又提供了良好的用户体验。该方案已经过社区验证，适合在各种 Neovim 环境下使用。