feat: Add 'rename' into the view context menu (#353)

Co-authored-by: Sheng Chen <sheche@microsoft.com>
microsoft · Oct 20, 2020 · ceacecb · ceacecb
1 parent 1adb651
commit ceacecb
Show file tree

Hide file tree

Showing 8 changed files with 91 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -144,6 +144,11 @@
         "command": "java.view.package.moveFileToTrash",
         "title": "%contributes.commands.java.view.package.moveFileToTrash%",
         "category": "Java"
+      },
+      {
+        "command": "java.view.package.renameFile",
+        "title": "%contributes.commands.java.view.package.renameFile%",
+        "category": "Java"
       }
     ],
     "configuration": {
@@ -191,9 +196,16 @@
       }
     },
     "keybindings": [
+      {
+        "command": "java.view.package.renameFile",
+        "key": "F2",
+        "mac": "enter",
+        "when": "java:projectManagerActivated && focusedView == javaProjectExplorer"
+      },
       {
         "command": "java.view.package.moveFileToTrash",
         "key": "delete",
+        "mac": "cmd+backspace",
         "when": "java:projectManagerActivated && focusedView == javaProjectExplorer"
       }
     ],
@@ -255,6 +267,10 @@
           "command": "java.view.package.newPackage",
           "when": "false"
         },
+        {
+          "command": "java.view.package.renameFile",
+          "when": "false"
+        },
         {
           "command": "java.view.package.moveFileToTrash",
           "when": "false"
@@ -360,20 +376,35 @@
           "group": "6_copypath@25"
         },
         {
-          "command": "java.view.package.moveFileToTrash",
+          "command": "java.view.package.renameFile",
           "when": "view == javaProjectExplorer && viewItem =~ /java:(package|packageRoot)(?=.*?\\b\\+source\\b)(?=.*?\\b\\+uri\\b)/",
           "group": "7_modification@10"
         },
         {
-          "command": "java.view.package.moveFileToTrash",
+          "command": "java.view.package.renameFile",
           "when": "view == javaProjectExplorer && viewItem =~ /java:file(?=.*?\\b\\+uri\\b)/",
           "group": "7_modification@10"
         },
         {
-          "command": "java.view.package.moveFileToTrash",
+          "command": "java.view.package.renameFile",
           "when": "view == javaProjectExplorer && viewItem =~ /java:type(?=.*?\\b\\+uri\\b)/",
           "group": "7_modification@10"
         },
