Merge pull request #265 from gjsjohnmurray/fix-254

fix #254 detect doubleclick on ObjectScript Explorer items

Author: gjsjohnmurray

package.json

@@ -55,9 +55,7 @@
     "onCommand:vscode-objectscript.viewOthers",
     "onCommand:vscode-objectscript.previewXml",
     "onCommand:vscode-objectscript.explorer.refresh",
-    "onCommand:vscode-objectscript.explorer.openClass",
-    "onCommand:vscode-objectscript.explorer.openRoutine",
-    "onCommand:vscode-objectscript.explorer.openCSPFile",
+    "onCommand:vscode-objectscript.explorer.open",
     "onCommand:vscode-objectscript.compileFolder",
     "onCommand:vscode-objectscript.importFolder",
     "onLanguage:objectscript",

src/explorer/explorer.ts

@@ -5,9 +5,44 @@ import { AtelierAPI } from "../api";
 import { config } from "../extension";
 import { WorkspaceNode } from "./models/workspaceNode";
 
+// The vscode-objectscript.explorer.open command is not listed in settings.json as a contribution because it only gets invoked
+//  from the user's click on an item in the ObjectScriptExplorerProvider tree.
+// It serves as a proxy for the vscode.open command, detecting two opens of the same item in quick succession
+//  and treating the second of these as a non-preview open.
+export function registerExplorerOpen(explorerProvider: ObjectScriptExplorerProvider): vscode.Disposable {
+  return vscode.commands.registerCommand("vscode-objectscript.explorer.open", async function (uri: vscode.Uri) {
+    let usePreview = <boolean>vscode.workspace.getConfiguration("workbench.editor").get("enablePreview");
+
+    if (usePreview) {
+      usePreview = !wasDoubleClick(uri, explorerProvider);
+    }
+
+    await vscode.commands.executeCommand("vscode.open", uri, { preview: usePreview });
+  });
+}
+
+// Return true if previously called with the same arguments within the past 0.5 seconds
+function wasDoubleClick(uri: vscode.Uri, explorerProvider: ObjectScriptExplorerProvider): boolean {
+  let result = false;
+  if (explorerProvider.lastOpened) {
+    const isTheSameUri = explorerProvider.lastOpened.uri === uri;
+    const dateDiff = <number>(<any>new Date() - <any>explorerProvider.lastOpened.date);
+    result = isTheSameUri && dateDiff < 500;
+  }
+
+  explorerProvider.lastOpened = {
+    uri: uri,
+    date: new Date(),
+  };
+  return result;
+}
 export class ObjectScriptExplorerProvider implements vscode.TreeDataProvider<NodeBase> {
   public onDidChange?: vscode.Event<vscode.Uri>;
   public onDidChangeTreeData: vscode.Event<NodeBase>;
+
+  // Use for detecting doubleclick
+  public lastOpened: { uri: vscode.Uri; date: Date };
+
   private _onDidChangeTreeData: vscode.EventEmitter<NodeBase>;
   private _showExtra4Workspace: { [key: string]: string[] }[] = [];
 

src/explorer/models/classNode.ts

@@ -17,8 +17,8 @@ export class ClassNode extends NodeBase {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
         arguments: [itemUri],
-        command: "vscode-objectscript.explorer.openClass",
-        title: "Open class",
+        command: "vscode-objectscript.explorer.open",
+        title: "Open Class",
       },
       resourceUri: isLocalFile ? itemUri : undefined,
       contextValue: "dataNode:classNode",

src/explorer/models/cspFileNode.ts

@@ -17,7 +17,7 @@ export class CSPFileNode extends NodeBase {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
         arguments: [itemUri],
-        command: "vscode-objectscript.explorer.openCSPFile",
+        command: "vscode-objectscript.explorer.open",
         title: "Open File",
       },
       resourceUri: isLocalFile ? itemUri : undefined,

src/explorer/models/routineNode.ts

@@ -17,8 +17,8 @@ export class RoutineNode extends NodeBase {
       collapsibleState: vscode.TreeItemCollapsibleState.None,
       command: {
         arguments: [itemUri],
-        command: "vscode-objectscript.explorer.openRoutine",
-        title: "Open routine",
+        command: "vscode-objectscript.explorer.open",
+        title: "Open Routine",
       },
       resourceUri: isLocalFile ? itemUri : undefined,
       contextValue: "dataNode:routineNode",

src/extension.ts

@@ -59,7 +59,7 @@ import { StatusCodeError } from "request-promise/errors";
 import { AtelierAPI } from "./api";
 import { ObjectScriptDebugAdapterDescriptorFactory } from "./debug/debugAdapterFactory";
 import { ObjectScriptConfigurationProvider } from "./debug/debugConfProvider";
-import { ObjectScriptExplorerProvider } from "./explorer/explorer";
+import { ObjectScriptExplorerProvider, registerExplorerOpen } from "./explorer/explorer";
 import { WorkspaceNode } from "./explorer/models/workspaceNode";
 import { FileSystemProvider } from "./providers/FileSystemPovider/FileSystemProvider";
 import { WorkspaceSymbolProvider } from "./providers/WorkspaceSymbolProvider";
@@ -579,9 +579,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
     vscode.commands.registerCommand("vscode-objectscript.serverActions", serverActions),
     vscode.commands.registerCommand("vscode-objectscript.touchBar.viewOthers", viewOthers),
     vscode.commands.registerCommand("vscode-objectscript.explorer.refresh", () => explorerProvider.refresh()),
-    vscode.commands.registerCommand("vscode-objectscript.explorer.openClass", vscode.window.showTextDocument),
-    vscode.commands.registerCommand("vscode-objectscript.explorer.openRoutine", vscode.window.showTextDocument),
-    vscode.commands.registerCommand("vscode-objectscript.explorer.openCSPFile", vscode.window.showTextDocument),
+    // Register the vscode-objectscript.explorer.open command elsewhere
+    registerExplorerOpen(explorerProvider),
     vscode.commands.registerCommand("vscode-objectscript.explorer.export", (item, items) =>
       exportExplorerItem(items && items.length ? items : [item])
     ),