Cursorless scope side bar (#1942)

- Depends on #1941
- Depends on #1946

## Checklist

- [-] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
(see comment below)
- [x] Add descriptions to section headings (eg present, not present,
etc)
- [x] File issue about using lang icons for lang-specific scopes
- [x] 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)
- [x] I have not broken the cheatsheet
- [x] File issue for showing scopes touching, as well as equal to,
selection
- [x] Checkboxes from original #1663

cursorless-talon/src/apps/cursorless_vscode.py

@@ -32,3 +32,9 @@ def private_cursorless_show_settings_in_ide():
         )
         actions.sleep("250ms")
         actions.key("right")
+
+    def private_cursorless_show_sidebar():
+        """Show Cursorless sidebar"""
+        actions.user.private_cursorless_run_rpc_command_and_wait(
+            "workbench.view.extension.cursorless"
+        )

cursorless-talon/src/cheatsheet/sections/get_scope_visualizer.py

@@ -24,4 +24,14 @@ def get_scope_visualizer():
                 ],
             ],
         },
+        {
+            "id": "show_scope_sidebar",
+            "type": "command",
+            "variations": [
+                {
+                    "spokenForm": "bar cursorless",
+                    "description": "Show cursorless sidebar",
+                },
+            ],
+        },
     ]

cursorless-talon/src/cursorless.py

@@ -12,3 +12,6 @@
 class Actions:
     def private_cursorless_show_settings_in_ide():
         """Show Cursorless-specific settings in ide"""
+
+    def private_cursorless_show_sidebar():
+        """Show Cursorless-specific settings in ide"""

cursorless-talon/src/cursorless.talon

@@ -40,3 +40,6 @@ tag: user.cursorless
 
 {user.cursorless_homophone} settings:
     user.private_cursorless_show_settings_in_ide()
+
+bar {user.cursorless_homophone}:
+    user.private_cursorless_show_sidebar()

docs/user/scope-sidebar.md

@@ -0,0 +1,3 @@
+# The Cursorless sidebar
+
+You can say `"bar cursorless"` to show the Cursorless sidebar. Currently, the sidebar just contains a section showing a list of all scopes, organized by whether they are present and supported in the active text editor. As you type, the list of present scopes will update in real time. Clicking on a scope will visualize it using the [scope visualizer](scope-visualizer.md). Note that for legacy scopes, we can't tell whether they are present in the active text editor, so we list them under a separate Legacy section. Clicking on these scopes will not visualize them, as we also don't support visualizing legacy scopes.

packages/common/src/cursorlessCommandIds.ts

@@ -69,6 +69,12 @@ export const cursorlessCommandDescriptions: Record<
     "Resume test case recording",
   ),
   ["cursorless.showDocumentation"]: new VisibleCommand("Show documentation"),
+  ["cursorless.showScopeVisualizer"]: new VisibleCommand(
+    "Show the scope visualizer",
+  ),
+  ["cursorless.hideScopeVisualizer"]: new VisibleCommand(
+    "Hide the scope visualizer",
+  ),
 
   ["cursorless.command"]: new HiddenCommand("The core cursorless command"),
   ["cursorless.showQuickPick"]: new HiddenCommand(
@@ -110,10 +116,4 @@ export const cursorlessCommandDescriptions: Record<
   ["cursorless.keyboard.modal.modeToggle"]: new HiddenCommand(
     "Toggle the cursorless modal mode",
   ),
-  ["cursorless.showScopeVisualizer"]: new HiddenCommand(
-    "Show the scope visualizer",
-  ),
-  ["cursorless.hideScopeVisualizer"]: new HiddenCommand(
-    "Hide the scope visualizer",
-  ),
 };

packages/common/src/cursorlessSideBarIds.ts

@@ -0,0 +1 @@
+export const CURSORLESS_SCOPE_TREE_VIEW_ID = "cursorless.scopes";

packages/common/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./cursorlessCommandIds";
+export * from "./cursorlessSideBarIds";
 export * from "./testUtil/extractTargetedMarks";
 export { default as FakeIDE } from "./ide/fake/FakeIDE";
 export type { Message } from "./ide/spy/SpyMessages";

packages/cursorless-vscode/package.json

@@ -46,6 +46,7 @@
   ],
   "activationEvents": [
     "onLanguage",
+    "onView:cursorless.scopes",
     "onCommand:cursorless.command",
     "onCommand:cursorless.internal.updateCheatsheetDefaults",
     "onCommand:cursorless.keyboard.escape",
@@ -77,6 +78,14 @@
     }
   },
   "contributes": {
+    "views": {
+      "cursorless": [
+        {
+          "id": "cursorless.scopes",
+          "name": "Scopes"
+        }
+      ]
+    },
     "commands": [
       {
         "command": "cursorless.toggleDecorations",
@@ -106,6 +115,14 @@
         "command": "cursorless.showDocumentation",
         "title": "Cursorless: Show documentation"
       },
+      {
+        "command": "cursorless.showScopeVisualizer",
+        "title": "Cursorless: Show the scope visualizer"
+      },
+      {
+        "command": "cursorless.hideScopeVisualizer",
+        "title": "Cursorless: Hide the scope visualizer"
+      },
       {
         "command": "cursorless.command",
         "title": "Cursorless: The core cursorless command",
@@ -175,16 +192,6 @@
         "command": "cursorless.keyboard.modal.modeToggle",
         "title": "Cursorless: Toggle the cursorless modal mode",
         "enablement": "false"
-      },
-      {
-        "command": "cursorless.showScopeVisualizer",
-        "title": "Cursorless: Show the scope visualizer",
-        "enablement": "false"
-      },
-      {
-        "command": "cursorless.hideScopeVisualizer",
-        "title": "Cursorless: Hide the scope visualizer",
-        "enablement": "false"
       }
     ],
     "colors": [
@@ -1032,6 +1039,15 @@
           "fontCharacter": "\\E900"
         }
       }
+    },
+    "viewsContainers": {
+      "activitybar": [
+        {
+          "id": "cursorless",
+          "title": "Cursorless",
+          "icon": "images/logo.svg"
+        }
+      ]
     }
   },
   "sponsor": {