Use scope tests plugin

Author: AndreasArvidsson

packages/cursorless-org-docs/docusaurus.config.mts

@@ -146,7 +146,10 @@ const config: Config = {
       },
     ],
   ],
-  plugins: ["./src/plugins/tailwind-plugin.js"],
+  plugins: [
+    "./src/plugins/tailwind-plugin.ts",
+    "./src/plugins/scope-tests-plugin.ts",
+  ],
 
   themeConfig: {
     navbar: {

packages/cursorless-org-docs/package.json

@@ -42,7 +42,6 @@
     "write-heading-ids": "docusaurus write-heading-ids",
     "compile": "tsc --build",
     "watch": "tsc --build --watch",
-    "prepare-assets": "my-ts-node src/scripts/prepare-assets.ts",
     "clean": "pnpm clear && rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
   },
   "dependencies": {

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

@@ -6,13 +6,11 @@ import {
   type ScopeSupportFacetInfo,
 } from "@cursorless/common";
 import React, { useState } from "react";
-import scopeTestsJson from "../../../../../static/scopeTests.json";
 import { Code, type Highlight } from "./Code";
 import "./ScopeVisualizer.css";
-import type { Fixture, ScopeTestsJson } from "./types";
+import type { Fixture, ScopeTests } from "./types";
 import { getFacetInfo, prettifyFacet, prettifyScopeType } from "./util";
-
-const scopeTests = scopeTestsJson as ScopeTestsJson;
+import { usePluginData } from "@docusaurus/useGlobalData";
 
 type RangeType = "content" | "removal";
 
@@ -33,7 +31,8 @@ interface Props {
 }
 
 export function ScopeVisualizer({ languageId }: Props) {
-  const [scopes] = useState(getScopeFixtures(languageId));
+  const scopeTests = usePluginData("scope-tests-plugin") as ScopeTests;
+  const [scopes] = useState(getScopeFixtures(scopeTests, languageId));
   const [rangeType, setRangeType] = useState<RangeType>("content");
   const [renderWhitespace, setRenderWhitespace] = useState(false);
 
@@ -198,7 +197,7 @@ function getOverlap(a: Range, b: Range): Range | null {
     : null;
 }
 
-function getScopeFixtures(languageId: string): Scope[] {
+function getScopeFixtures(scopeTests: ScopeTests, languageId: string): Scope[] {
   const languageIds = new Set<string>(
     scopeTests.imports[languageId] ?? [languageId],
   );

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

@@ -3,7 +3,7 @@ import type {
   PlaintextScopeSupportFacet,
 } from "@cursorless/common";
 
-export interface ScopeTestsJson {
+export interface ScopeTests {
   imports: Record<string, string[]>;
   fixtures: Fixture[];
 }

packages/cursorless-org-docs/src/scripts/prepare-assets.ts renamed to packages/cursorless-org-docs/src/plugins/scope-tests-plugin.ts

@@ -4,32 +4,54 @@ import {
   getScopeTestPaths,
   type ScopeTestPath,
 } from "@cursorless/node-common";
+import { LoadContext, Plugin } from "@docusaurus/types";
 import * as fs from "node:fs";
 import * as path from "node:path";
 import type {
   Fixture,
   Scope,
-  ScopeTestsJson,
+  ScopeTests,
   Target,
 } from "../docs/user/languages/components/types";
 
-const fixtures: Fixture[] = [];
+export default function prepareAssetsPlugin(
+  context: LoadContext,
+  options: {},
+): Plugin<ScopeTests> {
+  let data: ScopeTests;
 
-const importedLanguages = getScopeTestLanguagesRecursively();
+  return {
+    name: "scope-tests-plugin",
 
-for (const test of getScopeTestPaths()) {
-  const fixture = parseTest(test);
-  if (fixture != null) {
-    fixtures.push(fixture);
-  }
+    loadContent(): ScopeTests {
+      const repoRoot = path.join(__dirname, "../../../..");
+      process.env.CURSORLESS_REPO_ROOT = repoRoot;
+      return prepareAssets();
+    },
+
+    async contentLoaded({ content, actions }) {
+      actions.setGlobalData(content);
+    },
+  };
 }
 
-const result: ScopeTestsJson = {
-  imports: importedLanguages,
-  fixtures,
-};
+function prepareAssets(): ScopeTests {
+  const fixtures: Fixture[] = [];
 
-saveJson(result);
+  const importedLanguages = getScopeTestLanguagesRecursively();
+
+  for (const test of getScopeTestPaths()) {
+    const fixture = parseTest(test);
+    if (fixture != null) {
+      fixtures.push(fixture);
+    }
+  }
+
+  return {
+    imports: importedLanguages,
+    fixtures,
+  };
+}
 
 function parseTest(test: ScopeTestPath) {
   const fixture = fs
@@ -171,13 +193,3 @@ function parseLine(line: string) {
 
   return { scopeIndex, targetIndex, type, value };
 }
-
-function saveJson(result: ScopeTestsJson) {
-  const assetPath = path.join(
-    getPackagePath("cursorless-org-docs"),
-    "static",
-    "scopeTests.json",
-  );
-  const content = JSON.stringify(result, null, 2) + "\n";
-  fs.writeFileSync(assetPath, content, "utf8");
-}