Add command to get hat decorations

build

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Remove any previously compiled versions.
+rm *.vsix || true
+
+echo "================================================================================"
+echo "Packaging extension..."
+echo "================================================================================"
+yes | vsce package
+
+# Install the compiled extension.
+echo ""
+echo "================================================================================"
+echo "Installing extension..."
+echo "================================================================================"
+
+# Uninstalling the old version seems to be necessary to force Code to pick up the new version reliably.
+code --uninstall-extension pokey-phillco.cursorless-fork
+code --install-extension *.vsix
+
+echo ""
+echo "================================================================================"
+echo "Reloading VS Code..."
+echo "================================================================================"
+
+# Use the command socket to tell VS Code to reload in the background, if socat is installed.
+if [[ $(type -P "socat") ]] && [[ -e ~/.cursorless/vscode-socket ]]; then
+  echo "Reloading VS Code using the command socket..."
+  echo '{ "command": "command", "commandId": "workbench.action.reloadWindow" }' | socat - ~/.cursorless/vscode-socket
+else
+  echo "Not automatically reloading VS Code because \`socat\` is not installed"
+  echo "Reload the VS Code window manually (\"window reload\") to get the new version"
+fi
+
+echo "Done"

cursorless.iml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="Python" name="Python">
+      <configuration sdkName="Python 2.7 (venv)" />
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/data/playground" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/dist" />
+      <excludeFolder url="file://$MODULE_DIR$/.vscode-sandbox" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Python 2.7 (venv) interpreter library" level="application" />
+  </component>
+</module>

package.json

@@ -1,7 +1,7 @@
 {
-	"name": "cursorless",
-	"displayName": "Cursorless",
-	"description": "Structural voice coding at the speed of thought",
+	"name": "cursorless-fork",
+	"displayName": "Cursorless (Sidecar Fork)",
+	"description": "Forked version of Cursorless to be used as a sidecar for other editors.",
 	"icon": "images/icon.png",
 	"galleryBanner": {
 		"color": "#00001A",
@@ -19,12 +19,12 @@
 			"description": "Tests"
 		}
 	],
-	"version": "0.26.0",
-	"publisher": "pokey",
+	"version": "0.50.66",
+	"publisher": "pokey-phillco",
 	"license": "MIT",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/cursorless-dev/cursorless.git"
