Fix import problems

Author: AndreasArvidsson

packages/common/src/util/serializeScopeType.ts

@@ -0,0 +1,13 @@
+import type {
+  ScopeType,
+  SimpleScopeTypeType,
+} from "../types/command/PartialTargetDescriptor.types";
+
+export function serializeScopeType(
+  scopeType: SimpleScopeTypeType | ScopeType,
+): string {
+  if (typeof scopeType === "string") {
+    return scopeType;
+  }
+  return scopeType.type;
+}

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

@@ -10,7 +10,9 @@ export function Language({ languageId }: Props) {
   return (
     <>
       <h2>Scopes</h2>
+
       <ScopeVisualizer languageId={languageId} />
+
       <ScopeSupport languageId={languageId} />
     </>
   );

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

@@ -29,7 +29,7 @@ export function ScopeSupport({ languageId }: Props): React.JSX.Element {
       <ScopeSupportForLevel
         facets={supportedFacets}
         title="Supported facets"
-        subtitle="These facets are supported"
+        subtitle="These scope facets are supported"
       />
 
       <ScopeSupportForLevel

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

@@ -4,8 +4,9 @@ import {
   type ScopeSupportFacet,
   type ScopeSupportFacetInfo,
 } from "@cursorless/common";
+import { serializeScopeType } from "@cursorless/common/src/util/serializeScopeType";
 import React, { useState, type JSX } from "react";
-import { prettifyFacet, prettifyScopeType, serializeScopeType } from "./util";
+import { prettifyFacet, prettifyScopeType } from "./util";
 
 interface Props {
   facets: ScopeSupportFacet[];

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

@@ -4,16 +4,12 @@ import {
   type ScopeSupportFacetInfo,
   type TextualScopeSupportFacet,
 } from "@cursorless/common";
+import { serializeScopeType } from "@cursorless/common/src/util/serializeScopeType";
 import React, { useState } from "react";
 import scopeTestsJson from "../../../../../static/scopeTests.json";
 import { Code, type Highlight } from "./Code";
 import type { Fixture, ScopeTestsJson } from "./types";
-import {
-  getFacetInfo,
-  prettifyFacet,
-  prettifyScopeType,
-  serializeScopeType,
-} from "./util";
+import { getFacetInfo, prettifyFacet, prettifyScopeType } from "./util";
 
 const scopeTests = scopeTestsJson as ScopeTestsJson;
 
@@ -65,6 +61,13 @@ export function ScopeVisualizer({ languageId }: Props) {
 
   return (
     <>
+      <div className="mb-4">
+        Below are visualizations of all our scope tests for this language. These
+        were designed primarily as tests rather than documentation. There are
+        quite a few of them, and they may be a bit overwhelming from a
+        documentation perspective.
+      </div>
+
       {renderOptions()}
 
       {scopes.map((scope) =>

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

@@ -5,8 +5,6 @@ import {
   textualScopeSupportFacetInfos,
   type ScopeSupportFacet,
   type ScopeSupportFacetInfo,
-  type ScopeType,
-  type SimpleScopeTypeType,
   type TextualScopeSupportFacet,
 } from "@cursorless/common";
 
@@ -36,15 +34,6 @@ export function prettifyFacet(
   return name;
 }
 
-export function serializeScopeType(
-  scopeType: SimpleScopeTypeType | ScopeType,
-): string {
-  if (typeof scopeType === "string") {
-    return scopeType;
-  }
-  return scopeType.type;
-}
-
 export function prettifyScopeType(scopeType: string): string {
   return capitalize(camelCaseToAllDown(scopeType));
 }

packages/node-common/src/getFixturePaths.ts

@@ -1,6 +1,10 @@
+import type {
+  ScopeSupportFacet,
+  TextualScopeSupportFacet,
+} from "@cursorless/common";
+import { getCursorlessRepoRoot } from "@cursorless/node-common";
 import * as path from "path";
 import { walkFilesSync } from "./walkSync";
-import { getCursorlessRepoRoot } from "@cursorless/node-common";
 
 export function getFixturesPath() {
   return path.join(getCursorlessRepoRoot(), "data", "fixtures");
@@ -38,7 +42,7 @@ export interface ScopeTestPath {
   path: string;
   name: string;
   languageId: string;
-  facet: string;
+  facet: ScopeSupportFacet | TextualScopeSupportFacet;
 }
 
 export function getScopeTestPaths(): ScopeTestPath[] {
@@ -51,7 +55,9 @@ export function getScopeTestPaths(): ScopeTestPath[] {
       path: p,
       name: pathToName(relativeDir, p),
       languageId: path.dirname(path.relative(directory, p)).split(path.sep)[0],
-      facet: path.basename(p).match(/([a-zA-Z.]+)\d*\.scope/)![1],
+      facet: path.basename(p).match(/([a-zA-Z.]+)\d*\.scope/)![1] as
+        | ScopeSupportFacet
+        | TextualScopeSupportFacet,
     }));
 }