Cursorless everywhere in Talon (#2503)

## Oddities and todos
- [ ] Talon requires a javascript file to have a Talon(or another
package?) import before any other code. Right now I do that in my
[`esbuild.sh`](https://github.com/cursorless-dev/cursorless/blob/100f7706553fd24ce3ccbec2d1ec30c20e7f0a3f/packages/cursorless-talon-js/esbuild.sh#L20-L22)
script. This does not support esbuild watch.
    - The solution here is for Talon to support mjs file endings
- [x] Restore num selections check for windows:
[`cursorless_everywhere_talon_win.py`](https://github.com/cursorless-dev/cursorless/blob/824735f58e58ea3ca5bfb2448df801a4e7f28b1c/cursorless-everywhere-talon/cursorless_everywhere_talon_win.py#L49-L50)
once Talon converts from js to py correctly
- [x] Is there any point in outputting source maps to Talon?
- [x] If easy, let's run in CI on all platforms



## Information
* https://bellard.org/quickjs/

## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] 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)
- [/] I have not broken the cheatsheet

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: Pokey Rule <[email protected]>

Author: 3 people

.github/workflows/test.yml

@@ -45,6 +45,14 @@ jobs:
         if: runner.os == 'Linux'
       - run: pnpm --color test
         if: runner.os != 'Linux'
+      - run: xvfb-run -a pnpm -F @cursorless/test-harness test:talonJs
+        if: runner.os == 'Linux' && matrix.vscode_version == 'stable'
+      - run: pnpm -F @cursorless/test-harness test:talonJs
+        if: runner.os != 'Linux' && matrix.vscode_version == 'stable'
+      - run: xvfb-run -a pnpm -F @cursorless/cursorless-everywhere-talon-e2e test:quickjs
+        if: runner.os == 'Linux' && matrix.vscode_version == 'stable'
+      - run: pnpm -F @cursorless/cursorless-everywhere-talon-e2e test:quickjs
+        if: runner.os != 'Linux' && matrix.vscode_version == 'stable'
       - run: bash -x scripts/install-neovim-dependencies.sh
       - uses: rhysd/action-setup-vim@v1
         id: vim

.gitignore

@@ -1,10 +1,12 @@
 out
 dist
+testOut
 node_modules
 .vscode-test/
 *.vsix
 /package-lock.json
 *.DS_Store
+meta.json
 .luacheckcache
 
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

.vscode/launch.json

@@ -130,7 +130,7 @@
 
     // Talon launch configs
     {
-      "name": "Talon: Test",
+      "name": "Talon: Test grammar",
       "type": "node",
       "request": "launch",
       "program": "${workspaceFolder}/packages/test-harness/dist/runTalonTests.cjs",
@@ -146,7 +146,7 @@
       ]
     },
     {
-      "name": "Talon: Test (subset)",
+      "name": "Talon: Test grammar (subset)",
       "type": "node",
       "request": "launch",
       "program": "${workspaceFolder}/packages/test-harness/dist/runTalonTests.cjs",
@@ -163,6 +163,41 @@
       ]
     },
 
+    // Talon everywhere/JS launch configs
+    {
+      "name": "TalonJS: Test",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceFolder}/packages/test-harness/dist/runTalonJsTests.cjs",
+      "env": {
+        "CURSORLESS_MODE": "test",
+        "CURSORLESS_REPO_ROOT": "${workspaceFolder}"
+      },
+      "outFiles": ["${workspaceFolder}/**/out/**/*.js"],
+      "preLaunchTask": "VSCode: Build extension and tests",
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ]
+    },
+    {
+      "name": "TalonJS: Test (subset)",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceFolder}/packages/test-harness/dist/runTalonJsTests.cjs",
+      "env": {
+        "CURSORLESS_MODE": "test",
+        "CURSORLESS_RUN_TEST_SUBSET": "true",
+        "CURSORLESS_REPO_ROOT": "${workspaceFolder}"
+      },
+      "outFiles": ["${workspaceFolder}/**/out/**/*.js"],
+      "preLaunchTask": "VSCode: Build extension and tests",
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**"
+      ]
+    },
+
     // Unit tests launch configs
     {
       "name": "Unit tests: Test",

cursorless-everywhere-talon/cursorless_everywhere_talon.py

@@ -0,0 +1,50 @@
+from typing import TypedDict
+
+from talon import Module
+
+
+class SelectionOffsets(TypedDict):
+    anchor: int
+    active: int
+
+
+class EditorState(TypedDict):
+    text: str
+    selections: list[SelectionOffsets]
+
+
+class EditorChange(TypedDict):
+    text: str
+    rangeOffset: int
+    rangeLength: int
+
+
+class EditorEdit(TypedDict):
+    # The new document content after the edit
+    text: str
+
+    # A list of changes that were made to the document. If you can not handle
+    # this, you can ignore it and just replace the entire document with the
+    # value of the `text` field above.
+    changes: list[EditorChange]
+
+
+mod = Module()
+
+mod.tag("cursorless_everywhere_talon", desc="Enable cursorless everywhere in Talon")
+
+
+@mod.action_class
+class Actions:
+    def cursorless_everywhere_get_editor_state() -> EditorState:  # pyright: ignore [reportReturnType]
+        """Get the focused editor element state"""
+
+    def cursorless_everywhere_set_selections(
+        selections: list[SelectionOffsets],  # pyright: ignore [reportGeneralTypeIssues]
+    ):
+        """Set focused element selections"""
+
+    def cursorless_everywhere_edit_text(
+        edit: EditorEdit,  # pyright: ignore [reportGeneralTypeIssues]
+    ):
+        """Edit focused element text"""

cursorless-everywhere-talon/cursorless_everywhere_talon_win.py

@@ -0,0 +1,129 @@
+from talon import Context, app, ui
+
+from .cursorless_everywhere_talon import (
+    EditorEdit,
+    EditorState,
+    SelectionOffsets,
+)
+
+if app.platform == "windows":
+    from talon.windows.ax import TextRange
+
+
+# https://learn.microsoft.com/en-us/dotnet/api/system.windows.automation.text.textpatternrange?view=windowsdesktop-8.0
+
+ctx = Context()
+
+ctx.matches = r"""
+os: windows
+"""
+
+
+@ctx.action_class("user")
+class Actions:
+    def cursorless_everywhere_get_editor_state() -> EditorState:
+        el = ui.focused_element()
+
+        if "Text2" not in el.patterns:
+            raise ValueError("Focused element is not a text element")
+
+        text_pattern = el.text_pattern2
+        document_range = text_pattern.document_range
+        caret_range = text_pattern.caret_range
+        selection_ranges = text_pattern.selection
+        selections: list[SelectionOffsets] = []
+
+        for selection_range in selection_ranges:
+            anchor, active = get_selection(document_range, selection_range, caret_range)
+            selections.append(
+                {
+                    "anchor": anchor,
+                    "active": active,
+                }
+            )
+
+        return {
+            "text": document_range.text,
+            "selections": selections,
+        }
+
+    def cursorless_everywhere_set_selections(
+        selections: list[SelectionOffsets],  # pyright: ignore [reportGeneralTypeIssues]
+    ):
+        if selections.length != 1:  # pyright: ignore [reportAttributeAccessIssue]
+            raise ValueError("Only single selection supported")
+
+        selection = selections[0]
+        anchor = selection["anchor"]
+        active = selection["active"]
+
+        el = ui.focused_element()
+
+        if "Text2" not in el.patterns:
+            raise ValueError("Focused element is not a text element")
+
+        text_pattern = el.text_pattern2
+        document_range = text_pattern.document_range
+
+        set_selection(document_range, anchor, active)
+
+    def cursorless_everywhere_edit_text(
+        edit: EditorEdit,  # pyright: ignore [reportGeneralTypeIssues]
+    ):
+        text = edit["text"]
+
+        el = ui.focused_element()
+
+        if "Value" not in el.patterns:
+            raise ValueError("Focused element is not a text element")
+
+        el.value_pattern.value = text
+
+
+def set_selection(document_range: TextRange, anchor: int, active: int):
+    # This happens in slack, for example. The document range starts with a
+    # newline and selecting first character we'll make the selection go outside
+    # of the edit box.
+    if document_range.text.startswith("\n") and anchor == 0 and active == 0:
+        anchor = 1
+        active = 1
+
+    start = min(anchor, active)
+    end = max(anchor, active)
+    range = document_range.clone()
+    range.move_endpoint_by_range("End", "Start", target=document_range)
+    range.move_endpoint_by_unit("End", "Character", end)
+    range.move_endpoint_by_unit("Start", "Character", start)
+    range.select()
+
+
+def get_selection(
+    document_range: TextRange, selection_range: TextRange, caret_range: TextRange
+) -> tuple[int, int]:
+    # Make copy of the document range to avoid modifying the original
+    range_before_selection = document_range.clone()
+    # Move the end of the copy to the start of the selection
+    # range_before_selection.end = selection_range.start
+    range_before_selection.move_endpoint_by_range(
+        "End",
+        "Start",
+        target=selection_range,
+    )
+    # The selection start offset is the length of the text before the selection
+    start = len(range_before_selection.text)
+
+    range_after_selection = document_range.clone()
+    range_after_selection.move_endpoint_by_range(
+        "Start",
+        "End",
+        target=selection_range,
+    )
+    end = len(document_range.text) - len(range_after_selection.text)
+
+    # The selection is reversed if the caret is at the start of the selection
+    is_reversed = (
+        caret_range.compare_endpoints("Start", "Start", target=selection_range) == 0
+    )
+
+    # Return as (anchor, active)
+    return (end, start) if is_reversed else (start, end)

packages/common/src/index.ts

@@ -103,6 +103,7 @@ export * from "./util/object";
 export * from "./util/omitByDeep";
 export * from "./util/range";
 export * from "./util/regex";
+export * from "./util/selectionsEqual";
 export * from "./util/serializedMarksToTokenHats";
 export * from "./util/splitKey";
 export * from "./util/textFormatters";

packages/common/src/util/selectionsEqual.ts

@@ -0,0 +1,7 @@
+import type { Selection } from "../types/Selection";
+
+export function selectionsEqual(a: Selection[], b: Selection[]): boolean {
+  return (
+    a.length === b.length && a.every((selection, i) => selection.isEqual(b[i]))
+  );
+}

packages/cursorless-everywhere-talon-core/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@cursorless/cursorless-everywhere-talon-core",
+  "version": "1.0.0",
+  "description": "cursorless in talon js core packagee",
+  "main": "./out/index.js",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "compile:tsc": "tsc --build",
+    "compile:esbuild": "esbuild ./src/index.ts --sourcemap --format=esm --bundle --packages=external --outfile=./out/index.js",
+    "compile": "pnpm compile:tsc && pnpm compile:esbuild",
+    "watch:tsc": "pnpm compile:tsc --watch",
+    "watch:esbuild": "pnpm compile:esbuild --watch",
+    "watch": "pnpm run --filter @cursorless/cursorless-everywhere-talon-core --parallel '/^watch:.*/'",
+    "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
+  },
+  "dependencies": {
+    "@cursorless/common": "workspace:*",
+    "@cursorless/cursorless-engine": "workspace:*",
+    "lodash-es": "^4.17.21",
+    "vscode-uri": "^3.0.8"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "4.17.0"
+  },
+  "types": "./out/index.d.ts",
+  "exports": {
+    ".": {
+      "cursorless:bundler": "./src/index.ts",
+      "default": "./out/index.js"
+    }
+  }
+}

