Changed to flash ranges

Author: AndreasArvidsson

cursorless-everywhere-talon/cursorless_everywhere_talon.py

@@ -1,13 +1,12 @@
 import json
-from typing import Any, Optional, Union
+from typing import Any
 
 from talon import Context, Module, actions
 
 from .cursorless_everywhere_types import (
-    CharacterRangeOffsets,
     EditorEdit,
     EditorState,
-    LineRange,
+    FlashDescriptorOffsets,
     SelectionOffsets,
 )
 
@@ -80,10 +79,9 @@ def private_cursorless_talonjs_run_no_wait(
     def private_cursorless_talonjs_get_response_json() -> str:  # pyright: ignore [reportReturnType]
         """Returns the response from the last Cursorless command"""
 
-    def cursorless_everywhere_set_highlight_ranges(
-        ranges: list[Union[CharacterRangeOffsets, LineRange]],  # pyright: ignore [reportGeneralTypeIssues]
-        highlightId: Optional[str] = None,
+    def cursorless_everywhere_flash_ranges(
+        ranges: list[FlashDescriptorOffsets],  # pyright: ignore [reportGeneralTypeIssues]
     ):
-        """Set focused element highlight ranges"""
-        print("Setting highlight ranges", ranges, highlightId)
+        """Flash ranges"""
+        print("flash  ranges", ranges)
         actions.skip()

cursorless-everywhere-talon/cursorless_everywhere_types.py

@@ -18,6 +18,14 @@ class LineRange(TypedDict):
     end: int
 
 
+GeneralizedRangeOffsets = CharacterRangeOffsets | LineRange
+
+
+class FlashDescriptorOffsets(TypedDict):
+    style: str
+    range: GeneralizedRangeOffsets
+
+
 class EditorState(TypedDict):
     text: str
     selections: list[SelectionOffsets]

packages/cursorless-everywhere-talon-core/src/ide/TalonJsCapabilities.ts

@@ -1,8 +1,6 @@
 import type { Capabilities, CommandCapabilityMap } from "@cursorless/common";
 
 const COMMAND_CAPABILITIES: CommandCapabilityMap = {
-  highlight: { acceptsLocation: true },
-
   clipboardCopy: undefined,
   clipboardPaste: undefined,
   toggleLineComment: undefined,
@@ -14,6 +12,7 @@ const COMMAND_CAPABILITIES: CommandCapabilityMap = {
   showDebugHover: undefined,
   extractVariable: undefined,
   fold: undefined,
+  highlight: undefined,
   unfold: undefined,
   showReferences: undefined,
   insertLineAfter: undefined,

packages/cursorless-everywhere-talon-core/src/ide/TalonJsIDE.ts

@@ -25,7 +25,7 @@ import { pull } from "lodash-es";
 import type { Talon } from "../types/talon.types";
 import type { EditorState } from "../types/types";
 import { createTextEditor } from "./createTextEditor";
-import { setHighlightRanges } from "./setHighlightRanges";
+import { flashRanges } from "./flashRanges";
 import { TalonJsCapabilities } from "./TalonJsCapabilities";
 import { TalonJsClipboard } from "./TalonJsClipboard";
 import { TalonJsConfiguration } from "./TalonJsConfiguration";
@@ -134,16 +134,16 @@ export class TalonJsIDE implements IDE {
     throw new Error("executeCommand not implemented.");
   }
 
-  flashRanges(_flashDescriptors: FlashDescriptor[]): Promise<void> {
-    return Promise.resolve();
+  flashRanges(flashDescriptors: FlashDescriptor[]): Promise<void> {
+    return flashRanges(this.talon, flashDescriptors);
   }
 
   setHighlightRanges(
-    highlightId: string | undefined,
-    editor: TextEditor,
-    ranges: GeneralizedRange[],
+    _highlightId: string | undefined,
+    _editor: TextEditor,
+    _ranges: GeneralizedRange[],
   ): Promise<void> {
-    return setHighlightRanges(this.talon, editor, ranges, highlightId);
+    throw new Error("setHighlightRanges not implemented.");
   }
 
   onDidChangeTextDocument(

packages/cursorless-everywhere-talon-core/src/ide/flashRanges.ts

@@ -0,0 +1,22 @@
+import type { FlashDescriptor } from "@cursorless/common";
+import type { Talon } from "../types/talon.types";
+import type { FlashDescriptorOffsets } from "../types/types";
+import { toGeneralizedRangeOffsets } from "./toGeneralizedRangeOffsets";
+
+export function flashRanges(
+  talon: Talon,
+  flashDescriptors: FlashDescriptor[],
+): Promise<void> {
+  const offsetDescriptors = flashDescriptors.map(
+    (descriptor): FlashDescriptorOffsets => {
+      return {
+        style: descriptor.style,
+        range: toGeneralizedRangeOffsets(descriptor.editor, descriptor.range),
+      };
+    },
+  );
+
+  talon.actions.user.cursorless_everywhere_flash_ranges(offsetDescriptors);
+
+  return Promise.resolve();
+}

packages/cursorless-everywhere-talon-core/src/ide/setHighlightRanges.ts

@@ -0,0 +1,16 @@
+import type { GeneralizedRange, TextEditor } from "@cursorless/common";
+import type { GeneralizedRangeOffsets } from "../types/types";
+
+export function toGeneralizedRangeOffsets(
+  editor: TextEditor,
+  range: GeneralizedRange,
+): GeneralizedRangeOffsets {
+  if (range.type === "line") {
+    return range;
+  }
+  return {
+    type: "character",
+    start: editor.document.offsetAt(range.start),
+    end: editor.document.offsetAt(range.end),
+  };
+}

packages/cursorless-everywhere-talon-core/src/ide/toGeneralizedRangeOffsets.ts

@@ -1,8 +1,7 @@
-import type { LineRange } from "@cursorless/common";
 import type {
-  CharacterRangeOffsets,
   EditorEdit,
   EditorState,
+  FlashDescriptorOffsets,
   SelectionOffsets,
 } from "./types";
 
@@ -23,9 +22,8 @@ export interface TalonActions {
     cursorless_everywhere_get_editor_state(): EditorState;
     cursorless_everywhere_set_selections(selections: SelectionOffsets[]): void;
     cursorless_everywhere_edit_text(edit: EditorEdit): void;
-    cursorless_everywhere_set_highlight_ranges(
-      ranges: (CharacterRangeOffsets | LineRange)[],
-      highlightId: string | undefined,
+    cursorless_everywhere_flash_ranges(
+      flashDescriptors: FlashDescriptorOffsets[],
     ): void;
   };
 }

packages/cursorless-everywhere-talon-core/src/types/talon.types.ts

@@ -1,7 +1,9 @@
 import type {
   Command,
   CommandResponse,
+  FlashStyle,
   IDE,
+  LineRange,
   NormalizedIDE,
   TestHelpers,
 } from "@cursorless/common";
@@ -20,6 +22,13 @@ export interface CharacterRangeOffsets {
   end: number;
 }
 
+export type GeneralizedRangeOffsets = CharacterRangeOffsets | LineRange;
+
+export interface FlashDescriptorOffsets {
+  style: FlashStyle;
+  range: GeneralizedRangeOffsets;
+}
+
 export interface EditorState {
   text: string;
   languageId?: string;

packages/cursorless-everywhere-talon-core/src/types/types.ts

@@ -1,6 +1,7 @@
 import type {
   EditorEdit,
   EditorState,
+  FlashDescriptorOffsets,
   SelectionOffsets,
   Talon,
   TalonActions,
@@ -53,9 +54,8 @@ const actions: TalonActions = {
       }
       _finalEditorState.text = edit.text;
     },
-    cursorless_everywhere_set_highlight_ranges(
-      _ranges: any[],
-      _highlightId: string | undefined,
+    cursorless_everywhere_flash_ranges(
+      _flashDescriptors: FlashDescriptorOffsets[],
     ): void {
       // Do nothing
     },