refactor(lsp): update rename functionality for class files

Author: sidlatau

lua/flutter-tools/lsp/rename.lua

@@ -25,67 +25,46 @@ local function convert_to_file_name(class_name)
   return file_name .. ".dart"
 end
 
----@param old_name string
----@param new_name string
----@param callback function
-local function will_rename_files(old_name, new_name, callback)
-  local params = lsp.util.make_position_params()
-  if not new_name then return end
-  local file_change = {
-    newUri = vim.uri_from_fname(new_name),
-    oldUri = vim.uri_from_fname(old_name),
-  }
-  params.files = { file_change }
-  lsp.buf_request(0, "workspace/willRenameFiles", params, function(err, result)
-    if err then
-      return ui.notify(err.message or "Error on getting lsp rename results!", ui.ERROR)
-    end
-    callback(result)
-  end)
-end
-
 --- Call this function when you want rename class or anything else.
 --- If file will be renamed too, this function will update imports.
 --- This is a modified version of `vim.lsp.buf.rename()` function and can be used instead of it.
---- Original version: https://github.com/neovim/neovim/blob/0bc323850410df4c3c1dd8fabded9d2000189270/runtime/lua/vim/lsp/buf.lua#L271
-function M.rename(new_name, options)
-  options = options or {}
-  local bufnr = options.bufnr or api.nvim_get_current_buf()
+--- Original version: https://github.com/neovim/neovim/blob/release-0.11/runtime/lua/vim/lsp/buf.lua#L640
+function M.rename(new_name, opts)
+  opts = opts or {}
+  local bufnr = vim._resolve_bufnr(opts.bufnr)
   local client = lsp_utils.get_dartls_client(bufnr)
   if not client or config.lsp.settings.renameFilesWithClasses ~= "always" then
     -- Fallback to default rename function if language server is not dartls
     -- or if user doesn't want to rename files on class rename.
-    return lsp.buf.rename(new_name, options)
+    return lsp.buf.rename(new_name, opts)
   end
 
   local win = api.nvim_get_current_win()
 
   -- Compute early to account for cursor movements after going async
-  local word_under_cursor = fn.expand("<cword>")
+  local cword = fn.expand("<cword>")
   local current_file_path = api.nvim_buf_get_name(bufnr)
   local current_file_name = fs.basename(current_file_path)
-  local filename_from_class_name = convert_to_file_name(word_under_cursor)
+  local filename_from_class_name = convert_to_file_name(cword)
   local is_file_rename = filename_from_class_name == current_file_name
 
-  ---@param range table
-  ---@param offset_encoding string
-  local function get_text_at_range(range, offset_encoding)
+  ---@param range lsp.Range
+  ---@param position_encoding string
+  local function get_text_at_range(range, position_encoding)
     return api.nvim_buf_get_text(
       bufnr,
       range.start.line,
-      -- Private method that may be not stable.
-      -- Source in case of changes: https://github.com/neovim/neovim/blob/0bc323850410df4c3c1dd8fabded9d2000189270/runtime/lua/vim/lsp/util.lua#L2152
-      util._get_line_byte_from_position(bufnr, range.start, offset_encoding),
+      util._get_line_byte_from_position(bufnr, range.start, position_encoding),
       range["end"].line,
-      util._get_line_byte_from_position(bufnr, range["end"], offset_encoding),
+      util._get_line_byte_from_position(bufnr, range["end"], position_encoding),
       {}
     )[1]
   end
 
   ---@param name string the name of the thing
-  ---@param result lsp.Range | { range: lsp.Range, placeholder: string } | nil the result from the call to will rename
+  ---@param result table|nil the result from the call to will rename
   local function rename(name, result)
-    local params = util.make_position_params(win, client.offset_encoding)
+    local params = util.make_position_params(win, client.offset_encoding) --[[@as lsp.RenameParams]]
     params.newName = name
     local handler = client.handlers["textDocument/rename"] or lsp.handlers["textDocument/rename"]
     client.request("textDocument/rename", params, function(...)
@@ -100,29 +79,59 @@ function M.rename(new_name, options)
       local new_filename = convert_to_file_name(name)
       local new_file_path = path.join(fs.dirname(current_file_path), new_filename)
 
-      will_rename_files(current_file_path, new_file_path, function(result) rename(name, result) end)
+      -- Create a custom params object for willRenameFiles request
+      ---@class WillRenameFilesParams
+      local params = {
+        files = {
+          {
+            oldUri = vim.uri_from_fname(current_file_path),
+            newUri = vim.uri_from_fname(new_file_path),
+          },
+        },
+      }
+
+      client.request("workspace/willRenameFiles", params, function(err, result)
+        if err then
+          ui.notify(err.message or "Error on getting lsp rename results!", ui.ERROR)
+          return
+        end
+        rename(name, result)
+      end, bufnr)
     else
       rename(name)
     end
   end
 
+  -- Try to use prepare rename first
   if client.supports_method("textDocument/prepareRename") then
     local params = util.make_position_params(win, client.offset_encoding)
     client.request("textDocument/prepareRename", params, function(err, result)
-      if err then return ui.notify(("Error on prepareRename: %s"):format(err.message), ui.ERROR) end
-      if not result then return ui.notify("Nothing to rename", ui.INFO) end
+      if err or result == nil then
+        if err then
+          ui.notify(("Error on prepareRename: %s"):format(err.message), ui.ERROR)
+        else
+          ui.notify("Nothing to rename", ui.INFO)
+        end
+        return
+      end
 
-      if new_name then return rename_fix_imports(new_name) end
+      if new_name then
+        rename_fix_imports(new_name)
+        return
+      end
 
-      local prompt_opts = { prompt = "New Name: " }
+      local prompt_opts = {
+        prompt = "New Name: ",
+      }
+      -- result: Range | { range: Range, placeholder: string }
       if result.placeholder then
         prompt_opts.default = result.placeholder
       elseif result.start then
         prompt_opts.default = get_text_at_range(result, client.offset_encoding)
       elseif result.range then
         prompt_opts.default = get_text_at_range(result.range, client.offset_encoding)
       else
-        prompt_opts.default = word_under_cursor
+        prompt_opts.default = cword
       end
       ui.input(prompt_opts, function(input)
         if not input or #input == 0 then return end
@@ -131,11 +140,14 @@ function M.rename(new_name, options)
     end, bufnr)
   else
     assert(client.supports_method("textDocument/rename"), "Client must support textDocument/rename")
-    if new_name then return rename_fix_imports(new_name) end
+    if new_name then
+      rename_fix_imports(new_name)
+      return
+    end
 
     local prompt_opts = {
       prompt = "New Name: ",
-      default = word_under_cursor,
+      default = cword,
     }
     ui.input(prompt_opts, function(input)
       if not input or #input == 0 then return end