docs/rename.md
LSP-integrated file renaming with support for plugins like neo-tree.nvim and 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,
})
vim.api.nvim_create_autocmd("User", {
pattern = "OilActionsPost",
callback = function(event)
if event.data.actions[1].type == "move" then
Snacks.rename.on_rename_file(event.data.actions[1].src_url, event.data.actions[1].dest_url)
end
end,
})
return {
"A7Lavinraj/fyler.nvim",
dependencies = { "echasnovski/mini.icons" },
opts = {
hooks = {
on_rename = function(src_path, destination_path)
Snacks.rename.on_rename_file(src_path, destination_path)
end,
},
},
}
{
"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,
}
local prev = { new_name = "", old_name = "" } -- Prevents duplicate events
vim.api.nvim_create_autocmd("User", {
pattern = "NvimTreeSetup",
callback = function()
local events = require("nvim-tree.api").events
events.subscribe(events.Event.NodeRenamed, function(data)
if prev.new_name ~= data.new_name or prev.old_name ~= data.old_name then
data = data
Snacks.rename.on_rename_file(data.old_name, data.new_name)
end
end)
end,
})
vim.api.nvim_create_autocmd({ 'FileType' }, {
pattern = { 'netrw' },
group = vim.api.nvim_create_augroup('NetrwOnRename', { clear = true }),
callback = function()
vim.keymap.set("n", "R", function()
local original_file_path = vim.b.netrw_curdir .. '/' .. vim.fn["netrw#Call"]("NetrwGetWord")
vim.ui.input({ prompt = 'Move/rename to:', default = original_file_path }, function(target_file_path)
if target_file_path and target_file_path ~= "" then
local file_exists = vim.uv.fs_access(target_file_path, "W")
if not file_exists then
vim.uv.fs_rename(original_file_path, target_file_path)
Snacks.rename.on_rename_file(original_file_path, target_file_path)
else
vim.notify("File '" .. target_file_path .. "' already exists! Skipping...", vim.log.levels.ERROR)
end
-- Refresh netrw
vim.cmd(':Ex ' .. vim.b.netrw_curdir)
end
end)
end, { remap = true, buffer = true })
end
})
Snacks.rename.on_rename_file()Lets LSP clients know that a file has been renamed
---@param from string
---@param to string
---@param rename? fun()
Snacks.rename.on_rename_file(from, to, rename)
Snacks.rename.rename_file()Renames the provided file, or the current buffer's file.
Prompt for the new filename if to is not provided.
do the rename, and trigger LSP handlers
---@param opts? {from?: string, to?:string, on_rename?: fun(to:string, from:string, ok:boolean)}
Snacks.rename.rename_file(opts)