+        {
+          "command": "java.view.package.moveFileToTrash",
+          "when": "view == javaProjectExplorer && viewItem =~ /java:(package|packageRoot)(?=.*?\\b\\+source\\b)(?=.*?\\b\\+uri\\b)/",
+          "group": "7_modification@20"
+        },
+        {
+          "command": "java.view.package.moveFileToTrash",
+          "when": "view == javaProjectExplorer && viewItem =~ /java:file(?=.*?\\b\\+uri\\b)/",
+          "group": "7_modification@20"
+        },
+        {
+          "command": "java.view.package.moveFileToTrash",
+          "when": "view == javaProjectExplorer && viewItem =~ /java:type(?=.*?\\b\\+uri\\b)/",
+          "group": "7_modification@20"
+        },
         {
           "command": "java.view.package.newJavaClass",
           "when": "view == javaProjectExplorer && viewItem =~ /java:(package|packageRoot)(?=.*?\\b\\+source\\b)(?=.*?\\b\\+uri\\b)/",

diff --git a/package.nls.json b/package.nls.json
@@ -17,6 +17,7 @@
   "contributes.commands.java.view.package.copyRelativeFilePath": "Copy Relative Path",
   "contributes.commands.java.view.package.newJavaClass": "New Java Class",
   "contributes.commands.java.view.package.newPackage": "New Package",
+  "contributes.commands.java.view.package.renameFile": "Rename",
   "contributes.commands.java.view.package.moveFileToTrash": "Delete",
   "configuration.java.dependency.showMembers": "Show the members in the explorer",
   "configuration.java.dependency.syncWithFolderExplorer": "Synchronize Java Projects explorer selection with folder explorer",

diff --git a/package.nls.zh.json b/package.nls.zh.json
@@ -17,6 +17,7 @@
   "contributes.commands.java.view.package.copyRelativeFilePath": "复制相对路径",
   "contributes.commands.java.view.package.newJavaClass": "创建 Java 类",
   "contributes.commands.java.view.package.newPackage": "创建包",
+  "contributes.commands.java.view.package.renameFile": "重命名",
   "contributes.commands.java.view.package.moveFileToTrash": "删除",
   "configuration.java.dependency.showMembers": "在 Java 项目管理器中显示成员",
   "configuration.java.dependency.syncWithFolderExplorer": "在 Java 项目管理器中同步关联当前打开的文件",

diff --git a/src/commands.ts b/src/commands.ts
@@ -36,6 +36,8 @@ export namespace Commands {
 
     export const VIEW_PACKAGE_NEW_JAVA_PACKAGE = "java.view.package.newPackage";
 
+    export const VIEW_PACKAGE_RENAME_FILE = "java.view.package.renameFile";
+
     export const VIEW_PACKAGE_MOVE_FILE_TO_TRASH = "java.view.package.moveFileToTrash";
 
     export const VIEW_PACKAGE_REVEAL_IN_PROJECT_EXPLORER = "java.view.package.revealInProjectExplorer";

diff --git a/src/explorerCommands/delete.ts b/src/explorerCommands/delete.ts
@@ -12,7 +12,6 @@ export async function deleteFiles(node: DataNode, selectedNode: ExplorerNode): P
     // if command not invoked by context menu, use selected node in explorer
     if (!node) {
         node = selectedNode as DataNode;
-        // avoid delete dependency files
         if (!isMutable(node)) {
             return;
         }

diff --git a/src/explorerCommands/rename.ts b/src/explorerCommands/rename.ts
@@ -0,0 +1,44 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+import * as path from "path";
+import { Uri, window, workspace, WorkspaceEdit } from "vscode";
+import { DataNode } from "../views/dataNode";
+import { ExplorerNode } from "../views/explorerNode";
+import { isMutable } from "./utils";
+
+export async function renameFile(node: DataNode, selectedNode: ExplorerNode): Promise<void> {
+    // if command not invoked by context menu, use selected node in explorer
+    if (!node) {
+        node = selectedNode as DataNode;
+        if (!isMutable(node)) {
+            return;
+        }
+    }
+
+    const newName: string | undefined = await window.showInputBox({
+        placeHolder: "Input new file name",
+        value: node.name,
+        ignoreFocusOut: true,
+    });
+
+    if (!newName) {
+        return;
+    }
+
+    const oldFsPath = Uri.parse(node.uri).fsPath;
+    const renamedFilePath = getRenamedFilePath(oldFsPath, newName);
+
+    const workspaceEdit: WorkspaceEdit = new WorkspaceEdit();
+    workspaceEdit.renameFile(Uri.file(oldFsPath), Uri.file(renamedFilePath));
+    workspace.applyEdit(workspaceEdit);
+}
+
+function getRenamedFilePath(oldUri: string, newName: string): string {
+    // preserve default file extension if not provided
+    if (!path.extname(newName)) {
+        newName += path.extname(oldUri);
+    }
+    const dirname = path.dirname(oldUri);
+    return path.join(dirname, newName);
+}
diff --git a/src/explorerCommands/utils.ts b/src/explorerCommands/utils.ts
@@ -4,6 +4,7 @@
 import { DataNode } from "../views/dataNode";
 
 export function isMutable(node: DataNode): boolean {
+    // avoid modify dependency files
     const packageExp = /java:(package|packageRoot)(?=.*?\b\+source\b)(?=.*?\b\+uri\b)/;
     const fileExp = /java:file(?=.*?\b\+uri\b)/;
     const typeExp = /java:type(?=.*?\b\+uri\b)/;

diff --git a/src/views/dependencyExplorer.ts b/src/views/dependencyExplorer.ts
@@ -8,6 +8,7 @@ import { instrumentOperationAsVsCodeCommand } from "vscode-extension-telemetry-w
 import { Commands } from "../commands";
 import { Build } from "../constants";
 import { deleteFiles } from "../explorerCommands/delete";
+import { renameFile } from "../explorerCommands/rename";
 import { isStandardServerReady } from "../extension";
 import { Jdtls } from "../java/jdtls";
 import { INodeData } from "../java/nodeData";
@@ -74,10 +75,15 @@ export class DependencyExplorer implements Disposable {
             }),
         );
 
+        context.subscriptions.push(
+            instrumentOperationAsVsCodeCommand(Commands.VIEW_PACKAGE_RENAME_FILE, (node: DataNode) => {
+                renameFile(node, this._dependencyViewer.selection[0]);
+            }),
+        );
+
         context.subscriptions.push(
             instrumentOperationAsVsCodeCommand(Commands.VIEW_PACKAGE_MOVE_FILE_TO_TRASH, (node: DataNode) => {
-                const firstSelectedNode = this._dependencyViewer.selection[0];
-                deleteFiles(node, firstSelectedNode);
+                deleteFiles(node, this._dependencyViewer.selection[0]);
             }),
         );
     }