Merge branch 'main' into noFloatingPromises

Author: pokey

packages/cursorless-tutorial/src/stepComponentParsers/CursorlessCommandComponentParser.ts

@@ -1,20 +1,24 @@
 import {
   CommandComplete,
+  CommandLatest,
   getKey,
   Hats,
+  HatStyleMap,
   splitKey,
+  TestCaseSnapshot,
   TutorialContentProvider,
   TutorialId,
 } from "@cursorless/common";
 import {
-  CustomSpokenFormGenerator,
   canonicalizeAndValidateCommand,
+  CustomSpokenFormGenerator,
   getPartialTargetDescriptors,
   transformPartialPrimitiveTargets,
 } from "@cursorless/cursorless-engine";
 import { TutorialError } from "../TutorialError";
 import { StepComponent, StepComponentParser } from "../types/StepComponent";
 import { cloneDeep, mapKeys } from "lodash-es";
+import { produce } from "immer";
 
 /**
  * Parses components of the form `{command:takeNear.yml}`. The argument
@@ -33,43 +37,15 @@ export class CursorlessCommandComponentParser implements StepComponentParser {
       this.tutorialId,
       arg,
     );
-    const command = cloneDeep(canonicalizeAndValidateCommand(fixture.command));
-
-    transformPartialPrimitiveTargets(
-      getPartialTargetDescriptors(command.action),
-      (target) => {
-        if (target.mark?.type !== "decoratedSymbol") {
-          return target;
-        }
-
-        const color = target.mark.symbolColor;
-
-        if (this.hats.enabledHatStyles[color] === undefined) {
-          target.mark.symbolColor = Object.keys(this.hats.enabledHatStyles)[0];
-        }
 
-        return target;
-      },
+    const { command, initialState } = substituteMissingHats(
+      this.hats.enabledHatStyles,
+      canonicalizeAndValidateCommand(fixture.command),
+      fixture.initialState,
     );
 
-    if (fixture.initialState.marks != null) {
-      fixture.initialState.marks = mapKeys(
-        fixture.initialState.marks,
-        (_value, key) => {
-          const { hatStyle, character } = splitKey(key);
-          if (this.hats.enabledHatStyles[hatStyle] === undefined) {
-            return getKey(
-              Object.keys(this.hats.enabledHatStyles)[0],
-              character,
-            );
-          }
-          return key;
-        },
-      );
-    }
-
     return {
-      initialState: fixture.initialState,
+      initialState,
       languageId: fixture.languageId,
       trigger: {
         type: "command",
@@ -96,3 +72,60 @@ export class CursorlessCommandComponentParser implements StepComponentParser {
     return spokenForm.spokenForms[0];
   }
 }
+
+/**
+ * If the user has particular hats disabled, substitute them with hats that the
+ * user actually has enabled.
+ *
+ * We just pick the first hat in the list of available hats, but it would
+ * probably be better to pick a similar hat, eg if the hat is a colored hat,
+ * pick a different color.
+ *
+ * @param hats The IDE hats
+ * @param command The command to substitute hats in
+ * @param initialState The initial state snapshot to substitute hats in
+ * @returns A new command and initial state snapshot with hats substituted
+ */
+function substituteMissingHats(
+  enabledHatStyles: HatStyleMap,
+  command: CommandLatest,
+  initialState: TestCaseSnapshot,
+) {
+  command = cloneDeep(command);
+
+  // Update the hats in the command
+  transformPartialPrimitiveTargets(
+    getPartialTargetDescriptors(command.action),
+    (target) => {
+      if (target.mark?.type !== "decoratedSymbol") {
+        return target;
+      }
+
+      const color = target.mark.symbolColor;
+
+      if (enabledHatStyles[color] === undefined) {
+        target.mark.symbolColor = Object.keys(enabledHatStyles)[0];
+      }
+
+      return target;
+    },
+  );
+
+  // Update the hats in the initial state snapshot
+  if (initialState.marks != null) {
+    initialState = produce(initialState, (draft) => {
+      draft.marks = mapKeys(draft.marks, (_value, key) => {
+        const { hatStyle, character } = splitKey(key);
+        if (enabledHatStyles[hatStyle] === undefined) {
+          return getKey(Object.keys(enabledHatStyles)[0], character);
+        }
+        return key;
+      });
+    });
+  }
+
+  return {
+    command,
+    initialState,
+  };
+}