Rename

Author: pokey

packages/cursorless-vscode/package.json

@@ -46,7 +46,7 @@
   ],
   "activationEvents": [
     "onLanguage",
-    "onView:cursorless.scopeSupport",
+    "onView:cursorless.scopes",
     "onCommand:cursorless.command",
     "onCommand:cursorless.internal.updateCheatsheetDefaults",
     "onCommand:cursorless.keyboard.escape",
@@ -81,8 +81,8 @@
     "views": {
       "cursorless": [
         {
-          "id": "cursorless.scopeSupport",
-          "name": "Scope support"
+          "id": "cursorless.scopes",
+          "name": "Scopes"
         }
       ]
     },

packages/cursorless-vscode/src/ScopeSupportTreeProvider.ts renamed to packages/cursorless-vscode/src/ScopeTreeProvider.ts

@@ -7,42 +7,55 @@ import {
   ScopeTypeInfo,
 } from "@cursorless/cursorless-engine";
 import { VscodeApi } from "@cursorless/vscode-common";
+import { CURSORLESS_SCOPE_TREE_VIEW_ID } from "@cursorless/vscode-common";
 import { isEqual } from "lodash";
-import * as vscode from "vscode";
+import type {
+  Event,
+  ExtensionContext,
+  TreeDataProvider,
+  TreeItemLabel,
+  TreeView,
+  TreeViewVisibilityChangeEvent,
+} from "vscode";
+import {
+  EventEmitter,
+  ThemeIcon,
+  TreeItem,
+  TreeItemCollapsibleState,
+} from "vscode";
 import { URI } from "vscode-uri";
 import {
   ScopeVisualizer,
   VisualizationType,
 } from "./ScopeVisualizerCommandApi";
 
 export const DONT_SHOW_TALON_UPDATE_MESSAGE_KEY = "dontShowUpdateTalonMessage";
-
-export class ScopeSupportTreeProvider
-  implements vscode.TreeDataProvider<MyTreeItem>
-{
+export class ScopeTreeProvider implements TreeDataProvider<MyTreeItem> {
   private visibleDisposable: Disposer | undefined;
-  private treeView: vscode.TreeView<MyTreeItem>;
+  private treeView: TreeView<MyTreeItem>;
   private supportLevels: ScopeSupportLevels = [];
   private shownUpdateTalonMessage = false;
 
-  private _onDidChangeTreeData: vscode.EventEmitter<
+  private _onDidChangeTreeData: EventEmitter<
     MyTreeItem | undefined | null | void
-  > = new vscode.EventEmitter<MyTreeItem | undefined | null | void>();
-  readonly onDidChangeTreeData: vscode.Event<
-    MyTreeItem | undefined | null | void
-  > = this._onDidChangeTreeData.event;
+  > = new EventEmitter<MyTreeItem | undefined | null | void>();
+  readonly onDidChangeTreeData: Event<MyTreeItem | undefined | null | void> =
+    this._onDidChangeTreeData.event;
 
   constructor(
     private vscodeApi: VscodeApi,
-    private context: vscode.ExtensionContext,
+    private context: ExtensionContext,
     private scopeProvider: ScopeProvider,
     private scopeVisualizer: ScopeVisualizer,
     private customSpokenFormGenerator: CustomSpokenFormGenerator,
     private hasCommandServer: boolean,
   ) {
-    this.treeView = vscodeApi.window.createTreeView("cursorless.scopeSupport", {
-      treeDataProvider: this,
-    });
+    this.treeView = vscodeApi.window.createTreeView(
+      CURSORLESS_SCOPE_TREE_VIEW_ID,
+      {
+        treeDataProvider: this,
+      },
+    );
 
     this.context.subscriptions.push(
       this.treeView,
@@ -53,13 +66,13 @@ export class ScopeSupportTreeProvider
 
   static create(
     vscodeApi: VscodeApi,
-    context: vscode.ExtensionContext,
+    context: ExtensionContext,
     scopeProvider: ScopeProvider,
     scopeVisualizer: ScopeVisualizer,
     customSpokenFormGenerator: CustomSpokenFormGenerator,
     hasCommandServer: boolean,
-  ): ScopeSupportTreeProvider {
-    const treeProvider = new ScopeSupportTreeProvider(
+  ): ScopeTreeProvider {
+    const treeProvider = new ScopeTreeProvider(
       vscodeApi,
       context,
       scopeProvider,
@@ -77,7 +90,7 @@ export class ScopeSupportTreeProvider
     }
   }
 
-  onDidChangeVisible(e: vscode.TreeViewVisibilityChangeEvent) {
+  onDidChangeVisible(e: TreeViewVisibilityChangeEvent) {
     if (e.visible) {
       if (this.visibleDisposable != null) {
         return;
@@ -197,30 +210,30 @@ export class ScopeSupportTreeProvider
 function getSupportCategories(): SupportCategoryTreeItem[] {
   return [
     new SupportCategoryTreeItem(
-      "Supported and present in editor",
+      "Present",
       ScopeSupport.supportedAndPresentInEditor,
-      vscode.TreeItemCollapsibleState.Expanded,
+      TreeItemCollapsibleState.Expanded,
     ),
     new SupportCategoryTreeItem(
-      "Supported but not present in editor",
+      "Not present",
       ScopeSupport.supportedButNotPresentInEditor,
-      vscode.TreeItemCollapsibleState.Expanded,
+      TreeItemCollapsibleState.Expanded,
     ),
     new SupportCategoryTreeItem(
-      "Supported using legacy pathways",
+      "Legacy",
       ScopeSupport.supportedLegacy,
-      vscode.TreeItemCollapsibleState.Expanded,
+      TreeItemCollapsibleState.Expanded,
     ),
     new SupportCategoryTreeItem(
       "Unsupported",
       ScopeSupport.unsupported,
-      vscode.TreeItemCollapsibleState.Collapsed,
+      TreeItemCollapsibleState.Collapsed,
     ),
   ];
 }
 
-class ScopeSupportTreeItem extends vscode.TreeItem {
-  public label: vscode.TreeItemLabel;
+class ScopeSupportTreeItem extends TreeItem {
+  public label: TreeItemLabel;
 
   /**
    * @param scopeTypeInfo The scope type info
@@ -237,7 +250,7 @@ class ScopeSupportTreeItem extends vscode.TreeItem {
         : `"${scopeTypeInfo.spokenForm.preferred}"`;
     const description = scopeTypeInfo.humanReadableName;
 
-    super(label, vscode.TreeItemCollapsibleState.None);
+    super(label, TreeItemCollapsibleState.None);
 
     const requiresTalonUpdate =
       scopeTypeInfo.spokenForm.type === "error" &&
@@ -279,16 +292,16 @@ class ScopeSupportTreeItem extends vscode.TreeItem {
         };
 
     if (scopeTypeInfo.isLanguageSpecific) {
-      this.iconPath = new vscode.ThemeIcon("code");
+      this.iconPath = new ThemeIcon("code");
     }
   }
 }
 
-class SupportCategoryTreeItem extends vscode.TreeItem {
+class SupportCategoryTreeItem extends TreeItem {
   constructor(
     label: string,
     public readonly scopeSupport: ScopeSupport,
-    collapsibleState: vscode.TreeItemCollapsibleState,
+    collapsibleState: TreeItemCollapsibleState,
   ) {
     super(label, collapsibleState);
   }

packages/cursorless-vscode/src/extension.ts

@@ -42,7 +42,7 @@ import {
 } from "./ScopeVisualizerCommandApi";
 import { StatusBarItem } from "./StatusBarItem";
 import { vscodeApi } from "./vscodeApi";
-import { ScopeSupportTreeProvider } from "./ScopeSupportTreeProvider";
+import { ScopeTreeProvider } from "./ScopeTreeProvider";
 
 /**
  * Extension entrypoint called by VSCode on Cursorless startup.
@@ -96,7 +96,7 @@ export async function activate(
   const statusBarItem = StatusBarItem.create("cursorless.showQuickPick");
   const keyboardCommands = KeyboardCommands.create(context, statusBarItem);
   const scopeVisualizer = createScopeVisualizer(normalizedIde, scopeProvider);
-  ScopeSupportTreeProvider.create(
+  ScopeTreeProvider.create(
     vscodeApi,
     context,
     scopeProvider,

packages/cursorless-vscode/src/ide/vscode/VscodeGlobalState.ts

@@ -2,7 +2,7 @@ import type { State, StateData, StateKey } from "@cursorless/common";
 import { STATE_DEFAULTS } from "@cursorless/common";
 import type { ExtensionContext } from "vscode";
 import { VERSION_KEY } from "../../ReleaseNotes";
-import { DONT_SHOW_TALON_UPDATE_MESSAGE_KEY } from "../../ScopeSupportTreeProvider";
+import { DONT_SHOW_TALON_UPDATE_MESSAGE_KEY } from "../../ScopeTreeProvider";
 
 export default class VscodeGlobalState implements State {
   constructor(private extensionContext: ExtensionContext) {

packages/meta-updater/src/getCursorlessVscodeFields.ts

@@ -23,7 +23,7 @@ export function getCursorlessVscodeFields(input: PackageJson) {
 
       // Causes extension to activate when the Cursorless scope support side bar
       // is opened
-      "onView:cursorless.scopeSupport",
+      "onView:cursorless.scopes",
 
       // Causes extension to activate when any Cursorless command is run.
       // Technically we don't need to do this since VSCode 1.74.0, but we support

packages/vscode-common/src/cursorlessSideBarIds.ts

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

packages/vscode-common/src/index.ts

@@ -5,3 +5,4 @@ export * from "./vscodeUtil";
 export * from "./runCommand";
 export * from "./VscodeApi";
 export * from "./ScopeVisualizerColorConfig";
+export * from "./cursorlessSideBarIds";