+		"url": "https://github.com/phillco/cursorless.git"
 	},
 	"homepage": "https://www.cursorless.org/",
 	"engines": {

src/actions/FollowLink.ts

@@ -18,6 +18,12 @@ export default class FollowLink implements Action {
       this.graph.editStyles.referenced
     );
 
+    // NOTE(pcohen): this is where we would call out to JetBrains
+    // all "editor actions" need to operate purely on ranges,
+    // not targets.
+
+    // NOTE(pcohen): this is for stuff like links in the
+    // https://microsoft.com
     const link = await getLinkForTarget(target);
     if (link) {
       await this.openUri(link.target!);

src/core/HatAllocator.ts

@@ -1,8 +1,12 @@
 import * as vscode from "vscode";
 import { Disposable } from "vscode";
 import { Graph } from "../typings/Types";
-import { addDecorationsToEditors } from "../util/addDecorationsToEditor";
+import {
+  addDecorationsToEditors,
+  getEverywhereInformation,
+} from "../util/addDecorationsToEditor";
 import { IndividualHatMap } from "./IndividualHatMap";
+import { Range } from "vscode";
 
 interface Context {
   getActiveMap(): Promise<IndividualHatMap>;
@@ -13,17 +17,19 @@ export class HatAllocator {
   private isActive: boolean;
   private disposables: Disposable[] = [];
   private disposalFunctions: (() => void)[] = [];
+  private visibleRange: Range[];
 
   constructor(private graph: Graph, private context: Context) {
     graph.extensionContext.subscriptions.push(this);
-
+    this.visibleRange = [];
     this.isActive = vscode.workspace
       .getConfiguration("cursorless")
       .get<boolean>("showOnStart")!;
 
     this.addDecorationsDebounced = this.addDecorationsDebounced.bind(this);
     this.toggleDecorations = this.toggleDecorations.bind(this);
     this.clearEditorDecorations = this.clearEditorDecorations.bind(this);
+    this.setVisibleRange = this.setVisibleRange.bind(this);
 
     this.disposalFunctions.push(
       graph.decorations.registerDecorationChangeListener(
@@ -36,6 +42,14 @@ export class HatAllocator {
         "cursorless.toggleDecorations",
         this.toggleDecorations
       ),
+      vscode.commands.registerCommand(
+        "cursorless.getDecorations",
+        getEverywhereInformation
+      ),
+      vscode.commands.registerCommand(
+        "cursorless.setVisibleRange",
+        this.setVisibleRange
+      ),
 
       // An event that fires when a text document opens
       vscode.workspace.onDidOpenTextDocument(this.addDecorationsDebounced),
@@ -61,6 +75,21 @@ export class HatAllocator {
         this.addDecorationsDebounced
       )
     );
+
+    // NOTE(pcohen): this is just a hack until we have extension points between
+    // the sidecar and Cursorless.
+    // Update decorations on editor state change since we won't be scrolling the sidecar.
+    const watcher = vscode.workspace.createFileSystemWatcher(
+      new vscode.RelativePattern(
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        require("os").homedir() + "/.cursorless/",
+        "*-state.json"
+      )
+    );
+
+    watcher.onDidChange((_) => {
+      this.addDecorationsDebounced();
+    });
   }
 
   private clearEditorDecorations(editor: vscode.TextEditor) {
@@ -76,7 +105,8 @@ export class HatAllocator {
       addDecorationsToEditors(
         activeMap,
         this.graph.decorations,
-        this.graph.tokenGraphemeSplitter
+        this.graph.tokenGraphemeSplitter,
+        this.visibleRange
       );
     } else {
       vscode.window.visibleTextEditors.forEach(this.clearEditorDecorations);
@@ -104,6 +134,11 @@ export class HatAllocator {
     this.addDecorationsDebounced();
   }
 
+  private setVisibleRange(visible: any) {
+    const range = [new Range(visible.firstVisible, 0, visible.lastVisible, 0)];
+    this.visibleRange = range;
+  }
+
   dispose() {
     this.disposables.forEach(({ dispose }) => dispose());
     this.disposalFunctions.forEach((dispose) => dispose());

src/extension.ts

@@ -16,6 +16,9 @@ import CommandRunner from "./core/commandRunner/CommandRunner";
  * - Creates an entrypoint for running commands {@link CommandRunner}.
  */
 export async function activate(context: vscode.ExtensionContext) {
+  // NOTE(pcohen): can be used to debug code reloading issues
+  // vscode.window.showInformationMessage("cursorless-everywhere fork started (v10)!");
+
   const { getNodeAtLocation } = await getParseTreeApi();
   const commandServerApi = await getCommandServerApi();
 

src/testUtil/toPlainObject.ts

@@ -1,4 +1,4 @@
-import { Position, Range, Selection } from "vscode";
+import { Selection, Position, Range, TextEditor } from "vscode";
 import { TestDecoration } from "../core/editStyles";
 import type { Target } from "../typings/target.types";
 import { Token } from "../typings/Types";
@@ -13,6 +13,13 @@ export type RangePlainObject = {
   end: PositionPlainObject;
 };
 
+export type RangePlainObjectWithOffsets = {
+  start: PositionPlainObject;
+  end: PositionPlainObject;
+  startOffset: number;
+  endOffset: number;
+};
+
 export type SelectionPlainObject = {
   anchor: PositionPlainObject;
   active: PositionPlainObject;
@@ -60,6 +67,25 @@ export function rangeToPlainObject(range: Range): RangePlainObject {
   };
 }
 
+/**
+ * Like `rangeToPlainObject`, but also includes the document character offsets.
+ *
+ * This is mainly for ease of implementation inside of other editors.
+ * @param range
+ * @param editor
+ */
+export function rangeToPlainObjectWithOffsets(
+  range: Range,
+  editor: TextEditor
+): RangePlainObjectWithOffsets {
+  return {
+    start: positionToPlainObject(range.start),
+    end: positionToPlainObject(range.end),
+    startOffset: editor.document.offsetAt(range.start),
+    endOffset: editor.document.offsetAt(range.end),
+  };
+}
+
 export function selectionToPlainObject(
   selection: Selection
 ): SelectionPlainObject {