Switch statement subject (#2046)

AndreasArvidsson · web-flow · commit df8a74dd3bd0 · 2023-11-23T11:29:04.000Z
`subject, switchStatementSubject` ## Checklist - [-] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [-] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [-] I have not broken the cheatsheet
diff --git a/cursorless-talon/src/spoken_forms.py b/cursorless-talon/src/spoken_forms.py
@@ -126,7 +126,10 @@ def handle_new_values(csv_name: str, values: list[SpokenFormEntry]):
         handle_csv(
             "modifier_scope_types.csv",
             pluralize_lists=["scope_type"],
-            extra_allowed_values=["private.fieldAccess"],
+            extra_allowed_values=[
+                "private.fieldAccess",
+                "private.switchStatementSubject",
+            ],
             default_list_name="scope_type",
         ),
         handle_csv(
diff --git a/packages/common/src/types/command/PartialTargetDescriptor.types.ts b/packages/common/src/types/command/PartialTargetDescriptor.types.ts
@@ -139,7 +139,7 @@ export const simpleScopeTypeTypes = [
   "sectionLevelFive",
   "sectionLevelSix",
   "selector",
-  "switchStatementSubject",
+  "private.switchStatementSubject",
   "unit",
   "xmlBothTags",
   "xmlElement",
diff --git a/packages/cursorless-engine/src/languages/cpp.ts b/packages/cursorless-engine/src/languages/cpp.ts
@@ -80,7 +80,7 @@ const nodeMatchers: Partial<
     "function_definition[declarator][declarator][namespace]", // void ClassName::method() {}
   ],
   ifStatement: "if_statement",
-  switchStatementSubject: "switch_statement[condition][value]",
+  ["private.switchStatementSubject"]: "switch_statement[condition][value]",
   string: "string_literal",
   comment: "comment",
   anonymousFunction: "lambda_expression",
diff --git a/packages/cursorless-engine/src/languages/csharp.ts b/packages/cursorless-engine/src/languages/csharp.ts
@@ -148,7 +148,7 @@ const nodeMatchers: Partial<
     conditionMatcher("*[condition]"),
     patternMatcher("while_statement[0]"),
   ),
-  switchStatementSubject: [
+  ["private.switchStatementSubject"]: [
     "switch_statement.tuple_expression!",
     "switch_statement[value]",
   ],
diff --git a/packages/cursorless-engine/src/languages/java.ts b/packages/cursorless-engine/src/languages/java.ts
@@ -116,7 +116,7 @@ const nodeMatchers: Partial<
   condition: conditionMatcher("*[condition]"),
   argumentOrParameter: argumentMatcher("formal_parameters", "argument_list"),
   branch: ["switch_block_statement_group", "switch_rule"],
-  switchStatementSubject: "switch_expression[condition][0]",
+  ["private.switchStatementSubject"]: "switch_expression[condition][0]",
 };
 
 export default createPatternMatchers(nodeMatchers);
diff --git a/packages/cursorless-engine/src/languages/python.ts b/packages/cursorless-engine/src/languages/python.ts
@@ -86,7 +86,7 @@ const nodeMatchers: Partial<
     ]),
     ternaryBranchMatcher("conditional_expression", [0, 2]),
   ),
-  switchStatementSubject: "match_statement[subject]",
+  ["private.switchStatementSubject"]: "match_statement[subject]",
 };
 
 export default createPatternMatchers(nodeMatchers);
diff --git a/packages/cursorless-engine/src/languages/rust.ts b/packages/cursorless-engine/src/languages/rust.ts
@@ -241,7 +241,7 @@ const nodeMatchers: Partial<
     matcher(patternFinder("else_clause"), elseExtractor("if_expression")),
     matcher(patternFinder("if_expression"), elseIfExtractor()),
   ),
-  switchStatementSubject: "match_expression[value]",
+  ["private.switchStatementSubject"]: "match_expression[value]",
 };
 
 export default createPatternMatchers(nodeMatchers);
diff --git a/packages/cursorless-engine/src/languages/scala.ts b/packages/cursorless-engine/src/languages/scala.ts
@@ -44,7 +44,7 @@ const nodeMatchers: Partial<
     }),
   ),
 
-  switchStatementSubject: "match_expression[value]",
+  ["private.switchStatementSubject"]: "match_expression[value]",
   name: ["*[name]", "*[pattern]"],
   functionName: "function_definition[name]",
 
diff --git a/packages/cursorless-engine/src/languages/typescript.ts b/packages/cursorless-engine/src/languages/typescript.ts
@@ -116,7 +116,7 @@ const nodeMatchers: Partial<
       "do_statement[condition]",
     ),
   ),
