1.6.0

* When workspace storage directory has not been entered the notification dialog will now provide an option to choose the workspace by opening a file dialog.
* Updated Change Icon to force reload icons that are overwritten by the user

Author: Tom Saunders

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to the "vscode-workspace-explorer" extension will be documented in this file.
 
+## 1.6.0
+* When workspace storage directory has not been entered the notification dialog will now provide an option to choose the workspace by opening a file dialog.
+* Updated Change Icon to force reload icons that are overwritten by the user
+
 ## 1.5.0
 * Added Container Development Environment
 * Enabled multi-select in Open Workspace Storage Directory dialog.

README.md

@@ -181,6 +181,10 @@ Workspace Explorer contributes the following settings:
 
 # Release Notes
 
+## 1.6.0
+* When workspace storage directory has not been entered the notification dialog will now provide an option to choose the workspace by opening a file dialog.
+* Updated Change Icon to force reload icons that are overwritten by the user
+
 ## 1.5.0
 * Added Experimantal Create Workspace right click option.
 * Added Experimental Create Workspace button on the Workspace Explorer navigation menu.
@@ -238,12 +242,6 @@ the initial version of the code for this feature.
 
 # Development Roadmap
 ## Proposed Features:
-* Add the ability to create a new sub-folder.
-    * **Feature Built** Waiting for tree view drag and drop API to be stable in VSCode.
-    * A button would be added to the title bar indicating a new folder.
-    * The default location of the new folder would be in the
-    **Workspace Storage Directory**, but a **sub-folder** in the Workspace
-    Explorer could be selected before clicking the button.
 * Add the ability to open the Additional Custom Icon Directory from the Workspace Explorer
     * Add a button the the title bar that would open a file explorer
     at the Additional Custom Icon Directory.

package-lock.json

