Refactor utilities

Author: AndreasArvidsson

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

@@ -1,8 +1,6 @@
 import {
   Range,
   serializeScopeType,
-  type PlaintextScopeSupportFacet,
-  type ScopeSupportFacet,
   type ScopeSupportFacetInfo,
   type ScopeTypeType,
 } from "@cursorless/common";
@@ -11,11 +9,16 @@ import React, { useState } from "react";
 import { Code, type Highlight } from "./Code";
 import { H2, H3, H4 } from "./Header";
 import "./ScopeSupport.css";
-import type { Fixture, ScopeTests } from "./types";
-import { getFacetInfo, prettifyFacet, prettifyScopeType } from "./util";
+import type { FacetValue, Fixture, ScopeTests } from "./types";
+import {
+  getFacetInfo,
+  isScopeInternal,
+  nameComparator,
+  prettifyFacet,
+  prettifyScopeType,
+} from "./util";
 
 type RangeType = "content" | "removal";
-type FacetValue = ScopeSupportFacet | PlaintextScopeSupportFacet;
 
 interface Scopes {
   public: Scope[];
@@ -222,7 +225,7 @@ function getScopeFixtures(scopeTests: ScopeTests, languageId: string): Scopes {
     languageIds.has(f.languageId),
   );
   const scopeMap: Partial<Record<ScopeTypeType, Scope>> = {};
-  const facetMap: Partial<Record<string, Facet>> = {};
+  const facetMap: Partial<Record<FacetValue, Facet>> = {};
 
   for (const fixture of fixtures) {
     const info = getFacetInfo(fixture.languageId, fixture.facet);
@@ -240,8 +243,6 @@ function getScopeFixtures(scopeTests: ScopeTests, languageId: string): Scopes {
       };
     }
 
-    const facetKey = `${scopeTypeType}.${fixture.facet}`;
-
     if (facetMap[fixture.facet] == null) {
       const facet = {
         facet: fixture.facet,
@@ -259,10 +260,10 @@ function getScopeFixtures(scopeTests: ScopeTests, languageId: string): Scopes {
   const result: Scopes = { public: [], internal: [] };
 
   Object.values(scopeMap)
-    .sort(comparator)
+    .sort(nameComparator)
     .forEach((scope) => {
-      scope.facets.sort(comparator);
-      scope.facets.forEach((f) => f.fixtures.sort(comparator));
+      scope.facets.sort(nameComparator);
+      scope.facets.forEach((f) => f.fixtures.sort(nameComparator));
       if (isScopeInternal(scope.scopeTypeType)) {
         result.internal.push(scope);
       } else {
@@ -272,18 +273,3 @@ function getScopeFixtures(scopeTests: ScopeTests, languageId: string): Scopes {
 
   return result;
 }
-
-function comparator(a: { name: string }, b: { name: string }): number {
-  return a.name.localeCompare(b.name);
-}
-
-function isScopeInternal(scope: ScopeTypeType): boolean {
-  switch (scope) {
-    case "disqualifyDelimiter":
-    case "pairDelimiter":
-    case "textFragment":
-      return true;
-    default:
-      return false;
-  }
-}

packages/cursorless-org-docs/src/docs/user/languages/components/types.ts

@@ -3,14 +3,16 @@ import type {
   PlaintextScopeSupportFacet,
 } from "@cursorless/common";
 
+export type FacetValue = ScopeSupportFacet | PlaintextScopeSupportFacet;
+
 export interface ScopeTests {
   imports: Record<string, string[]>;
   fixtures: Fixture[];
 }
 
 export interface Fixture {
   name: string;
-  facet: ScopeSupportFacet | PlaintextScopeSupportFacet;
+  facet: FacetValue;
   languageId: string;
   code: string;
   scopes: Scope[];

packages/cursorless-org-docs/src/docs/user/languages/components/util.ts

@@ -8,6 +8,7 @@ import {
   type ScopeSupportFacet,
   type ScopeSupportFacetInfo,
   type ScopeType,
+  type ScopeTypeType,
   type SimpleScopeTypeType,
 } from "@cursorless/common";
 
@@ -56,3 +57,21 @@ export function getFacetInfo(
 
   return facetInfo;
 }
+
+export function nameComparator(
+  a: { name: string },
+  b: { name: string },
+): number {
+  return a.name.localeCompare(b.name);
+}
+
+export function isScopeInternal(scope: ScopeTypeType): boolean {
+  switch (scope) {
+    case "disqualifyDelimiter":
+    case "pairDelimiter":
+    case "textFragment":
+      return true;
+    default:
+      return false;
+  }
+}