Merge branch 'pokey/issue69-Support-fully-compositional-modifiers' into textTheBasedItemScope

Author: AndreasArvidsson

.vscode/launch.json

@@ -41,6 +41,27 @@
 				"!**/node_modules/**"
 			]
 		},
+		{
+			"name": "Run Single Extension Test",
+			"type": "extensionHost",
+			"request": "launch",
+			"env": {
+				"CURSORLESS_TEST": "true",
+				"CURSORLESS_RUN_SINGLE_TEST": "true"
+			},
+			"args": [
+				"--extensions-dir=${workspaceFolder}/.vscode-sandbox/extensions",
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"preLaunchTask": "${defaultBuildTask}",
+			"resolveSourceMapLocations": [
+				"${workspaceFolder}/**",
+				"!${workspaceFolder}/.vscode-sandbox/**",
+				"!**/node_modules/**"
+			]
+		},
 		{
 			"name": "Update fixtures",
 			"type": "extensionHost",

cursorless-talon/src/actions/actions_makeshift.py

@@ -39,7 +39,7 @@ class MakeshiftAction:
         "editor.action.rename",
         restore_selection=True,
         await_command=False,
-        post_command_sleep_ms=150,
+        post_command_sleep_ms=200,
     ),
 ]
 

cursorless-talon/src/csv_overrides.py

