Sort ranges before calculating highlights

Author: AndreasArvidsson

packages/common/src/index.ts

@@ -110,6 +110,7 @@ export * from "./util/regex";
 export * from "./util/selectionsEqual";
 export * from "./util/serializedMarksToTokenHats";
 export * from "./util/serializeScopeType";
+export * from "./util/sortRanges";
 export * from "./util/splitKey";
 export * from "./util/toPlainObject";
 export * from "./util/type";

packages/common/src/util/sortRanges.ts

@@ -0,0 +1,26 @@
+import type { Range } from "../types/Range";
+
+/**
+ * Sorts an array of ranges in ascending order based on their start and end
+ * positions.
+ *
+ * @param ranges The array of ranges to sort
+ * @returns The sorted array of ranges
+ */
+export function sortRanges(ranges: Range[]) {
+  return ranges.sort((a, b) => {
+    if (a.start.isBefore(b.start)) {
+      return -1;
+    }
+    if (a.start.isAfter(b.start)) {
+      return 1;
+    }
+    if (a.end.isBefore(b.end)) {
+      return -1;
+    }
+    if (a.end.isAfter(b.end)) {
+      return 1;
+    }
+    return 0;
+  });
+}

packages/cursorless-org-docs/src/docs/user/languages/components/ScopeSupport.tsx

@@ -1,6 +1,7 @@
 import {
   Range,
   serializeScopeType,
+  sortRanges,
   type ScopeSupportFacetInfo,
   type ScopeTypeType,
 } from "@cursorless/common";
@@ -155,7 +156,7 @@ function getHighlights(fixture: Fixture, rangeType: RangeType): Highlight[] {
       rangeType === "content"
         ? scope.targets.map((t) => t.content)
         : scope.targets.map((t) => t.removal ?? t.content);
-    const ranges = conciseRanges.map((r) => Range.fromConcise(r));
+    const ranges = sortRanges(conciseRanges.map((r) => Range.fromConcise(r)));
 
     if (scope.domain != null && !conciseRanges.includes(scope.domain)) {
       domainRanges.push(Range.fromConcise(scope.domain));
@@ -196,7 +197,7 @@ function getHighlights(fixture: Fixture, rangeType: RangeType): Highlight[] {
     highlights.some((h) => highlights.some((o) => hasOverlap(h.range, o.range)))
   ) {
     console.error("Overlapping highlights detected:");
-    console.error(fixture.name);
+    console.error(fixture);
     console.error(highlights);
   }