@@ -2,7 +2,7 @@
     "name": "vscode-workspace-explorer",
     "displayName": "Workspace Explorer",
     "description": "An explorer panel that allows you to list your collection of workspaces and load them one at a time into the IDE or open a new window with the selected workspace.",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "icon": "resources/icons/icon.png",
     "publisher": "tomsaunders",
     "author": {

package.json

@@ -99,19 +99,10 @@ const changeIcon = async (context, treeDataProvider) => {
     // Copy the file to the Workspace Storage Directory.
     await vscode.workspace.fs.copy(inputResults[0], destinationUri);
 
-    // Refresh Tree
-    treeDataProvider.refresh();
-
-    // VSCode does not reload image resources with same URI.
-    if (conflictingFile) {
-      const response = await vscode.window.showInformationMessage(
-        'VSCode requires a reload for images with the same name',
-        ...['Reload Now', 'Do it Later'],
-      );
-      if (response === 'Reload Now') {
-        vscode.commands.executeCommand('workbench.action.reloadWindow');
-      }
-    }
+    // Refresh Tree and send URI to force VSCode to relaod
+    // with dummy query args.
+    treeDataProvider.refresh(conflictingFile);
+
   } catch (err) {
     vscode.window.showErrorMessage(`ERROR: ${err}`);
   }

resources/images/workspaceStorageDirectory.gif

@@ -83,37 +83,59 @@ class WorkspaceTreeDataProvider {
     this.onDidChangeTreeData = this._onDidChangeTreeData.event;
     this.extensionConfig;
     this.workspaceStorageDirectory;
+    this.targetIconUri;
     this.getConfigs();
   }
 
   // Gets user set configuration values.
-  getConfigs() {
-    this.extensionConfig = vscode.workspace.getConfiguration(
-      'workspaceExplorer',
-    );
-    if (this.extensionConfig.workspaceStorageDirectory === '') {
-      vscode.window.showWarningMessage(
-        'Workspace Explorer: You must set the workspace '
-        + 'storage directory in your vscode settings. Copy this to your '
-        + 'clipboard: workspaceExplorer.workspaceStorageDirectory. Then '
-        + 'click Open Settings and paste it in the search window.',
-        ...['Open Settings'],
-      ).then((results) => {
-        if (results === 'Open Settings') {
-          vscode.commands.executeCommand('workbench.action.openSettings2');
-        }
-      });
-    } else {
-      this.workspaceStorageDirectory = (
-        this.extensionConfig.workspaceStorageDirectory
+  async getConfigs() {
+    try {
+      this.extensionConfig = vscode.workspace.getConfiguration(
+        'workspaceExplorer',
       );
+      if (this.extensionConfig.workspaceStorageDirectory === '') {
+        const results = await vscode.window.showWarningMessage(
+          'Workspace Explorer: You must set the workspace '
+          + 'storage directory to use the Workspace Explorer. '
+          + 'This is the directory where you want to keep your '
+          + 'workspace configuration files.',
+          ...['Choose a Directory'],
+        );
+        if (results === 'Choose a Directory') {
+          const config = vscode.workspace.getConfiguration(
+            'workspaceExplorer',
+          );
+          const userFolder = await vscode.window.showOpenDialog(
+            {
+              canSelectFiles: false,
+              canSelectFolders: true,
+              canSelectMany: false,
+            },
+          );
+          if (userFolder) {
+            await config.update(
+              'workspaceStorageDirectory',
+              userFolder[0].fsPath,
+              vscode.ConfigurationTarget.Global,
+            );
+            this.refresh();
+          }
+        }
+      } else {
+        this.workspaceStorageDirectory = (
+          this.extensionConfig.workspaceStorageDirectory
+        );
+      }
+    } catch (err) {
+      vscode.window.showErrorMessage(err);
     }
   }
 
   // Rebuilds the Tree of workspaces and sub-folders.
   // Repopulates the Workspace Explorer view.
-  refresh() {
+  refresh(targetIconUri) {
     this.getConfigs();
+    this.targetIconUri = targetIconUri;
     this._onDidChangeTreeData.fire();
   }
 
@@ -124,12 +146,36 @@ class WorkspaceTreeDataProvider {
 
   // Gets vscode Tree Items representing a workspace or folder.
   getTreeItem(element) {
-    return new WorkspaceTreeItem(
+    // Check if item is using an icon that must be force reloaded due
+    // to a change icon action initiated by the user who overwrote the
+    // original icon file.
+    let useNewUri = false;
+    if (this.targetIconUri) {
+      const partialIconPath = this.targetIconUri.fsPath.replace(
+        path.extname(this.targetIconUri.fsPath),
+        '',
+      );
+      const partialWorkspacePath = element.workspaceFileNameAndFilePath.replace(
+        path.extname(element.workspaceFileNameAndFilePath),
+        '',
+      );
+      if (partialIconPath === partialWorkspacePath) {
+        useNewUri = true;
+      }
+    }
+    const treeItem = new WorkspaceTreeItem(
       element.label,
       element.workspaceFileNameAndFilePath,
       element.collapsableState,
       this.extensionConfig,
+      useNewUri,
     );
+
+    if (useNewUri) {
+      this.targetIconUri = '';
+    }
+
+    return treeItem;
   }
 
   // This runs on activation and any time a collapsed item is expanded.

resources/images/workspaceStorageDirectory_480p.gif

@@ -102,18 +102,33 @@ class WorkspaceTreeItem extends vscode.TreeItem {
     workspaceFileNameAndFilePath,
     collapsableState,
     extensionConfig,
+    useNewUri,
   ) {
     super(label, collapsableState);
     this.workspaceFileNameAndFilePath = workspaceFileNameAndFilePath;
 
     // Look for custom icons if configuration setting is enabled.
     // Else, get defaults.
     if (extensionConfig.enableCustomIconSearch === true) {
-      this.iconPath = getCustomWorkspaceIcons(
+      const icons = getCustomWorkspaceIcons(
         workspaceFileNameAndFilePath,
         collapsableState,
         extensionConfig,
       );
+      if (useNewUri) {
+        // Create dummy query args to force reload of icon that has
+        // been overwritten by the user.
+        this.iconPath = {
+          light: vscode.Uri.file(icons.light).with(
+            { query: `x=${Math.random()}` },
+          ),
+          dark: vscode.Uri.file(icons.dark).with(
+            { query: `x=${Math.random()}` },
+          ),
+        };
+      } else {
+        this.iconPath = icons;
+      }
     } else {
       this.iconPath = getDefaultWorkspaceIcons(collapsableState);
     }