feat: add rename with substitute command - #3338

I considered adding something like this in my initial implementation of bulk ops, but ended up not to due to complexities of renaming directories, nested structures, and converting files <-> dirs. If this only targets files I imagine it should be good.

It's missing the mappings to actually try it out, but the logic looks good to me. There are no regressions with existing bulk ops.

I'll leave organization questions for the core maintener to decide on.

This is looking very promising.

I'm not quite sure how to test this. Do I add something like this to API impl? Not sure what the other arguments should be...

api.fs.rename_bulk = _v(function(n) require("nvim-tree.actions.fs.rename-file").bulk_rename(n) end)

Please:

• move the autocommand to rename-file.lua
• add API, doc and keymap

This is looking great, it's working exactly as advertised: visual range, patterns, closed directories

The UX is natural and good; the user is informed before changes with the number, to avoid any accidents.

1 - Where and how should the new ex commands autocmd be devided?

Not sure what you're asking here - do you mean the / delimiters?

2 - Should the autocmd of ex commands stay? or instead create at dedicated something like NvimTreeSubs or whatever to put the tree into substitution mode? - first approach is more natural and expected

Yes to ex as discussed.

• reduce autocommand scope

Using a global autocommand for CmdlineLeave is quite scary - none of my installed plugins do anything with that event, except for vim-asterisk which is a hacky old vim plugin.

Proposal:

• (削除) use a buffer local autocommand attached to the nvim-tree buffer, similar to open-file.lua and help.lua. (削除ここまで)
  On review, it seems that buffer local is not practical today, as View owns the buffer, not Explorer. Once multi-instance is completed and ownership moved to Explorer, it can changed to a buffer local.

• put this autocommand in the Explorer.augroup_id, which will ensure that it is created only when needed and then cleaned up

• you can create the autocommand during Explorer:create_autocmds()

• investigate native vim substitute

Rather than applying the substitution ourselves via gsub, could we let vim execute the patterns/magic etc. for us via vim.fn.substitute?

I'm looking at the API and Nvim source and not finding any means for vim to execute a s/foo/bar/g against a string, only a buffer. I did have hopes of some sort of vim.fn.sub(node.absolute_path, 's/foo/bar') however that just doesn't exist as it's buried in the c code.

• wild and crazy - vim does all the work in a scratch buffer

This may not be practical at all.

• Write all the paths from a string table to a scratch buffer
• Execute the user's vim.cmd.substitute('s/foo/bar/g') against the buffer
• Read the scratch buffer to a new table
• Rename all paths that have changed