Fixes; support custom regex spoken forms

Author: pokey

.vscode/launch.json

@@ -156,6 +156,23 @@
         "!**/node_modules/**"
       ]
     },
+    {
+      "name": "Update fixtures, unit tests only",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceFolder}/packages/test-harness/out/scripts/runUnitTestsOnly",
+      "env": {
+        "CURSORLESS_TEST": "true",
+        "CURSORLESS_TEST_UPDATE_FIXTURES": "true",
+        "CURSORLESS_REPO_ROOT": "${workspaceFolder}"
+      },
+      "outFiles": ["${workspaceFolder}/**/out/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}",
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ]
+    },
     {
       "name": "Docusaurus start",
       "type": "node",

packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.test.ts

@@ -16,6 +16,21 @@ suite("Generate spoken forms", () => {
   getRecordedTestPaths().forEach(({ name, path }) =>
     test(name, () => runTest(path)),
   );
+
+  test("generate spoken form for custom regex", () => {
+    const generator = new SpokenFormGenerator({
+      ...defaultSpokenFormMap,
+      customRegex: { foo: ["bar"] },
+    });
+
+    const spokenForm = generator.scopeType({
+      type: "customRegex",
+      regex: "foo",
+    });
+
+    assert(spokenForm.type === "success");
+    assert.equal(spokenForm.preferred, "bar");
+  });
 });
 
 async function runTest(file: string) {

packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts

@@ -250,8 +250,12 @@ function constructSpokenForms(component: SpokenFormComponent): string[] {
   }
 
   if (Array.isArray(component)) {
+    if (component.length === 0) {
+      return [""];
+    }
+
     return cartesianProduct(component.map(constructSpokenForms)).map((words) =>
-      words.join(" "),
+      words.filter((word) => word.length !== 0).join(" "),
     );
   }
 

packages/cursorless-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts

@@ -209,7 +209,6 @@ export class PrimitiveTargetSpokenFormGenerator {
   handleScopeType(scopeType: ScopeType): SpokenFormComponent {
     switch (scopeType.type) {
       case "oneOf":
-      case "customRegex":
       case "switchStatementSubject":
       case "string":
         throw new NoSpokenFormError(`Scope type '${scopeType.type}'`);
@@ -221,15 +220,26 @@ export class PrimitiveTargetSpokenFormGenerator {
         }
         const pair = this.spokenFormMap.pairedDelimiter[scopeType.delimiter];
         if (scopeType.forceDirection != null) {
-          const direction =
-            scopeType.forceDirection === "left"
-              ? this.spokenFormMap.surroundingPairForceDirection.left
-              : this.spokenFormMap.surroundingPairForceDirection.right;
-          return `${direction} ${pair}`;
+          return [
+            this.spokenFormMap.surroundingPairForceDirection[
+              scopeType.forceDirection
+            ],
+            pair,
+          ];
         }
         return pair;
       }
 
+      case "customRegex":
+        return (
+          this.spokenFormMap.customRegex[scopeType.regex] ?? {
+            type: "singleTerm",
+            spokenForms: [],
+            spokenFormType: "customRegex",
+            id: scopeType.regex,
+          }
+        );
+
       default:
         return this.spokenFormMap.simpleScopeTypeType[scopeType.type];
     }

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/customRegex/clearWhite.yml

@@ -9,7 +9,9 @@ command:
           scopeType: {type: customRegex, regex: '\p{Zs}+'}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id \p{Zs}+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: "\"  \""
   selections:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/ordinalScopes/clearFirstPaint.yml

@@ -11,7 +11,9 @@ command:
           length: 1
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id [^\s"'`]+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: aaa-bbb ccc-ddd eee-fff ggg-hhh
   selections:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/ordinalScopes/clearFirstPaint2.yml

@@ -11,7 +11,9 @@ command:
           length: 1
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id [^\s"'`]+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: aaa-bbb ccc-ddd eee-fff ggg-hhh
   selections:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/ordinalScopes/clearLastPaint.yml

@@ -11,7 +11,9 @@ command:
           length: 1
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id [^\s"'`]+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: aaa-bbb ccc-ddd eee-fff ggg-hhh
   selections:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/ordinalScopes/clearLastPaint2.yml

@@ -11,7 +11,9 @@ command:
           length: 1
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id [^\s"'`]+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: aaa-bbb ccc-ddd eee-fff ggg-hhh
   selections:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/selectionTypes/clearCustomRegex.yml

@@ -9,7 +9,9 @@ command:
           scopeType: {type: customRegex, regex: '[\w/_.]+'}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
-spokenFormError: Scope type 'customRegex'
+spokenFormError: >-
+  custom regex with id [\w/_.]+; please see
+  https://www.cursorless.org/docs/user/customization/ for more information
 initialState:
   documentContents: aa.bb/cc_dd123(  )
   selections: