Add cursorless-talon-dev (#1017)

* Add cursorless-talon-dev

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Tweaks

* More tweaks

* Woops

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Andreas Arvidsson <andreas.arvidsson87@gmail.com>

Author: 3 people

.vscode/tasks.json

@@ -50,6 +50,21 @@
 				"cwd": "cursorless-nx"
 			},
 			"problemMatcher": []
+		},
+		{
+			"label": "Install local",
+			"type": "shell",
+			"command": "vsce package -o bundle.vsix && code --install-extension bundle.vsix",
+			"presentation": {
+				"focus": true
+			},
+			"problemMatcher": []
+		},
+		{
+			"label": "Run pre commit",
+			"type": "shell",
+			"command": "pre-commit run",
+			"presentation": {}
 		}
 	]
 }

cursorless-talon-dev/README.md

@@ -0,0 +1,3 @@
+# `cursorless-talon-dev`
+
+This directory contains voice commands to use while developing Cursorless. See https://www.cursorless.org/docs/contributing/ for more about how to contribute to Cursorless.

cursorless-talon-dev/src/cursorless_dev.py

@@ -0,0 +1,30 @@
+from talon import Module, actions
+
+mod = Module()
+
+
+@mod.action_class
+class Actions:
+    def cursorless_record_navigation_test():
+        """Start / stop recording Cursorless navigation tests"""
+        actions.user.run_rpc_command(
+            "cursorless.recordTestCase", {"isHatTokenMapTest": True}
+        )
+
+    def cursorless_record_error_test():
+        """Start recording Cursorless error tests"""
+        actions.user.run_rpc_command(
+            "cursorless.recordTestCase", {"recordErrors": True}
+        )
+
+    def cursorless_record_highlights_test():
+        """Start recording Cursorless decoration tests"""
+        actions.user.run_rpc_command(
+            "cursorless.recordTestCase", {"isDecorationsTest": True}
+        )
+
+    def cursorless_record_that_mark_test():
+        """Start recording Cursorless that mark tests"""
+        actions.user.run_rpc_command(
+            "cursorless.recordTestCase", {"captureFinalThatMark": True}
+        )

cursorless-talon-dev/src/cursorless_dev.talon

@@ -0,0 +1,16 @@
+tag: user.cursorless
+-
+
+{user.cursorless_homophone} record: user.run_rpc_command("cursorless.recordTestCase")
+{user.cursorless_homophone} pause: user.run_rpc_command("cursorless.pauseRecording")
+{user.cursorless_homophone} resume: user.run_rpc_command("cursorless.resumeRecording")
+
+{user.cursorless_homophone} record navigation:
+    user.cursorless_record_navigation_test()
+{user.cursorless_homophone} record error: user.cursorless_record_error_test()
+{user.cursorless_homophone} record highlights:
+    user.cursorless_record_highlights_test()
+{user.cursorless_homophone} record that mark:
+
+{user.cursorless_homophone} update cheatsheet:
+  user.cursorless_cheat_sheet_update_json()

cursorless-talon-dev/src/cursorless_dev_vscode.talon

@@ -0,0 +1,13 @@
+app: vscode
+-
+^install local$:
+    user.vscode_with_plugin("workbench.action.tasks.runTask", "Install local")
+^pre commit run$:
+    user.vscode_with_plugin("workbench.action.tasks.runTask", "Run pre commit")
+
+^serve start$:
+    user.vscode_with_plugin("workbench.action.tasks.runTask", "Serve cursorless.org")
+^serve stop$:
+    user.vscode("workbench.action.tasks.terminate")
+    insert("Serve")
+    key(enter)

docs/contributing/CONTRIBUTING.md

