feat(event): add will rename node event.

[antosha417]

Hey!
Some language servers support workspace/willRenameFiles request. It is used in order to automatically fix imports.
Currently neovim does not support it. So plugins must be used if one wants to use this feature. Here is an open issue in neovim repo.

Since I use nvim-tree.lua for all file manipulations I thought it would be cool to add WillRenameNode event and do workspace/willRenameFiles request in the handler.

[alex-courtis]

This works.

Not quite sure what the use cases will be...

[antosha417]

@alex-courtis, so one of the possible use-cases is the following:

local api = require('nvim-tree.api')
local Event = api.events.Event

function _G.dump(...)
  local objects = vim.tbl_map(vim.inspect, { ... })
  print(unpack(objects))
  return ...
end

dump("Loaded will_rename_listener")

local function getWorkspaceEdit(client, data)
  local will_rename_params = {
    files = {
      {
        newUri = "file://" .. data.new_name,
        oldUri = "file://" .. data.old_name
      }
    }
  }
  local resp = client.request_sync("workspace/willRenameFiles", will_rename_params, 1000)
  return resp.result
end

api.events.subscribe(Event.WillRenameNode, function(data)
  dump("Got will_rename_event")
  dump(data)
  for _, client in pairs(vim.lsp.get_active_clients()) do
    if client.name == "metals" then
      local edit = getWorkspaceEdit(client, data)
      dump("Got workspace edit")
      dump(edit)
      vim.lsp.util.apply_workspace_edit(edit, client.offset_encoding)
    end
  end
end)

Now when I move files around in nvim-tree.lua my imports and package names are automatically fixed my metals language server for scala.

I think that rust language server also supports workspace/willRenameFiles request. Probably typescript laguage server also. I'll give them a try soon and update.

[gegoune]

@antosha417 Could you maybe add that to wiki? Seems like pretty significant functionality that users might want to configure. This is pretty neat!

[antosha417]

@gegoune I'll explore this a bit more with couple of other language servers and add this to wiki. I'm also very excited about it.

[alex-courtis]

Oh that is nice... I can see instances where that would be useful.

Wiki: yes please!

[antosha417]

@gegoune, @alex-courtis
I ended up wring a small extension plugin for lsp file operations.
https://github.com/antosha417/nvim-lsp-file-operations

I think there might be some corner cases which I don't know about. So I thought that wiki is not a great place to maintain that peace of code.

Will write about that extension in the wiki though.

[antosha417]

https://github.com/nvim-tree/nvim-tree.lua/wiki/Recipes#lsp-file-operations

[gegoune]

Perhaps it deserves its own Extensions page?

[alex-courtis]

Perhaps it deserves its own Extensions page?

Done: https://github.com/nvim-tree/nvim-tree.lua/wiki/Extensions

I shall enjoy using lsp-file-operations. I hope it is the first of many...

[alex-courtis]

lsp-file-operations runs fine when its setup is called before nvim-tree's. Proves that the event system is working well :)

[alex-courtis]

Renamed wiki to https://github.com/nvim-tree/nvim-tree.lua/wiki/Extension-Plugins and added mini.base16