v1.4.0 - Added titles to dialogs for

all commands.
robole · Apr 5, 2023 · c986931 · c986931
1 parent 260026c
commit c986931
Show file tree

Hide file tree

Showing 10 changed files with 72 additions and 58 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,28 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/-0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2023-03-05
+
+### Added
+
+- Added a title to the dropdown of all commands to clearly identify the command being run. It was added for the following commands:
+	- Open File,
+	- Open File to the Right,
+	- Open File to the Left,
+	- Open File Above,
+	- Open File Below,
+	- Open File in External Default App
+
+### Changed
+
+- Changed the title to include *step name (field changed)* to clearly identify the value being requested/edited. Now the title is in the form of "<command name> - <step name> - <cumlative value from previous steps>". This was changed for the following commands:
+	- Duplicate Active File,
+	- Duplicate File,
+	- Move File,
+	- Create New File,
+	- Create New Folder
+- Changed wording of some titles and placeholder text to be more consistently phrased.
+
 ## [1.3.7] - 2023-03-05
 
 ### Fixed

diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   },
   "description": "Perform file actions quickly with keyboard-driven file selection. 🐰⌨️",
   "icon": "img/logo.png",
-  "version": "1.3.7",
+  "version": "1.4.0",
   "engines": {
     "vscode": "^1.46.0",
     "node": ">=12"

diff --git a/src/duplicateActiveFilePicker.js b/src/duplicateActiveFilePicker.js
@@ -12,11 +12,11 @@ const util = require("./util");
 class DuplicateActiveFilePicker extends MultiStepPicker {
   constructor() {
     let steps = [
-      new Step(1, `Duplicate Active File`, "Pick a location", []),
+      new Step(1, `Duplicate Active File - location`, "Pick a location", []),
       new Step(
         2,
-        `Duplicate Active File`,
-        "Type a filename",
+        `Duplicate Active File - name`,
+        "Enter a name",
         [],
         [vscode.QuickInputButtons.Back]
       ),
@@ -27,7 +27,7 @@ class DuplicateActiveFilePicker extends MultiStepPicker {
     this.fileName = nodePath.basename(
       vscode.window.activeTextEditor.document.fileName
     );
-    this.steps[0].title = `Duplicate '${this.fileName}'`;
+
     this.steps[1].value = this.fileName;
 
     if (util.isWorkspaceOpen()) {
@@ -77,10 +77,9 @@ class DuplicateActiveFilePicker extends MultiStepPicker {
       this.picker.value = "";
 
       this.currentStepNum = 2;
-      this.steps[1].title = `Duplicate '${this.fileName}' to '${nodePath.join(
-        selection,
+      this.steps[1].title = `Duplicate Active File - name - '${
         this.fileName
-      )}'`;
+      }' to '${nodePath.join(selection, this.fileName)}'`;
       this.setCurrentStep(this.steps[1]);
     } else if (this.currentStepNum === 2) {
       this.steps[1].value = currentValue;
@@ -115,7 +114,7 @@ class DuplicateActiveFilePicker extends MultiStepPicker {
   }
 
   setTitle(filepath) {
-    this.picker.title = `Duplicate '${this.fileName}' to '${filepath}'`;
+    this.picker.title = `Duplicate Active File - name - '${this.fileName}' to '${filepath}'`;
   }
 
   async duplicateFile() {

diff --git a/src/duplicateFilePicker.js b/src/duplicateFilePicker.js
@@ -12,18 +12,18 @@ const util = require("./util");
 class DuplicateFilePicker extends MultiStepPicker {
   constructor() {
     let steps = [
-      new Step(1, `Duplicate File`, "Pick a file to duplicate", []),
+      new Step(1, `Duplicate File - file`, "Pick a file", []),
       new Step(
         2,
-        `Duplicate File`,
+        `Duplicate File - location`,
         "Pick a location",
         [],
         [vscode.QuickInputButtons.Back]
       ),
       new Step(
         3,
-        `Duplicate File`,
-        "Type a filename",
+        `Duplicate File - name`,
+        "Enter a name",
         [],
         [vscode.QuickInputButtons.Back]
       ),
@@ -84,14 +84,14 @@ class DuplicateFilePicker extends MultiStepPicker {
       this.steps[0].value = selection;
       this.picker.value = "";
 
-      this.steps[1].title = `Duplicate '${this.steps[0].value}' to`;
+      this.steps[1].title = `Duplicate File - location - '${this.steps[0].value}' to?`;
 
       this.goForward();
     } else if (this.currentStepNum === 2) {
       let selection = pickedItems[0].name;
       this.steps[1].value = selection;
 
-      this.steps[2].title = `Duplicate '${this.steps[0].value}' to '${this.steps[1].value}'`;
+      this.steps[2].title = `Duplicate File - name - '${this.steps[0].value}' to '${this.steps[1].value}'`;
       this.steps[2].value = nodePath.basename(this.steps[0].value); // only want filename from step 1
 
       this.goForward();
@@ -111,7 +111,7 @@ class DuplicateFilePicker extends MultiStepPicker {
   }
 
   setTitle(from, to) {
-    this.picker.title = `Duplicate '${from}' to '${to}'`;
+    this.picker.title = `Duplicate File - name - '${from}' to '${to}'`;
   }
 
   async duplicateFile() {

diff --git a/src/fileAction.js b/src/fileAction.js
@@ -25,7 +25,7 @@ async function openFile() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile("Open File");
 
   if (selectedFile !== undefined) {
     await vscode.commands.executeCommand("vscode.open", selectedFile);
@@ -37,7 +37,9 @@ async function openFileExternal() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile(
+    "Open File in External Default App"
+  );
 
   if (selectedFile !== undefined) {
     try {
@@ -67,7 +69,7 @@ async function openFileAbove() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile("Open File Above");
 
   if (selectedFile !== undefined) {
     await vscode.commands.executeCommand("workbench.action.splitEditorUp");
@@ -83,7 +85,7 @@ async function openFileBelow() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile("Open File Below");
 
   if (selectedFile !== undefined) {
     await vscode.commands.executeCommand("workbench.action.splitEditorDown");
@@ -99,7 +101,7 @@ async function openFileToRight() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile("Open File to the Right");
 
   if (selectedFile !== undefined) {
     await vscode.commands.executeCommand("workbench.action.splitEditorRight");
@@ -115,7 +117,7 @@ async function openFileToLeft() {
     return;
   }
 
-  let selectedFile = await selectWorkspaceFile();
+  let selectedFile = await selectWorkspaceFile("Open File to the Left");
 
   if (selectedFile !== undefined) {
     await vscode.commands.executeCommand("workbench.action.splitEditorLeft");
@@ -126,7 +128,7 @@ async function openFileToLeft() {
   }
 }
 
-async function selectWorkspaceFile() {
+async function selectWorkspaceFile(title = "") {
   if (util.isWorkspaceOpen() === false) {
     return undefined;
   }
@@ -143,7 +145,8 @@ async function selectWorkspaceFile() {
 
   let selectedFile = await vscode.window.showQuickPick(pickerItems, {
     ignoreFocusOut: true,
-    placeHolder: `Open file`,
+    placeHolder: `Pick a file`,
+    title,
   });
 
   if (selectedFile !== undefined) {
@@ -179,7 +182,7 @@ async function moveActiveFile() {
   let selectedFolder = await vscode.window.showQuickPick(pickerItems, {
     ignoreFocusOut: true,
     placeHolder: `Pick a location`,
-    title: `Move file`,
+    title: `Move Active File`,
   });
 
   if (selectedFolder !== undefined) {
@@ -224,7 +227,7 @@ async function renameActiveFile() {
 
   let newName = await vscode.window.showInputBox({
     value: name,
-    prompt: `Rename file: ${getRelativePathOfActiveFile()}`,
+    prompt: `Rename Active File - '${getRelativePathOfActiveFile()}'`,
   });
 
   if (

diff --git a/src/folderAction.js b/src/folderAction.js
@@ -80,7 +80,7 @@ async function duplicateFolder() {
 
 async function deleteFolder() {
   if (vscode.workspace.workspaceFolders) {
-    let selectedFolder = await selectWorkspaceFolder(false);
+    let selectedFolder = await selectWorkspaceFolder(false, "Delete Folder");
 
     if (selectedFolder !== undefined) {
       let newUri = vscode.Uri.file(selectedFolder.path);
@@ -106,7 +106,10 @@ async function openWorkspaceFolderExternal() {
 }
 
 async function openFolderExternal() {
-  let selectedFolder = await selectWorkspaceFolder(false);
+  let selectedFolder = await selectWorkspaceFolder(
+    false,
+    "Open Workspace Folder in External Default App"
+  );
 
   if (selectedFolder !== undefined) {
     try {
@@ -118,7 +121,7 @@ async function openFolderExternal() {
   }
 }
 
-async function selectWorkspaceFolder(includeTopFolder = true) {
+async function selectWorkspaceFolder(includeTopFolder = true, title = "") {
   if (vscode.workspace.workspaceFolders === undefined) {
     return undefined;
   }
@@ -139,7 +142,8 @@ async function selectWorkspaceFolder(includeTopFolder = true) {
 
   let selectedFolder = await vscode.window.showQuickPick(pickerItems, {
     ignoreFocusOut: true,
-    placeHolder: `Choose folder`,
+    placeHolder: `Pick a folder`,
+    title,
   });
 
   return selectedFolder;

diff --git a/src/moveFilePicker.js b/src/moveFilePicker.js
@@ -12,10 +12,10 @@ const util = require("./util");
 class MoveFilePicker extends MultiStepPicker {
   constructor() {
     let steps = [
-      new Step(1, `Move File`, "Pick a file to move", []),
+      new Step(1, `Move File - file`, "Pick a file", []),
       new Step(
         2,
-        `Move File`,
+        `Move File - location`,
         "Pick a location",
         [],
         [vscode.QuickInputButtons.Back]
@@ -27,11 +27,6 @@ class MoveFilePicker extends MultiStepPicker {
     if (util.isWorkspaceOpen()) {
       this.rootFolder = vscode.workspace.workspaceFolders[0].uri.fsPath;
     }
-
-    let disposable1 = this.picker.onDidChangeValue(
-      this.onDidChangeValue.bind(this)
-    );
-    this.disposables.push(disposable1);
   }
 
   async run() {
@@ -78,7 +73,7 @@ class MoveFilePicker extends MultiStepPicker {
       this.steps[0].value = selection;
       this.picker.value = "";
 
-      this.steps[1].title = `Move '${selection}' to`;
+      this.steps[1].title = `Move File - location - '${selection}'`;
 
       this.goForward();
     } else if (this.currentStepNum === 2) {
@@ -106,17 +101,6 @@ class MoveFilePicker extends MultiStepPicker {
     }
   }
 
-  onDidChangeValue(newValue) {
-    if (this.currentStepNum === 2) {
-      let newFilePath = nodePath.join(this.steps[1].value, newValue);
-      this.setTitle(this.steps[0].value, newFilePath);
-    }
-  }
-
-  setTitle(from, to) {
-    this.picker.title = `Move '${from}' to '${to}'`;
-  }
-
   async moveFile() {
     let sourceUri = vscode.Uri.file(
       nodePath.join(this.rootFolder, this.steps[0].value)

diff --git a/src/newFilePicker.js b/src/newFilePicker.js
@@ -12,11 +12,11 @@ const configuration = require("./configuration");
 class NewFilePicker extends MultiStepPicker {
   constructor() {
     let steps = [
-      new Step(1, "Create a new file", "Pick a location"),
+      new Step(1, "Create New File - location", "Pick a location"),
       new Step(
         2,
-        "Create a new file",
-        "Type a filename (use left arrow key to return to previous step)",
+        "Create New File - name",
+        "Enter a name",
         [],
         [vscode.QuickInputButtons.Back]
       ),
@@ -107,7 +107,7 @@ class NewFilePicker extends MultiStepPicker {
   }
 
   setTitle(filepath) {
-    this.picker.title = `Create a new file: "${filepath}"`;
+    this.picker.title = `Create New File - name - "${filepath}"`;
   }
 }
 

diff --git a/src/newFolderPicker.js b/src/newFolderPicker.js
@@ -12,11 +12,11 @@ const configuration = require("./configuration");
 class NewFolderPicker extends MultiStepPicker {
   constructor() {
     let steps = [
-      new Step(1, "Create a new folder", "Pick a location"),
+      new Step(1, "Create New Folder - Location", "Pick a location"),
       new Step(
         2,
-        "Create a new folder",
-        "Type a name (use left arrow key to return to previous step)",
+        "Create New Folder - Name",
+        "Enter a name",
         [],
         [vscode.QuickInputButtons.Back]
       ),
@@ -95,7 +95,7 @@ class NewFolderPicker extends MultiStepPicker {
   }
 
   setTitle(filepath) {
-    this.picker.title = `Create a new folder: "${filepath}"`;
+    this.picker.title = `Create New Folder - name - '${filepath}'`;
   }
 }
 

diff --git a/todo.md b/todo.md
@@ -2,10 +2,12 @@
 
 ## Tasks
 
+1. For `Move File` - cease opening the file at the end of the action?
+1. Add command name to title for `Open Folder`?
 1. Have a git files (`git ls-files`) version of `File Bunny: Open File`. See branch *open-gitfiles*.
 1. Add recent items to top of file list for `File Bunny: Open Folder`.
 1. Add more tests (refactor).
-1. `File Bunny: New Project from Template`
+1. `File Bunny: New Project from Template`?
 1. Add multi-root workspace support?
 
 ## Long-standing API issues