packages/cursorless-everywhere-talon-core/src/README.md

@@ -0,0 +1,12 @@
+# Cursorless everywhere Talon
+
+## Activate by enabling tag
+
+Add a file like the following anywhere in your Talon user files. In the below example we are enabling Cursorless everywhere if we are not in vscode. Of course update this to fit your Cursorless IDE (vscode, neovim) of choice. Or globally enabled if this is your only Cursorless implementation.
+
+```talon
+not app: vscode
+-
+
+tag(): user.cursorless_everywhere_talon
+```

packages/cursorless-everywhere-talon-core/src/constructTestHelpers.ts

@@ -0,0 +1,62 @@
+import type {
+  Command,
+  CommandResponse,
+  FakeCommandServerApi,
+  HatTokenMap,
+  IDE,
+  NormalizedIDE,
+  StoredTargetKey,
+  TargetPlainObject,
+  TextEditor,
+} from "@cursorless/common";
+import {
+  plainObjectToTarget,
+  type CommandApi,
+  type StoredTargetMap,
+} from "@cursorless/cursorless-engine";
+import type { TalonJsIDE } from "./ide/TalonJsIDE";
+import type { TalonJsTestHelpers } from "./types/types";
+
+interface Args {
+  talonJsIDE: TalonJsIDE;
+  normalizedIde: NormalizedIDE;
+  injectIde: (ide: IDE) => void;
+  commandApi: CommandApi;
+  hatTokenMap: HatTokenMap;
+  commandServerApi: FakeCommandServerApi;
+  storedTargets: StoredTargetMap;
+}
+
+export function constructTestHelpers({
+  talonJsIDE,
+  normalizedIde,
+  injectIde,
+  commandApi,
+  hatTokenMap,
+  commandServerApi,
+  storedTargets,
+}: Args): TalonJsTestHelpers {
+  return {
+    talonJsIDE,
+    ide: normalizedIde,
+    commandServerApi,
+    hatTokenMap,
+    storedTargets,
+    injectIde,
+
+    runCommand(command: Command): Promise<CommandResponse | unknown> {
+      return commandApi.runCommand(command);
+    },
+
+    setStoredTarget(
+      editor: TextEditor,
+      key: StoredTargetKey,
+      targets: TargetPlainObject[] | undefined,
+    ): void {
+      storedTargets.set(
+        key,
+        targets?.map((target) => plainObjectToTarget(editor, target)),
+      );
+    },
+  };
+}