Add "Rename file" to the solution explorer (#1848)

Co-authored-by: Maxime Mangel <[email protected]>

Author: Maxime Mangel

release/package.json

@@ -207,6 +207,10 @@
         },
         "title": "Move file down"
       },
+      {
+        "command": "fsharp.explorer.renameFile",
+        "title": "Rename file"
+      },
       {
         "command": "fsharp.explorer.removeFile",
         "title": "Remove file"
@@ -929,6 +933,10 @@
           "command": "fsharp.explorer.moveDown",
           "when": "false"
         },
+        {
+          "command": "fsharp.explorer.renameFile",
+          "when": "false"
+        },
         {
           "command": "fsharp.explorer.removeFile",
           "when": "false"
@@ -1207,9 +1215,14 @@
           "group": "inline@2",
           "when": "viewItem == ionide.projectExplorer.file"
         },
+        {
+          "command": "fsharp.explorer.renameFile",
+          "group": "2_action@1",
+          "when": "viewItem == ionide.projectExplorer.file"
+        },
         {
           "command": "fsharp.explorer.removeFile",
-          "group": "1_navigation@4",
+          "group": "2_action@2",
           "when": "viewItem == ionide.projectExplorer.file"
         },
         {

src/Components/SolutionExplorer.fs

@@ -630,6 +630,14 @@ module SolutionExplorer =
 
         opts.validateInput <-
             fun userInput ->
+                // Add .fs extension if not present
+                // This is to mirror the logic from the command as we don't force
+                // user to provide the extension and auto add it if needed
+                // Maxime Mangel:
+                // I am not sure if this is the best way to do it because an fsproj
+                // can have other file extensions than .fs
+                let userInput = handleUntitled userInput
+
                 let fileExist =
                     existingFiles
                     |> List.tryFind (fun file ->
@@ -769,6 +777,15 @@ module SolutionExplorer =
             | None -> window.showErrorMessage ("No open folder.") |> ignore
         }
 
+    let private cleanTextEditorsDecorations (filePath : string) =
+
+        // VSCode seems to used Unix style paths
+        let normalizedPath = filePath.Replace("\\", "/")
+        let fileUri = vscode.Uri.parse $"file:///%s{normalizedPath}"
+
+        LineLens.removeDocument fileUri
+        PipelineHints.removeDocument fileUri
+
     let activate (context: ExtensionContext) =
         let emiter = vscode.EventEmitter.Create<_>()
         let rootChanged = vscode.EventEmitter.Create<Model>()
@@ -836,18 +853,49 @@ module SolutionExplorer =
                         // Need to compute the relative path from the project in order to match the user input
                         let relativeFilePathFromProject = node.path.relative (projDir, filePath)
 
-                        // Step 1. Remove file from the fsproj
                         do! FsProjEdit.removeFilePath proj relativeFilePathFromProject
 
-                        // Step 2. Clean text editor decorations
+                        cleanTextEditorsDecorations filePath
+                    }
+                | _ -> undefined
+                |> ignore
 
-                        // VSCode seems to used Unix style paths
-                        let normalizedPath = filePath.Replace("\\", "/")
-                        let fileUri = vscode.Uri.parse $"file:///%s{normalizedPath}"
+                None)
+        )
+        |> context.Subscribe
 
-                        LineLens.removeDocument fileUri
-                        PipelineHints.removeDocument fileUri
-                    }
+        commands.registerCommand (
+            "fsharp.explorer.renameFile",
+            objfy2 (fun m ->
+                match unbox m with
+                | File(parent, filePath, _, Some virtualPath, _) ->
+                    match parent.Value with
+                    | Some model ->
+                        match tryFindParentProject model with
+                        | Some(Project(_, proj, _, files, _, _, _, _)) ->
+                            createNewFileDialg proj files "Enter a new name"
+                            |> Promise.ofThenable
+                            |> Promise.bind (fun newFileNameOpt ->
+                                promise {
+                                    match newFileNameOpt with
+                                    | Some newFileName ->
+                                        let newFileName = handleUntitled newFileName
+
+                                        do! FsProjEdit.renameFile proj virtualPath newFileName
+
+                                        cleanTextEditorsDecorations filePath
+                                    | None -> ()
+
+                                    return null
+                                }
+                            )
+                            |> Promise.catchEnd (fun error ->
+                                window.showErrorMessage error.Message
+                                |> ignore
+                            )
+                        | _ -> undefined
+                    | _ ->
+                        undefined
                 | _ -> undefined
                 |> ignore
 

src/Core/DTO.fs

@@ -426,3 +426,8 @@ module DTO =
             { FsProj: string
               FileVirtualPath: string
               NewFile: string }
+
+        type DotnetRenameFileRequest =
+            { FsProj: string
+              OldFileVirtualPath: string
+              NewFileName: string }

src/Core/FsProjEdit.fs

@@ -14,6 +14,9 @@ module FsProjEdit =
     let moveFileDownPath project file =
         LanguageService.fsprojMoveFileDown project file
 
+    let renameFile project file newFileName =
+        LanguageService.fsprojRenameFile project file newFileName
+
     let removeFilePath project file =
         LanguageService.fsprojRemoveFile project file
 

src/Core/LanguageService.fs

@@ -440,6 +440,18 @@ Consider:
 
             cl.sendRequest ("fsproj/addExistingFile", req) |> Promise.map ignore
 
+    let fsprojRenameFile (fsproj: string) (file: string) (newFile: string) =
+        match client with
+        | None -> Promise.empty
+        | Some cl ->
+            let req: FsProj.DotnetRenameFileRequest =
+                { FsProj = fsproj
+                  OldFileVirtualPath = file
+                  NewFileName = newFile }
+
+            cl.sendRequest ("fsproj/renameFile", req)
+            |> Promise.map ignore
+
     let fsprojRemoveFile (fsproj: string) (file: string) =
         match client with
         | None -> Promise.empty