@@ -159,6 +159,14 @@ def update_dicts(
         key = obj["key"]
         if not is_removed(key):
             for k in key.split("|"):
+                if value == "pasteFromClipboard" and k.endswith(" to"):
+                    # FIXME: This is a hack to work around the fact that the
+                    # spoken form of the `pasteFromClipboard` action used to be
+                    # "paste to", but now the spoken form is just "paste" and
+                    # the "to" is part of the positional target. Users who had
+                    # cursorless before this change would have "paste to" as
+                    # their spoken form and so would need to say "paste to to".
+                    k = k[:-3]
                 results[obj["list"]][k.strip()] = value
 
     # Assign result to talon context list

cursorless-talon/src/positional_target.py

@@ -7,15 +7,14 @@
 
 mod.list(
     "cursorless_positional_connective",
-    desc="The connective used to separate source and destination targets",
+    desc='Connectives used to separate source and destination targets that indicate position, eg "before" or "after"',
 )
 
 positional_connectives = {
     **POSITION_BEFORE,
     **POSITION_AFTER,
 }
 
-print(positional_connectives)
 ctx.lists["self.cursorless_positional_connective"] = positional_connectives.keys()
 
 

docs/contributing/CONTRIBUTING.md

@@ -34,6 +34,10 @@ locally, you need to run the extension in debug mode. To do so you need to run
 the `workbench.action.debug.selectandstart` command in VSCode and then select either "Run
 Extension" or "Extension Tests".
 
+### Running a single test
+
+The entire test suite takes a little while to run (1-2 mins), so if you'd like to repeat a single test, you can edit [`runSingleRecordedTest`](../../src/test/suite/runSingleRecordedTest.ts) to refer to the desired test and use the "Run Single Extension Test" launch config instead of the usual "Extension Tests".
+
 ## Code formatting
 
 We use [`pre-commit`](https://pre-commit.com/) to automate autoformatting.

docs/contributing/parse-tree-patterns.md

@@ -6,15 +6,16 @@ We have a small domain-specific language that we use to define patterns to look
 
 `GRAND_PARENT_TYPE.*.CHILD_TYPE[FIELD]!?`
 
-| Syntax              | Description                                                                                                                       |
-| ------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| TYPE                | Match node type<br/>`node.type`                                                                                                   |
-| Dot operator(`.`)   | Type hierarchy between parent and child                                                                                           |
-| Wildcard op(`*`)    | Match any type                                                                                                                    |
-| Negation op(`~`)    | Match any type other than what is specified after `~`                                                                             |
-| Important op(`!`)   | Use this node as result instead of parent.<br/>By default the leftmost/top node is used                                           |
-| Optional op(`?`)    | Node is optional. Will match if available.                                                                                        |
-| Field op(`[field]`) | Get child field node for resulting node.<br/>Only evaluated on the resulting node at the end.<br/>`node.childForFieldName(field)` |
+| Syntax              | Description                                                                             |
+| ------------------- | --------------------------------------------------------------------------------------- |
+| TYPE                | Match node type<br/>`node.type`                                                         |
+| Dot operator(`.`)   | Type hierarchy between parent and child                                                 |
+| Wildcard op(`*`)    | Match any type                                                                          |
+| Negation op(`~`)    | Match any type other than what is specified after `~`                                   |
+| Important op(`!`)   | Use this node as result instead of parent.<br/>By default the leftmost/top node is used |
+| Optional op(`?`)    | Node is optional. Will match if available.                                              |
+| Field op(`[field]`) | Return child node at given field.<br/>`node.childForFieldName(field)`                   |
+| Index op(`[n]`)     | Return nth named child node.                                                            |
 
 ## Multiple patterns
 

docs/user/README.md

@@ -64,7 +64,7 @@ The following colors are supported. Note that to target the default (gray) hat y
 | `"navy"`    | navy    | `userColor1` | ❌                  |
 | `"apricot"` | apricot | `userColor2` | ❌                  |
 
-You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above.
+You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
 
 You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes.
 
@@ -93,7 +93,7 @@ The following shapes are supported. Note that to target the default (dot) shape
 | `"cross"`   | ![Crosshairs](../../images/hats/crosshairs.svg) | `crosshairs` | ❌                  |
 | `"bolt"`    | ![Bolt](../../images/hats/bolt.svg)             | `bolt`       | ❌                  |
 
-You can enable or disable shapes in your VSCode settings, by searching for `cursorless.hatEnablement.shapes` and checking the box next to the internal ID for the given shape as listed above.
+You can enable or disable shapes in your VSCode settings, by searching for `cursorless.hatEnablement.shapes` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
 
 If you find these shape names unintuitive / tough to remember, their
 spoken forms can be [customized](customization.md) like any other spoken form

src/actions/BringMoveSwap.ts

@@ -99,7 +99,9 @@ class BringMoveSwap implements Action {
           text = sources
             .map((source, i) => {
               const text = source.contentText;
-              const delimiter = destination.delimiter ?? source.delimiter;
+              const delimiter =
+                (destination.isRaw ? null : destination.insertionDelimiter) ??
+                (source.isRaw ? null : source.insertionDelimiter);
               return i > 0 && delimiter != null ? delimiter + text : text;
             })
             .join("");

src/actions/Clear.ts

@@ -1,4 +1,4 @@
-import { toRawTarget } from "../processTargets/modifiers/RawSelectionStage";
+import PlainTarget from "../processTargets/targets/PlainTarget";
 import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Types";
 import { setSelectionsAndFocusEditor } from "../util/setSelectionsAndFocusEditor";
@@ -12,9 +12,16 @@ export default class Clear implements Action {
 
   async run([targets]: [Target[]]): Promise<ActionReturnValue> {
     const editor = ensureSingleEditor(targets);
-    const rawTargets = targets.map(toRawTarget);
+    const plainTargets = targets.map(
+      (target) =>
+        new PlainTarget({
+          editor: target.editor,
+          isReversed: target.isReversed,
+          contentRange: target.contentRange,
+        })
+    );
 
-    const { thatMark } = await this.graph.actions.remove.run([rawTargets]);
+    const { thatMark } = await this.graph.actions.remove.run([plainTargets]);
 
     if (thatMark != null) {
       await setSelectionsAndFocusEditor(

src/actions/CutCopyPaste.ts

@@ -1,4 +1,4 @@
-import RawSelectionTarget from "../processTargets/targets/RawSelectionTarget";
+import PlainTarget from "../processTargets/targets/PlainTarget";
 import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Types";
 import { getOutsideOverflow } from "../util/targetUtils";
@@ -19,10 +19,10 @@ export class Cut implements Action {
       return getOutsideOverflow(target.editor, target.contentRange, range).map(
         (overflow): Target =>
           // TODO Instead of creating a new target display decorations by range
-          new RawSelectionTarget({
+          new PlainTarget({
             editor: target.editor,
             contentRange: overflow,
-            isReversed: false,
+            isReversed: target.isReversed,
           })
       );
     });