Add a status bar item for cursorless (cursorless-dev#881)

* first pass at status bar item

* capitalize cursorless

Co-authored-by: Pokey Rule <[email protected]>

* add showDocumentation command

Co-authored-by: Pokey Rule <[email protected]>

package.json

@@ -77,6 +77,10 @@
 			{
 				"command": "cursorless.resumeRecording",
 				"title": "Cursorless: Resume test case recording"
+			},
+			{
+				"command": "cursorless.showDocumentation",
+				"title": "Cursorless: Show documentation"
 			}
 		],
 		"colors": [
@@ -540,7 +544,16 @@
 				"fileMatch": "*.cursorless-snippets",
 				"url": "./schemas/cursorless-snippets.json"
 			}
-		]
+		],
+		"icons": {
+			"cursorless-icon": {
+				"description": "Cursorless icon",
+				"default": {
+					"fontPath": "fonts/cursorless.woff",
+					"fontCharacter": "\\E900"
+				}
+			}
+		}
 	},
 	"sponsor": {
 		"url": "https://github.com/sponsors/pokey"

src/core/StatusBarItem.ts

@@ -0,0 +1,38 @@
+import * as vscode from "vscode";
+import { Graph } from "../typings/Types";
+
+export default class StatusBarItem {
+  private disposables: vscode.Disposable[] = [];
+
+  constructor(private graph: Graph) {
+    graph.extensionContext.subscriptions.push(this);
+  }
+
+  init() {
+    const commandId = "cursorless.showQuickPick";
+    const statusBarItem = vscode.window.createStatusBarItem(
+      vscode.StatusBarAlignment.Right,
+      100
+    );
+    statusBarItem.command = commandId;
+    statusBarItem.text = "$(cursorless-icon) Cursorless";
+    statusBarItem.show();
+
+    this.disposables.push(
+      vscode.commands.registerCommand("cursorless.showDocumentation", () =>
+        vscode.env.openExternal(
+          vscode.Uri.parse("https://www.cursorless.org/docs/")
+        )
+      ),
+      vscode.commands.registerCommand(commandId, this.showQuickOpen),
+      statusBarItem
+    );
+  }
+
+  private showQuickOpen = () =>
+    vscode.commands.executeCommand("workbench.action.quickOpen", ">Cursorless");
+
+  dispose() {
+    this.disposables.forEach(({ dispose }) => dispose());
+  }
+}

src/extension.ts

@@ -31,6 +31,7 @@ export async function activate(context: vscode.ExtensionContext) {
   graph.hatTokenMap.init();
   graph.testCaseRecorder.init();
   graph.cheatsheet.init();
+  graph.statusBarItem.init();
 
   const thatMark = new ThatMark();
   const sourceMark = new ThatMark();

src/typings/Types.ts

@@ -10,6 +10,7 @@ import FontMeasurements from "../core/FontMeasurements";
 import HatTokenMap from "../core/HatTokenMap";
 import { ReadOnlyHatMap } from "../core/IndividualHatMap";
 import { Snippets } from "../core/Snippets";
+import StatusBarItem from "../core/StatusBarItem";
 import { TokenGraphemeSplitter } from "../core/TokenGraphemeSplitter";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { IDE } from "../ide/ide.types";
@@ -158,6 +159,11 @@ export interface Graph {
    */
   readonly cheatsheet: Cheatsheet;
 
+  /**
+   * Creates a VSCode status bar item
+   */
+  readonly statusBarItem: StatusBarItem;
+
   /**
    * Used to split a token into a graphemes that can be used for a hat placement
    */

src/util/graphFactories.ts

@@ -6,6 +6,7 @@ import { EditStyles } from "../core/editStyles";
 import FontMeasurements from "../core/FontMeasurements";
 import HatTokenMap from "../core/HatTokenMap";
 import { Snippets } from "../core/Snippets";
+import StatusBarItem from "../core/StatusBarItem";
 import { TokenGraphemeSplitter } from "../core/TokenGraphemeSplitter";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { VscodeIDE } from "../ide/vscode/VscodeIDE";
@@ -28,6 +29,7 @@ const graphConstructors: Partial<ConstructorMap<Graph>> = {
   debug: Debug,
   testCaseRecorder: TestCaseRecorder,
   cheatsheet: Cheatsheet,
+  statusBarItem: StatusBarItem,
   tokenGraphemeSplitter: TokenGraphemeSplitter,
   ide: VscodeIDE,
 };