@@ -27,6 +27,8 @@ extension](#running--testing-extension-locally), you may want to check out the
 
    The `yarn init-launch-sandbox` command creates a local sandbox containing a specific set of VSCode extensions that will be run alongside Cursorless when you launch Cursorless in debug or test mode. Please file an issue if you'd like to use additional extensions when debugging locally.
 
+4. Copy / symlink `cursorless-talon-dev` into your Talon user directory for some useful voice commands for developing Cursorless.
+
 ## Running / testing extension locally
 
 In order to test out your local version of the extension or to run unit tests

docs/contributing/test-case-recorder.md

@@ -8,70 +8,13 @@ recording the initial state of the file including cursor position(s), the
 command run, and the final state, all in the form of a yaml document. See
 [existing test cases](../../src/test/suite/fixtures/recorded) for example outputs.
 
-## Initial setup
-
-Add a voice command for recording to your personal talon files:
-
-```talon
-cursorless record: user.vscode("cursorless.recordTestCase")
-```
-
-We don't want to commit this so please add it to your own Talon user file set.
-
-### Configuring the test case Recorder
-
-The test case recorder has several additional configuration options. The default configuration works for most tests, but you may find the following useful. For a full list of supported configuration options, see [the api docs](../api/interfaces/testutil_testcaserecorder.internal.recordtestcasecommandarg/).
-
-#### Testing the hat map
-
-We have a way to test that the hats in the hat map update correctly during the course of a single phrase. These tests are also how we usually test our [range updating code](../api/modules/core_updateSelections_updateSelections).
-
-Any tests recorded in the `hatTokenMap` directory will automatically be treated as hat token map tests. To initiate a series of hat token map tests in another directory, please add the following to your personal talon files:
-
-- https://github.com/pokey/pokey_talon/blob/9298c25dd6d28fd9fcf5ed39f305bc6b93e5f229/apps/vscode/vscode.talon#L468
-- https://github.com/pokey/pokey_talon/blob/49643bfa8f62cbec18b5ddad1658f5a28785eb01/apps/vscode/vscode.py#L203-L205
-
-When recording each test case for the hat token map, you'll need to proceed as described in [Navigation map tests](#navigation-map-tests).
-
-#### Capturing errors
-
-We support recording tests where the expected result is an error
-
-Please add a command to your personal talon files. See the two files links above for context. Add the command below to your to your `vscode.py` and ensure that there is a matching Talon command.
-
-```
-  actions.user.vscode_with_plugin("cursorless.recordTestCase", {"recordErrors": True})
-```
-
-#### Testing decoration highlights
-
-We support testing our decoration highlights, eg the flash of red when something is deleted. If you record tests into the `decorations/` directory, these will automatically be captured.
-
-If you'd like to record decorations when recording into a different directory, please add another command to your personal talon files. See the two files links above for context. Add the command below to your to your `vscode.py` and ensure that there is a matching Talon command.
-
-```
-  actions.user.vscode_with_plugin("cursorless.recordTestCase", {"isDecorationsTest": True})
-```
-
-#### Testing the returned `that` mark
-
-By default, we don't capture the `that` mark returned by a command, unless the test is being recorded in the `actions/` directory of the recorded tests. If you'd like to capture the returned `that` mark when recording a test somewhere else, you can do something like
-
-```
-  actions.user.vscode_with_plugin("cursorless.recordTestCase", {"captureFinalThatMark": True})
-```
-
-### Default config per test case directory
-
-Any test case directory that contains a `config.json` will set default configuration for all tests recorded in any descendant directory. For example, the file [`actions/config.json`](../../src/test/suite/fixtures/recorded/actions/config.json) makes it so that all our action tests will capture the final `that` mark. For a full list of keys supported in this json, see [the api docs](../api/interfaces/testutil_testcaserecorder.internal.recordtestcasecommandarg/).
-
 ## Recording new tests
 
 1. Start debugging (F5)
 1. Create a minimal file to use for recording tests. And position your cursor
    where you'd like. Check out the `initialState.documentContents` field of
    [existing test cases](../../src/test/suite/fixtures/recorded) for examples.
-1. Issue the `"cursorless record"` command
+1. Issue the `"cursorless record"` command. Alternately, issue one of the special recording commands listed in
    - List of target directories is shown. All test cases will be put into the
      given subdirectory of `src/test/suite/fixtures/recorded`
 1. Select existing directory or create new one
@@ -90,6 +33,38 @@ Any test case directory that contains a `config.json` will set default configura
    - `Stopped recording test cases` is shown
    - You can also just stop the debugger or close the debug window
 
+## Test case recorder options
+
+The test case recorder has several additional configuration options. The default configuration works for most tests, but you may find the following useful. For a full list of supported configuration options, see [the api docs](../api/interfaces/testutil_testcaserecorder.internal.recordtestcasecommandarg/).
+
+### The options
+
+#### Capturing errors
+
+We support recording tests where the expected result is an error. This can be done using the command `"cursorless record error"`.
+
+#### Testing decoration highlights
+
+We support testing our decoration highlights, eg the flash of red when something is deleted. If you record tests into the `decorations/` directory, these will automatically be captured.
+
+If you'd like to record decorations when recording into a different directory, you can say `"cursorless record highlights"`.
+
+#### Testing the returned `that` mark
+
+By default, we don't capture the `that` mark returned by a command, unless the test is being recorded in the `actions/` directory of the recorded tests. If you'd like to capture the returned `that` mark when recording a test somewhere else, you can say `"cursorless record that mark"`.
+
+#### Testing the hat map
+
+We have a way to test that the hats in the hat map update correctly during the course of a single phrase. These tests are also how we usually test our [range updating code](../api/modules/core_updateSelections_updateSelections).
+
+Any tests recorded in the `hatTokenMap` directory will automatically be treated as hat token map tests. To initiate a series of hat token map tests in another directory, say `"cursorless record navigation"`.
+
+Then each time you record a test, you need to issue two commands. The second command should be of the form `"take air"` (or another decorated mark), and will tell the test case recorder which decorated mark you're checking.
+
+### Default config per test case directory
+
+Any test case directory that contains a `config.json` will set default configuration for all tests recorded in any descendant directory. For example, the file [`actions/config.json`](../../src/test/suite/fixtures/recorded/actions/config.json) makes it so that all our action tests will capture the final `that` mark. For a full list of keys supported in this json, see [the api docs](../api/interfaces/testutil_testcaserecorder.internal.recordtestcasecommandarg/).
+
 ### Navigation map tests
 
 If you want to check how the navigation map gets updated in response to changes, you can instead say "cursorless record navigation", and then you need to issue two commands in one phrase each time. The second command should be of the form "take air" (or another decorated mark), and will tell the test case recorder which decorated mark we're checking.