-  switchStatementSubject: matcher(
+  ["private.switchStatementSubject"]: matcher(
     patternFinder("switch_statement[value]"),
     unwrapSelectionExtractor,
   ),
diff --git a/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts b/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts
@@ -144,7 +144,7 @@ function isLanguageSpecific(scopeType: ScopeType): boolean {
     case "sectionLevelFive":
     case "sectionLevelSix":
     case "selector":
-    case "switchStatementSubject":
+    case "private.switchStatementSubject":
     case "unit":
     case "xmlBothTags":
     case "xmlElement":
diff --git a/packages/cursorless-engine/src/scopeProviders/scopeTypeToString.ts b/packages/cursorless-engine/src/scopeProviders/scopeTypeToString.ts
@@ -6,7 +6,7 @@ import {
 
 export function scopeTypeToString(scopeType: ScopeType): string {
   if (isSimpleScopeType(scopeType)) {
-    return camelCaseToAllDown(scopeType.type);
+    return camelCaseToAllDown(scopeType.type).replace(".", " ");
   }
 
   if (scopeType.type === "surroundingPair") {
diff --git a/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts b/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts
@@ -98,7 +98,7 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = {
 
     ["private.fieldAccess"]: isPrivate("access"),
     string: isPrivate("parse tree string"),
-    switchStatementSubject: isPrivate("subject"),
+    ["private.switchStatementSubject"]: isPrivate("subject"),
   },
 
   surroundingPairForceDirection: {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/cpp/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/cpp/clearSubject.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     int main() {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/cpp/clearSubject2.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/cpp/clearSubject2.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: false
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     int main() {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/csharp/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/csharp/clearSubject.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |-
     switch (aaa) {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/csharp/clearSubject2.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/csharp/clearSubject2.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: false
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |-
     switch (aaa + 1) {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/java/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/java/clearSubject.yml
@@ -6,12 +6,12 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     class Aaa {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/java/clearSubject2.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/java/clearSubject2.yml
@@ -6,12 +6,12 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     class Aaa {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/python/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/python/clearSubject.yml
@@ -6,12 +6,12 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     match 0:
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/rust/changeSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/rust/changeSubject.yml
@@ -6,12 +6,12 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     match user {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/scala/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/scala/clearSubject.yml
@@ -6,12 +6,12 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
   action: {name: clearAndSetSelection}
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |
     def matchTest(x: Int): String = x match {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/typescript/clearSubject.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/typescript/clearSubject.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |-
     switch(aaa) {
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/typescript/clearSubject2.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/typescript/clearSubject2.yml
@@ -7,11 +7,11 @@ command:
     - type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: switchStatementSubject}
+          scopeType: {type: private.switchStatementSubject}
   usePrePhraseSnapshot: true
 spokenFormError: >-
-  simple scope type type with id switchStatementSubject; this is a private
-  spoken form currently only for internal experimentation
+  simple scope type type with id private.switchStatementSubject; this is a
+  private spoken form currently only for internal experimentation
 initialState:
   documentContents: |-
     switch(aaa + 1) {
diff --git a/packages/cursorless-vscode-e2e/src/suite/scopeProvider/runCustomSpokenFormScopeInfoTest.ts b/packages/cursorless-vscode-e2e/src/suite/scopeProvider/runCustomSpokenFormScopeInfoTest.ts
@@ -79,7 +79,7 @@ const spokenFormJsonContents = {
     },
     {
       type: "simpleScopeTypeType",
-      id: "switchStatementSubject",
+      id: "private.switchStatementSubject",
       spokenForms: ["custom subject"],
     },
     {
@@ -96,22 +96,22 @@ const spokenFormJsonContents = {
 };
 
 const subjectStandard: ScopeTypeInfo = {
-  humanReadableName: "switch statement subject",
+  humanReadableName: "private switch statement subject",
   isLanguageSpecific: true,
-  scopeType: { type: "switchStatementSubject" },
+  scopeType: { type: "private.switchStatementSubject" },
   spokenForm: {
     isPrivate: true,
     reason:
-      "simple scope type type with id switchStatementSubject; this is a private spoken form currently only for internal experimentation",
+      "simple scope type type with id private.switchStatementSubject; this is a private spoken form currently only for internal experimentation",
     requiresTalonUpdate: false,
     type: "error",
   },
 };
 
 const subjectCustom: ScopeTypeInfo = {
-  humanReadableName: "switch statement subject",
+  humanReadableName: "private switch statement subject",
   isLanguageSpecific: true,
-  scopeType: { type: "switchStatementSubject" },
+  scopeType: { type: "private.switchStatementSubject" },
   spokenForm: {
     spokenForms: ["custom subject"],
     type: "success",
diff --git a/schemas/cursorless-snippets.json b/schemas/cursorless-snippets.json
@@ -96,7 +96,6 @@
         "regularExpression",
         "statement",
         "string",
-        "switchStatementSubject",
         "type",
         "value",
         "condition",
