Expand scope visualizer api (#1946)

- Required by #1942 to be able to tell which scope is currently being
visualized to highlight it in the sidebar

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet

Author: pokey

packages/cursorless-vscode/src/ScopeVisualizerCommandApi.ts

@@ -1,8 +1,15 @@
-import { ScopeType } from "@cursorless/common";
+import { Disposable, ScopeType } from "@cursorless/common";
 
-export interface ScopeVisualizerCommandApi {
+export type ScopeVisualizerListener = (
+  scopeType: ScopeType | undefined,
+  visualizationType: VisualizationType | undefined,
+) => void;
+
+export interface ScopeVisualizer {
   start(scopeType: ScopeType, visualizationType: VisualizationType): void;
   stop(): void;
+  readonly scopeType: ScopeType | undefined;
+  onDidChangeScopeType(listener: ScopeVisualizerListener): Disposable;
 }
 
 export type VisualizationType = "content" | "removal" | "iteration";

packages/cursorless-vscode/src/extension.ts

@@ -1,4 +1,5 @@
 import {
+  Disposable,
   FakeIDE,
   getFakeCommandServerApi,
   IDE,
@@ -35,7 +36,8 @@ import { KeyboardCommands } from "./keyboard/KeyboardCommands";
 import { registerCommands } from "./registerCommands";
 import { ReleaseNotes } from "./ReleaseNotes";
 import {
-  ScopeVisualizerCommandApi,
+  ScopeVisualizer,
+  ScopeVisualizerListener,
   VisualizationType,
 } from "./ScopeVisualizerCommandApi";
 import { StatusBarItem } from "./StatusBarItem";
@@ -91,13 +93,14 @@ export async function activate(
 
   const statusBarItem = StatusBarItem.create("cursorless.showQuickPick");
   const keyboardCommands = KeyboardCommands.create(context, statusBarItem);
+  const scopeVisualizer = createScopeVisualizer(normalizedIde, scopeProvider);
 
   registerCommands(
     context,
     vscodeIDE,
     commandApi,
     testCaseRecorder,
-    createScopeVisualizerCommandApi(normalizedIde, scopeProvider),
+    scopeVisualizer,
     keyboardCommands,
     hats,
   );
@@ -155,11 +158,14 @@ function createTreeSitter(parseTreeApi: ParseTreeApi): TreeSitter {
   };
 }
 
-function createScopeVisualizerCommandApi(
+function createScopeVisualizer(
   ide: IDE,
   scopeProvider: ScopeProvider,
-): ScopeVisualizerCommandApi {
+): ScopeVisualizer {
   let scopeVisualizer: VscodeScopeVisualizer | undefined;
+  let currentScopeType: ScopeType | undefined;
+
+  const listeners: ScopeVisualizerListener[] = [];
 
   return {
     start(scopeType: ScopeType, visualizationType: VisualizationType) {
@@ -171,11 +177,29 @@ function createScopeVisualizerCommandApi(
         visualizationType,
       );
       scopeVisualizer.start();
+      currentScopeType = scopeType;
+      listeners.forEach((listener) => listener(scopeType, visualizationType));
     },
 
     stop() {
       scopeVisualizer?.dispose();
       scopeVisualizer = undefined;
+      currentScopeType = undefined;
+      listeners.forEach((listener) => listener(undefined, undefined));
+    },
+
+    get scopeType() {
+      return currentScopeType;
+    },
+
+    onDidChangeScopeType(listener: ScopeVisualizerListener): Disposable {
+      listeners.push(listener);
+
+      return {
+        dispose() {
+          listeners.splice(listeners.indexOf(listener), 1);
+        },
+      };
     },
   };
 }

packages/cursorless-vscode/src/registerCommands.ts

@@ -14,14 +14,14 @@ import { showDocumentation, showQuickPick } from "./commands";
 import { VscodeIDE } from "./ide/vscode/VscodeIDE";
 import { VscodeHats } from "./ide/vscode/hats/VscodeHats";
 import { KeyboardCommands } from "./keyboard/KeyboardCommands";
-import { ScopeVisualizerCommandApi } from "./ScopeVisualizerCommandApi";
+import { ScopeVisualizer } from "./ScopeVisualizerCommandApi";
 
 export function registerCommands(
   extensionContext: vscode.ExtensionContext,
   vscodeIde: VscodeIDE,
   commandApi: CommandApi,
   testCaseRecorder: TestCaseRecorder,
-  scopeVisualizer: ScopeVisualizerCommandApi,
+  scopeVisualizer: ScopeVisualizer,
   keyboardCommands: KeyboardCommands,
   hats: VscodeHats,
 ): void {