refactor: Move decorations related helpers to /decorations

Author: trillium

packages/test-case-component/src/helpers/addContentRangeDecorations.ts renamed to packages/test-case-component/src/helpers/decorations/addContentRangeDecorations.ts

@@ -1,6 +1,6 @@
 import type { TargetPlainObject } from "@cursorless/common";
 import type { DecorationItem } from "shiki";
-import { getDecorationClass, type classesMap } from "./classesMap";
+import { getDecorationClass, type classesMap } from "../classesMap";
 
 function addContentRangeDecorations({
     marks,

packages/test-case-component/src/helpers/createDecorations.ts renamed to packages/test-case-component/src/helpers/decorations/createDecorations.ts

@@ -0,0 +1,68 @@
+import type { PlainSpyIDERecordedValues } from "@cursorless/common";
+import type { DecorationItem } from "shiki";
+import { isLineRange, isPositionRange } from "../typeGuards";
+import { getDecorationClass } from "../classesMap";
+
+function getIdeFlashDecorations({
+    ide,
+    lines,
+}: {
+    ide?: PlainSpyIDERecordedValues;
+    lines?: string[];
+} = {}): DecorationItem[] {
+    if (!lines) {
+        console.warn("Lines are undefined. Skipping line decorations.");
+        return [];
+    }
+
+    if (!ide?.flashes || !Array.isArray(ide.flashes)) {
+        console.warn("No flashes found in IDE. Skipping line decorations.");
+        return [];
+    }
+
+    const decorations: DecorationItem[] = [];
+
+    const { flashes } = ide
+
+    flashes.forEach(({ style, range }) => {
+        const { type } = range;
+
+        if (isLineRange(range)) {
+            const { start: lineStart, end: lineEnd } = range
+            for (let line = lineStart; line <= lineEnd; line++) {
+                if (line >= lines.length) {
+                    continue
+                }
+                const contentLine = lines[line];
+                const startPosition = { line, character: 0 };
+                const endPosition = { line, character: contentLine.length };
+                const decorationItem = {
+                    start: startPosition,
+                    end: endPosition,
+                    properties: {
+                        class: `${getDecorationClass(style)} full`,
+                    },
+                    alwaysWrap: true,
+                };
+                decorations.push(decorationItem);
+            }
+        } else if (isPositionRange(range)) {
+            const { start: rangeStart, end: rangeEnd } = range;
+            const decorationItem = {
+                start: rangeStart,
+                end: rangeEnd,
+                properties: {
+                    class: getDecorationClass(style),
+                },
+                alwaysWrap: true,
+            }
+            decorations.push(decorationItem);
+        } else {
+            console.warn(`Unknown range type "${type}". Skipping this flash.`);
+        }
+    });
+
+    return decorations;
+}
+
+export { getIdeFlashDecorations }

packages/test-case-component/src/helpers/decorations/getIdeFlashDecorations.ts

@@ -1,7 +1,7 @@
 import type { SerializedMarks } from "@cursorless/common";
 import type { DecorationItem } from "shiki";
-import type { classesMap } from "./classesMap";
-import { getDecorationClass } from "./classesMap";
+import type { classesMap } from "../classesMap";
+import { getDecorationClass } from "../classesMap";
 
 function getMarkDecorations({
     marks,

packages/test-case-component/src/helpers/getMarkDecorations.ts renamed to packages/test-case-component/src/helpers/decorations/getMarkDecorations.ts

@@ -1,6 +1,6 @@
 import type { SelectionPlainObject } from "@cursorless/common";
 import type { DecorationItem } from "shiki";
-import { getDecorationClass } from "./classesMap";
+import { getDecorationClass } from "../classesMap";
 
 function getSelections(
     {

packages/test-case-component/src/helpers/getSelections.ts renamed to packages/test-case-component/src/helpers/decorations/getSelections.ts

@@ -13,7 +13,6 @@ function getSourceMarks({ sourceMark }: { sourceMark?: TargetPlainObject[] }): D
             highlightClass: "sourceMark", decorations
         });
     }
-
     return decorations
 }
 

packages/test-case-component/src/helpers/getSourceMarks.ts renamed to packages/test-case-component/src/helpers/decorations/getSourceMarks.ts

@@ -1,4 +1,4 @@
-import { mergeOverlappingDecorations } from "./mergeOverlappingDecorations.ts";
+import { mergeOverlappingDecorations } from "./mergeOverlappingDecorations";
 
 describe("mergeOverlappingDecorations", () => {
     it("merges overlapping decorations and adds 'overlap' to class", () => {

packages/test-case-component/src/helpers/getThatMarks.ts renamed to packages/test-case-component/src/helpers/decorations/getThatMarks.ts

@@ -1,10 +1,5 @@
 export * from "./splitDocumentWithOffsets";
-export * from "./createDecorations";
-export * from "./getMarkDecorations";
-export * from "./getIdeFlashDecorations";
-export * from "./getSelections";
-export * from "./getThatMarks";
-export * from "./getSourceMarks";
-export * from "./addContentRangeDecorations";
+export * from "./decorations/createDecorations";
+export * from "./decorations/mergeOverlappingDecorations";
 export * from "./typeGuards";
 export * from "./classesMap";