Remove VSCode from CommandRunner and Cheatsheet (#1246)

pokey · web-flow · commit a0ee7a670f2b · 2023-02-10T05:24:54.000-07:00
diff --git a/src/core/Cheatsheet.ts b/src/core/Cheatsheet.ts
@@ -1,7 +1,5 @@
 import { readFile, writeFile } from "fs/promises";
 import parse from "node-html-parser";
-import * as vscode from "vscode";
-import { Graph } from "../typings/Types";
 import path = require("path");
 import produce from "immer";
 import { sortBy } from "lodash";
@@ -28,104 +26,76 @@ interface CheatSheetCommandArg {
   outputPath: string;
 }
 
-export default class Cheatsheet {
-  private disposables: vscode.Disposable[] = [];
+export async function showCheatsheet({
+  version,
+  spokenFormInfo,
+  outputPath,
+}: CheatSheetCommandArg) {
+  if (version !== 0) {
+    throw new Error(`Unsupported cheatsheet api version: ${version}`);
+  }
 
-  constructor(private graph: Graph) {
-    ide().disposeOnExit(this);
+  const cheatsheetPath = path.join(
+    ide().assetsRoot,
+    "cursorless-nx",
+    "dist",
+    "apps",
+    "cheatsheet-local",
+    "index.html",
+  );
 
-    this.showCheatsheet = this.showCheatsheet.bind(this);
-    this.updateDefaults = this.updateDefaults.bind(this);
-  }
+  const cheatsheetContent = (await readFile(cheatsheetPath)).toString();
 
-  init() {
-    this.disposables.push(
-      vscode.commands.registerCommand(
-        "cursorless.showCheatsheet",
-        this.showCheatsheet,
-      ),
-      vscode.commands.registerCommand(
-        "cursorless.internal.updateCheatsheetDefaults",
-        this.updateDefaults,
-      ),
-    );
-  }
+  const root = parse(cheatsheetContent);
 
-  private async showCheatsheet({
-    version,
+  root.getElementById(
+    "cheatsheet-data",
+  ).textContent = `document.cheatsheetData = ${JSON.stringify(
     spokenFormInfo,
-    outputPath,
-  }: CheatSheetCommandArg) {
-    if (version !== 0) {
-      throw new Error(`Unsupported cheatsheet api version: ${version}`);
-    }
-
-    const cheatsheetPath = path.join(
-      ide().assetsRoot,
-      "cursorless-nx",
-      "dist",
-      "apps",
-      "cheatsheet-local",
-      "index.html",
-    );
-
-    const cheatsheetContent = (await readFile(cheatsheetPath)).toString();
+  )};`;
 
-    const root = parse(cheatsheetContent);
+  await writeFile(outputPath, root.toString());
+}
 
-    root.getElementById(
-      "cheatsheet-data",
-    ).textContent = `document.cheatsheetData = ${JSON.stringify(
-      spokenFormInfo,
-    )};`;
+/**
+ * Updates the default spoken forms stored in `defaults.json` for
+ * development.
+ * @param spokenFormInfo The new value to use for default spoken forms.
+ */
+export async function updateDefaults(spokenFormInfo: CheatsheetInfo) {
+  const { runMode, assetsRoot, workspaceFolders } = ide();
 
-    await writeFile(outputPath, root.toString());
-  }
+  const workspacePath =
+    runMode === "development"
+      ? assetsRoot
+      : workspaceFolders?.[0].uri.path ?? null;
 
-  /**
-   * Updates the default spoken forms stored in `defaults.json` for
-   * development.
-   * @param spokenFormInfo The new value to use for default spoken forms.
-   */
-  private async updateDefaults(spokenFormInfo: CheatsheetInfo) {
-    const { runMode, assetsRoot, workspaceFolders } = ide();
-
-    const workspacePath =
-      runMode === "development"
-        ? assetsRoot
-        : workspaceFolders?.[0].uri.path ?? null;
-
-    if (workspacePath == null) {
-      throw new Error(
-        "Please update defaults from Cursorless workspace or running in debug",
-      );
-    }
-
-    const defaultsPath = path.join(
-      workspacePath,
-      "cursorless-nx",
-      "libs",
-      "cheatsheet",
-      "src",
-      "lib",
-      "data",
-      "sampleSpokenFormInfos",
-      "defaults.json",
+  if (workspacePath == null) {
+    throw new Error(
+      "Please update defaults from Cursorless workspace or running in debug",
     );
+  }
 
-    const outputObject = produce(spokenFormInfo, (draft) => {
-      draft.sections = sortBy(draft.sections, "id");
-      draft.sections.forEach((section) => {
-        section.items = sortBy(section.items, "id");
-      });
+  const defaultsPath = path.join(
+    workspacePath,
+    "cursorless-nx",
+    "libs",
+    "cheatsheet",
+    "src",
+    "lib",
+    "data",
+    "sampleSpokenFormInfos",
+    "defaults.json",
+  );
+
+  const outputObject = produce(spokenFormInfo, (draft) => {
+    draft.sections = sortBy(draft.sections, "id");
+    draft.sections.forEach((section) => {
+      section.items = sortBy(section.items, "id");
     });
+  });
 
-    await writeFile(defaultsPath, JSON.stringify(outputObject, null, "\t"));
-  }
-
-  dispose() {
-    this.disposables.forEach(({ dispose }) => dispose());
-  }
+  await writeFile(defaultsPath, JSON.stringify(outputObject, null, "\t"));
 }
 
 // FIXME: Stop duplicating these types once we have #945
diff --git a/src/core/commandRunner/CommandRunner.ts b/src/core/commandRunner/CommandRunner.ts
@@ -1,10 +1,6 @@
-import * as vscode from "vscode";
 import { ActionType } from "./typings/ActionCommand";
-import { OutdatedExtensionError } from "../../errors";
-import { CURSORLESS_COMMAND_ID } from "../../libs/common/commandIds";
 import ide from "../../libs/cursorless-engine/singletons/ide.singleton";
 import processTargets from "../../processTargets";
-import isTesting from "../../testUtil/isTesting";
 import { Target } from "../../typings/target.types";
 import {
   Graph,
@@ -24,24 +20,13 @@ import { selectionToThatTarget } from "./selectionToThatTarget";
 
 // TODO: Do this using the graph once we migrate its dependencies onto the graph
 export default class CommandRunner {
-  private disposables: vscode.Disposable[] = [];
-
   constructor(
     private graph: Graph,
     private thatMark: ThatMark,
     private sourceMark: ThatMark,
   ) {
-    ide().disposeOnExit(this);
-
     this.runCommandBackwardCompatible =
       this.runCommandBackwardCompatible.bind(this);
-
-    this.disposables.push(
-      vscode.commands.registerCommand(
-        CURSORLESS_COMMAND_ID,
-        this.runCommandBackwardCompatible,
-      ),
-    );
   }
 
   /**
@@ -166,39 +151,17 @@ export default class CommandRunner {
 
       return returnValue;
     } catch (e) {
-      await this.graph.testCaseRecorder.commandErrorHook(e as Error);
       const err = e as Error;
-      if (err instanceof OutdatedExtensionError) {
-        this.showUpdateExtensionErrorMessage(err);
-      } else if (!isTesting()) {
-        vscode.window.showErrorMessage(err.message);
-      }
-      console.error(err.message);
       console.error(err.stack);
-      throw err;
+      throw e;
     } finally {
       if (this.graph.testCaseRecorder.isActive()) {
         this.graph.testCaseRecorder.finallyHook();
       }
     }
   }
 
-  async showUpdateExtensionErrorMessage(err: OutdatedExtensionError) {
-    const item = await vscode.window.showErrorMessage(
-      err.message,
-      "Check for updates",
-    );
-
-    if (item == null) {
-      return;
-    }
-
-    await vscode.commands.executeCommand(
-      "workbench.extensions.action.checkForUpdates",
-    );
-  }
-
-  private runCommandBackwardCompatible(
+  runCommandBackwardCompatible(
     spokenFormOrCommand: string | Command,
     ...rest: unknown[]
   ) {
@@ -226,10 +189,6 @@ export default class CommandRunner {
 
     return this.runCommand(command);
   }
-
-  dispose() {
-    this.disposables.forEach(({ dispose }) => dispose());
-  }
 }
 
 function constructThatTarget(
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,7 +1,9 @@
-import { Range, TextDocument } from "@cursorless/common";
+import { CURSORLESS_COMMAND_ID, Range, TextDocument } from "@cursorless/common";
 import { toVscodeRange } from "@cursorless/vscode-common";
 import * as vscode from "vscode";
+import { showCheatsheet, updateDefaults } from "./core/Cheatsheet";
 import CommandRunner from "./core/commandRunner/CommandRunner";
+import { Command } from "./core/commandRunner/typings/command.types";
 import { ThatMark } from "./core/ThatMark";
 import VscodeIDE from "./ide/vscode/VscodeIDE";
 import FakeIDE from "./libs/common/ide/fake/FakeIDE";
@@ -17,6 +19,7 @@ import {
 import { TargetPlainObject } from "./libs/vscode-common/testUtil/toPlainObject";
 import { plainObjectToTarget } from "./testUtil/fromPlainObject";
 import isTesting from "./testUtil/isTesting";
+import { TestCaseRecorder } from "./testUtil/TestCaseRecorder";
 import { Graph } from "./typings/Types";
 import graphFactories from "./util/graphFactories";
 import makeGraph, { FactoryMap } from "./util/makeGraph";
@@ -62,15 +65,16 @@ export async function activate(
   graph.snippets.init();
   graph.hatTokenMap.init();
   graph.testCaseRecorder.init();
-  graph.cheatsheet.init();
   graph.statusBarItem.init();
   graph.keyboardCommands.init();
 
   const thatMark = new ThatMark();
   const sourceMark = new ThatMark();
 
   // TODO: Do this using the graph once we migrate its dependencies onto the graph
-  new CommandRunner(graph, thatMark, sourceMark);
+  const commandRunner = new CommandRunner(graph, thatMark, sourceMark);
+
+  registerCommands(context, vscodeIDE, commandRunner, graph.testCaseRecorder);
 
   return {
     thatMark,
@@ -105,3 +109,40 @@ export async function activate(
 export function deactivate() {
   // do nothing
 }
+
+function registerCommands(
+  extensionContext: vscode.ExtensionContext,
+  vscodeIde: VscodeIDE,
+  commandRunner: CommandRunner,
+  testCaseRecorder: TestCaseRecorder,
+): void {
+  extensionContext.subscriptions.push(
+    vscode.commands.registerCommand(
+      CURSORLESS_COMMAND_ID,
+      async (spokenFormOrCommand: string | Command, ...rest: unknown[]) => {
+        try {
+          return await commandRunner.runCommandBackwardCompatible(
+            spokenFormOrCommand,
+            ...rest,
+          );
+        } catch (e) {
+          const error = e as Error;
+          if (!isTesting()) {
+            vscodeIde.handleCommandError(error);
+          }
+          await testCaseRecorder.commandErrorHook(error);
+          throw error;
+        }
+      },
+    ),
+
+    vscode.commands.registerCommand(
+      "cursorless.showCheatsheet",
+      showCheatsheet,
+    ),
+    vscode.commands.registerCommand(
+      "cursorless.internal.updateCheatsheetDefaults",
+      updateDefaults,
+    ),
+  );
+}
diff --git a/src/ide/vscode/VscodeIDE.ts b/src/ide/vscode/VscodeIDE.ts
@@ -8,6 +8,7 @@ import { pull } from "lodash";
 import { v4 as uuid } from "uuid";
 import * as vscode from "vscode";
 import { ExtensionContext, window, workspace, WorkspaceFolder } from "vscode";
+import { OutdatedExtensionError } from "../../errors";
 import type { TextDocumentChangeEvent } from "../../libs/common/ide/types/Events";
 import { FlashDescriptor } from "../../libs/common/ide/types/FlashDescriptor";
 import type {
@@ -185,6 +186,29 @@ export default class VscodeIDE implements IDE {
     return this.editorMap.get(editor)!;
   }
 
+  handleCommandError(err: Error) {
+    if (err instanceof OutdatedExtensionError) {
+      this.showUpdateExtensionErrorMessage(err);
+    } else {
+      vscode.window.showErrorMessage(err.message);
+    }
+  }
+
+  private async showUpdateExtensionErrorMessage(err: OutdatedExtensionError) {
+    const item = await vscode.window.showErrorMessage(
+      err.message,
+      "Check for updates",
+    );
+
+    if (item == null) {
+      return;
+    }
+
+    await vscode.commands.executeCommand(
+      "workbench.extensions.action.checkForUpdates",
+    );
+  }
+
   disposeOnExit(...disposables: Disposable[]): () => void {
     this.extensionContext.subscriptions.push(...disposables);
 
diff --git a/src/typings/Types.ts b/src/typings/Types.ts
@@ -6,7 +6,6 @@ import type {
 } from "@cursorless/common";
 import { SyntaxNode } from "web-tree-sitter";
 import { ActionRecord } from "../actions/actions.types";
-import Cheatsheet from "../core/Cheatsheet";
 import Debug from "../core/Debug";
 import HatTokenMap from "../core/HatTokenMap";
 import { ReadOnlyHatMap } from "../core/IndividualHatMap";
@@ -137,11 +136,6 @@ export interface Graph {
    */
   readonly testCaseRecorder: TestCaseRecorder;
 
-  /**
-   * Used to display cheatsheet
-   */
-  readonly cheatsheet: Cheatsheet;
-
   /**
    * Creates a VSCode status bar item
    */
diff --git a/src/util/graphFactories.ts b/src/util/graphFactories.ts
