Add ScopeVisualizer tests

Author: pokey

packages/common/src/ide/fake/FakeIDE.ts

@@ -47,6 +47,7 @@ export default class FakeIDE implements IDE {
   ): Promise<void> {
     // empty
   }
+
   async setScopeVisualizationRanges(
     _scopeRanges: EditorScopeRanges[],
   ): Promise<void> {

packages/common/src/ide/spy/SpyIDE.ts

@@ -3,24 +3,35 @@ import { GeneralizedRange } from "../../types/GeneralizedRange";
 import { TextEditor } from "../../types/TextEditor";
 import PassthroughIDEBase from "../PassthroughIDEBase";
 import { FlashDescriptor } from "../types/FlashDescriptor";
-import type { HighlightId, IDE } from "../types/ide.types";
+import type {
+  HighlightId,
+  IDE,
+  EditorScopeRanges,
+  ScopeRanges,
+} from "../types/ide.types";
 import SpyMessages, { Message } from "./SpyMessages";
 
 interface Highlight {
   highlightId: HighlightId | undefined;
   ranges: GeneralizedRange[];
 }
 
+interface ScopeVisualization {
+  scopeRanges: ScopeRanges[];
+}
+
 export interface SpyIDERecordedValues {
   messages?: Message[];
   flashes?: FlashDescriptor[];
   highlights?: Highlight[];
+  scopeVisualizations?: ScopeVisualization[];
 }
 
 export default class SpyIDE extends PassthroughIDEBase {
   messages: SpyMessages;
   private flashes: FlashDescriptor[] = [];
   private highlights: Highlight[] = [];
+  private scopeVisualizations: ScopeVisualization[] = [];
 
   constructor(original: IDE) {
     super(original);
@@ -32,6 +43,10 @@ export default class SpyIDE extends PassthroughIDEBase {
       messages: this.messages.getSpyValues(),
       flashes: isFlashTest ? this.flashes : undefined,
       highlights: this.highlights.length === 0 ? undefined : this.highlights,
+      scopeVisualizations:
+        this.scopeVisualizations.length === 0
+          ? undefined
+          : this.scopeVisualizations,
     };
 
     return values(ret).every((value) => value == null)
@@ -55,4 +70,14 @@ export default class SpyIDE extends PassthroughIDEBase {
     });
     return super.setHighlightRanges(highlightId, editor, ranges);
   }
+
+  async setScopeVisualizationRanges(
+    scopeRanges: EditorScopeRanges[],
+  ): Promise<void> {
+    this.scopeVisualizations.push(
+      ...scopeRanges.map(({ scopeRanges }) => ({
+        scopeRanges,
+      })),
+    );
+  }
 }

packages/common/src/testUtil/runTestSubset.ts

@@ -4,7 +4,7 @@
  * configuration.
  * See https://mochajs.org/#-grep-regexp-g-regexp for supported syntax
  */
-export const TEST_SUBSET_GREP_STRING = "snippets";
+export const TEST_SUBSET_GREP_STRING = "visualizer";
 
 /**
  * Determine whether we should run just the subset of the tests specified by

packages/common/src/testUtil/toPlainObject.ts

@@ -3,6 +3,7 @@ import type {
   GeneralizedRange,
   LineRange,
   Message,
+  ScopeType,
   SpyIDERecordedValues,
 } from "..";
 import { FlashStyle, isLineRange } from "..";
@@ -39,10 +40,22 @@ interface PlainHighlight {
   ranges: GeneralizedRangePlainObject[];
 }
 
+interface PlainScopeRanges {
+  scopeType: ScopeType;
+  domain: GeneralizedRangePlainObject;
+  contentRanges?: GeneralizedRangePlainObject[];
+  removalRanges?: GeneralizedRangePlainObject[];
+}
+
+export interface PlainScopeVisualization {
+  scopeRanges: PlainScopeRanges[];
+}
+
 export interface PlainSpyIDERecordedValues {
   messages: Message[] | undefined;
   flashes: PlainFlashDescriptor[] | undefined;
   highlights: PlainHighlight[] | undefined;
+  scopeVisualizations: PlainScopeVisualization[] | undefined;
 }
 
 export type SelectionPlainObject = {
@@ -150,5 +163,17 @@ export function spyIDERecordedValuesToPlainObject(
         generalizedRangeToPlainObject(range),
       ),
     })),
+    scopeVisualizations: input.scopeVisualizations?.map(({ scopeRanges }) => ({
+      scopeRanges: scopeRanges.map((scopeRange) => ({
+        scopeType: scopeRange.scopeType,
+        domain: generalizedRangeToPlainObject(scopeRange.domain),
+        contentRanges: scopeRange.contentRanges?.map((range) =>
+          generalizedRangeToPlainObject(range),
+        ),
+        removalRanges: scopeRange.removalRanges?.map((range) =>
+          generalizedRangeToPlainObject(range),
+        ),
+      })),
+    })),
   };
 }

packages/cursorless-engine/src/ScopeVisualizer.ts

@@ -31,7 +31,7 @@ export class ScopeVisualizer implements Disposable {
     // be better to have this happen in VSCode-specific impl, but that's tricky
     // because the VSCode impl doesn't know about the visualization type.
     await this.clearHighlights();
-    this.debouncer.run();
+    await this.highlightScopes();
   }
 
   private disposables: Disposable[] = [];

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -6,7 +6,6 @@ import {
   ScopeType,
 } from "@cursorless/common";
 import { StoredTargetMap, TestCaseRecorder, TreeSitter } from ".";
-import { ScopeVisualizer as ScopeVisualizerImpl } from "./ScopeVisualizer";
 import { VisualizationType } from "./VisualizationType";
 import { Debug } from "./core/Debug";
 import { HatTokenMapImpl } from "./core/HatTokenMapImpl";
@@ -18,6 +17,7 @@ import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandler
 import { runCommand } from "./runCommand";
 import { runIntegrationTests } from "./runIntegrationTests";
 import { injectIde } from "./singletons/ide.singleton";
+import { ScopeVisualizer as ScopeVisualizerImpl } from "./ScopeVisualizer";
 
 export function createCursorlessEngine(
   treeSitter: TreeSitter,
@@ -83,13 +83,13 @@ export function createCursorlessEngine(
     },
     scopeVisualizer: {
       start(scopeType: ScopeType, visualizationType: string) {
-        scopeVisualizer.setScopeType({
+        return scopeVisualizer.setScopeType({
           scopeType,
           visualizationType: visualizationType as VisualizationType,
         });
       },
       stop() {
-        scopeVisualizer.setScopeType(undefined);
+        return scopeVisualizer.setScopeType(undefined);
       },
     },
     testCaseRecorder,
@@ -117,8 +117,8 @@ export interface CommandApi {
 }
 
 export interface ScopeVisualizer {
-  start(scopeType: ScopeType, visualizationType: string): void;
-  stop(): void;
+  start(scopeType: ScopeType, visualizationType: string): Promise<void>;
+  stop(): Promise<void>;
 }
 
 export interface CursorlessEngine {

packages/cursorless-engine/src/scripts/transformRecordedTests/upgradeDecorations.ts

@@ -62,6 +62,7 @@ export const upgradeDecorations: FixtureTransformation = (
             range: extractHighlightRange(flash),
             style: extractHighlightName(flash.name) as keyof typeof FlashStyle,
           })),
+    scopeVisualizations: undefined,
   };
 
   return reorderFields(fixture as TestCaseFixture);