add willRename and didRename fileOperations

Default.sublime-commands

@@ -151,6 +151,10 @@
         "caption": "LSP: Rename",
         "command": "lsp_symbol_rename"
     },
+    {
+        "caption": "LSP: Rename File",
+        "command": "lsp_rename_file"
+    },
     {
         "caption": "LSP: Code Action",
         "command": "lsp_code_actions"

boot.py

@@ -69,6 +69,7 @@
 from .plugin.references import LspSymbolReferencesCommand
 from .plugin.rename import LspHideRenameButtonsCommand
 from .plugin.rename import LspSymbolRenameCommand
+from .plugin.rename_file import LspRenameFileCommand
 from .plugin.save_command import LspSaveAllCommand
 from .plugin.save_command import LspSaveCommand
 from .plugin.selection_range import LspExpandSelectionCommand
@@ -146,6 +147,7 @@
     "LspSymbolImplementationCommand",
     "LspSymbolReferencesCommand",
     "LspSymbolRenameCommand",
+    "LspRenameFileCommand",
     "LspSymbolTypeDefinitionCommand",
     "LspToggleCodeLensesCommand",
     "LspToggleHoverPopupsCommand",

plugin/core/protocol.py

@@ -6064,6 +6064,10 @@ def colorPresentation(cls, params: ColorPresentationParams, view: sublime.View)
     def willSaveWaitUntil(cls, params: WillSaveTextDocumentParams, view: sublime.View) -> Request:
         return Request("textDocument/willSaveWaitUntil", params, view)
 
+    @classmethod
+    def willRenameFiles(cls, params: RenameFilesParams) -> Request:
+        return Request("workspace/willRenameFiles", params)
+
     @classmethod
     def documentSymbols(cls, params: DocumentSymbolParams, view: sublime.View) -> Request:
         return Request("textDocument/documentSymbol", params, view, progress=True)
@@ -6256,6 +6260,10 @@ def didSave(cls, params: DidSaveTextDocumentParams) -> Notification:
     def didClose(cls, params: DidCloseTextDocumentParams) -> Notification:
         return Notification("textDocument/didClose", params)
 
+    @classmethod
+    def didRenameFiles(cls, params: RenameFilesParams) -> Notification:
+        return Notification("workspace/didRenameFiles", params)
+
     @classmethod
     def didChangeConfiguration(cls, params: DidChangeConfigurationParams) -> Notification:
         return Notification("workspace/didChangeConfiguration", params)

plugin/core/sessions.py

@@ -493,6 +493,11 @@ def get_initialize_params(variables: dict[str, str], workspace_folders: list[Wor
         "codeLens": {
             "refreshSupport": True
         },
+        "fileOperations": {
+            "dynamicRegistration": True,
+            "willRename": True,
+            "didRename": True
+        },
         "inlayHint": {
             "refreshSupport": True
         },

plugin/rename_file.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+from .core.open import open_file_uri
+from .core.protocol import Notification, RenameFilesParams, Request, WorkspaceEdit
+from .core.registry import LspTextCommand
+from .core.url import parse_uri
+from .core.views import did_open_text_document_params, uri_from_view
+from pathlib import Path
+from urllib.parse import urljoin
+import os
+import sublime
+import sublime_plugin
+
+
+class RenameFileInputHandler(sublime_plugin.TextInputHandler):
+    def want_event(self) -> bool:
+        return False
+
+    def __init__(self, file_name: str) -> None:
+        self.file_name = file_name
+
+    def name(self) -> str:
+        return "new_name"
+
+    def placeholder(self) -> str:
+        return self.file_name
+
+    def initial_text(self) -> str:
+        return self.placeholder()
+
+    def validate(self, name: str) -> bool:
+        return len(name) > 0
+
+class LspRenameFileCommand(LspTextCommand):
+    capability = 'workspace.fileOperations.willRename'
+
+    def want_event(self) -> bool:
+        return False
+
+    def input(self, args: dict) -> sublime_plugin.TextInputHandler | None:
+        if "new_name" in args:
+            return None
+        return RenameFileInputHandler(Path(self.view.file_name() or "").name)
+
+    def run(
+        self,
+        _edit: sublime.Edit,
+        new_name: str = "", # new_name can be: FILE_NAME.xy OR ./FILE_NAME.xy OR ../../FILE_NAME.xy
+    ) -> None:
+        session = self.best_session("workspace.fileOperations.willRename")
+        if not session:
+            return
+        current_file_path = self.view.file_name() or ''
+        new_file_path = os.path.normpath(Path(current_file_path).parent / new_name)
+        window = self.view.window()
+        if os.path.exists(new_file_path) and window:
+            window.status_message(f'Unable to Rename. File already exists')
+            return
+        rename_file_params: RenameFilesParams = {
+            "files": [{
+                "newUri": urljoin("file:", new_file_path),
+                "oldUri": uri_from_view(self.view),
+            }]
+        }
+        request = Request.willRenameFiles(rename_file_params)
+        session.send_request(request, lambda res: self.handle(res, session.config.name, new_name, rename_file_params))
+
+    def handle(self, res: WorkspaceEdit | None, session_name: str, new_name: str, rename_file_params: RenameFilesParams) -> None:
+        window = self.view.window()
+        session = self.session_by_name(session_name)
+        if session and window:
+            # LSP spec - Apply WorkspaceEdit before the files are renamed
+            if res:
+                session.apply_workspace_edit_async(res, is_refactoring=True)
+            renamed_file = rename_file_params['files'][0]
+            old_regions = [region for region in self.view.sel()]
+            self.view.close() # LSP spec - send didClose for old file
+            # actally rename the file, this will create a new file
+            os.rename(
+                parse_uri(renamed_file['oldUri'])[1],
+                parse_uri(renamed_file['newUri'])[1]
+            )
+            # LSP spec - send didOpen for the new file
+            open_file_uri(window, renamed_file['newUri']) \
+                .then(lambda v: v and v.sel().add_all(old_regions))
+        for session in self.sessions('workspace.fileOperations.didRename'):
+            session.send_notification(Notification.didRenameFiles(rename_file_params))
+
+