Cursorless scope side bar

pokey · pokey · commit e2bd86dbefb0 · 2023-10-29T18:28:45.000+01:00
diff --git a/cursorless-talon/src/apps/cursorless_vscode.py b/cursorless-talon/src/apps/cursorless_vscode.py
@@ -32,3 +32,9 @@ def private_cursorless_show_settings_in_ide():
         )
         actions.sleep("250ms")
         actions.insert("cursorless")
+
+    def private_cursorless_show_sidebar():
+        """Show Cursorless sidebar"""
+        actions.user.private_cursorless_run_rpc_command_and_wait(
+            "workbench.view.extension.cursorless"
+        )
diff --git a/cursorless-talon/src/cheatsheet/sections/get_scope_visualizer.py b/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",
+                },
+            ],
+        },
     ]
diff --git a/cursorless-talon/src/cursorless.py b/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"""
diff --git a/cursorless-talon/src/cursorless.talon b/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()
diff --git a/docs/user/scope-sidebar.md b/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.
diff --git a/images/logo.svg b/images/logo.svg
@@ -0,0 +1,6 @@
+<svg width="1920" height="1920" viewBox="0 0 1920 1920" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M960.001 237.896C1140.58 237.896 1306.36 310.143 1436.6 430.88C1388.26 184.524 1193.47 0 960.001 0C726.538 0 531.747 184.524 483.405 431.206C613.645 310.468 779.429 237.896 960.001 237.896Z" fill="black"/>
+<path d="M960.001 1681.92C779.429 1681.92 613.645 1609.62 483.405 1488.79C531.747 1735.34 726.538 1920 960.001 1920C1193.47 1920 1388.26 1735.34 1436.6 1488.79C1306.36 1609.62 1140.58 1681.92 960.001 1681.92Z" fill="black"/>
+<path d="M238.075 960C238.075 779.429 310.377 613.644 431.206 483.405C184.663 531.747 0 726.537 0 960C0 1193.47 184.663 1388.26 431.206 1436.6C310.703 1306.36 238.075 1140.58 238.075 960Z" fill="black"/>
+<path d="M1681.92 960C1681.92 1140.58 1609.62 1306.36 1488.79 1436.6C1735.34 1388.26 1920 1193.47 1920 960C1920 726.537 1735.34 531.747 1488.79 483.405C1609.62 613.644 1681.92 779.429 1681.92 960Z" fill="black"/>
+</svg>
diff --git a/packages/common/src/cursorlessCommandIds.ts b/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",
-  ),
 };
diff --git a/packages/common/src/cursorlessSideBarIds.ts b/packages/common/src/cursorlessSideBarIds.ts
@@ -0,0 +1 @@
+export const CURSORLESS_SCOPE_TREE_VIEW_ID = "cursorless.scopes";
diff --git a/packages/common/src/index.ts b/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";
diff --git a/packages/cursorless-vscode/package.json b/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": {
diff --git a/packages/cursorless-vscode/src/ScopeTreeProvider.ts b/packages/cursorless-vscode/src/ScopeTreeProvider.ts
diff --git a/packages/cursorless-vscode/src/extension.ts b/packages/cursorless-vscode/src/extension.ts
diff --git a/packages/cursorless-vscode/src/ide/vscode/VscodeGlobalState.ts b/packages/cursorless-vscode/src/ide/vscode/VscodeGlobalState.ts
diff --git a/packages/cursorless-vscode/src/scripts/populateDist/assets.ts b/packages/cursorless-vscode/src/scripts/populateDist/assets.ts
diff --git a/packages/meta-updater/src/getCursorlessVscodeFields.ts b/packages/meta-updater/src/getCursorlessVscodeFields.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# The Cursorless sidebar`
	`2`	`+`
	`3`	+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.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const CURSORLESS_SCOPE_TREE_VIEW_ID = "cursorless.scopes";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export * from "./cursorlessCommandIds";`
	`2`	`+export * from "./cursorlessSideBarIds";`
`2`	`3`	`export * from "./testUtil/extractTargetedMarks";`
`3`	`4`	`export { default as FakeIDE } from "./ide/fake/FakeIDE";`
`4`	`5`	`export type { Message } from "./ide/spy/SpyMessages";`