snacks.nvim/docs/rename.md

🍿 rename

LSP-integrated file renaming with support for plugins like neo-tree.nvim and mini.files.

🚀 Usage

mini.files

vim.api.nvim_create_autocmd("User", {
  pattern = "MiniFilesActionRename",
  callback = function(event)
    Snacks.rename.on_rename_file(event.data.from, event.data.to)
  end,
})

neo-tree.nvim

{
  "nvim-neo-tree/neo-tree.nvim",
  opts = function(_, opts)
    local function on_move(data)
      Snacks.rename.on_rename_file(data.source, data.destination)
    end
    local events = require("neo-tree.events")
    opts.event_handlers = opts.event_handlers or {}
    vim.list_extend(opts.event_handlers, {
      { event = events.FILE_MOVED, handler = on_move },
      { event = events.FILE_RENAMED, handler = on_move },
    })
  end,
}

📦 Module

Snacks.rename.on_rename_file()

---@param from string
---@param to string
---@param rename? fun()
Snacks.rename.on_rename_file(from, to, rename)

Snacks.rename.realpath()

---@param path string
Snacks.rename.realpath(path)

Snacks.rename.rename_file()

Snacks.rename.rename_file()