Merge remote-tracking branch 'origin/main' into unused-imports

Author: phillco

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,3 +2,4 @@
 
 - [ ] 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

cursorless-talon/src/apps/vscode_settings.py

@@ -58,49 +58,50 @@ def vscode_get_setting_with_fallback(
         """
         try:
             return actions.user.vscode_get_setting(key, default_value), False
-        except Exception as e:
+        except Exception:
             print(fallback_message)
             traceback.print_exc()
             return fallback_value, True
 
 
-def pick_path(paths: list[Path]):
+def pick_path(paths: list[Path]) -> Path:
     existing_paths = [path for path in paths if path.exists()]
     return max(existing_paths, key=lambda path: path.stat().st_mtime)
 
 
 @mac_ctx.action_class("user")
 class MacUserActions:
     def vscode_settings_path() -> Path:
+        application_support = Path.home() / "Library/Application Support"
         return pick_path(
             [
-                Path(
-                    f"{os.environ['HOME']}/Library/Application Support/Code/User/settings.json"
-                ),
-                Path(
-                    f"{os.environ['HOME']}/Library/Application Support/VSCodium/User/settings.json"
-                ),
+                application_support / "Code/User/settings.json",
+                application_support / "VSCodium/User/settings.json",
             ]
         )
 
 
 @linux_ctx.action_class("user")
 class LinuxUserActions:
     def vscode_settings_path() -> Path:
+        xdg_config_home = Path(
+            os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config")
+        )
         return pick_path(
             [
-                Path(f"{os.environ['HOME']}/.config/Code/User/settings.json"),
-                Path(f"{os.environ['HOME']}/.config/VSCodium/User/settings.json"),
+                xdg_config_home / "Code/User/settings.json",
+                xdg_config_home / "VSCodium/User/settings.json",
             ]
         )
 
 
 @windows_ctx.action_class("user")
 class WindowsUserActions:
     def vscode_settings_path() -> Path:
+        appdata = Path(os.environ["APPDATA"])
         return pick_path(
             [
-                Path(f"{os.environ['APPDATA']}/Code/User/settings.json"),
-                Path(f"{os.environ['APPDATA']}/VSCodium/User/settings.json"),
+                appdata / "Code/User/settings.json",
+                appdata / "VSCodium/User/settings.json",
             ]
         )

cursorless-talon/src/cheatsheet/sections/modifiers.py

@@ -8,7 +8,7 @@
     "first_modifier",
     "last_modifier",
     "previous_next_modifier",
-    "backward_modifier",
+    "forward_backward_modifier",
 ]
 
 

cursorless-talon/src/modifiers/modifiers.py

@@ -5,7 +5,7 @@
 from .interior import interior_modifiers
 from .ordinal_scope import first_modifiers, last_modifiers
 from .range_type import range_types
-from .relative_scope import backward_modifiers, previous_next_modifiers
+from .relative_scope import forward_backward_modifiers, previous_next_modifiers
 from .simple_scope_modifier import simple_scope_modifiers
 
 mod = Module()
@@ -81,7 +81,7 @@ def on_ready():
             "first_modifier": first_modifiers,
             "last_modifier": last_modifiers,
             "previous_next_modifier": previous_next_modifiers,
-            "backward_modifier": backward_modifiers,
+            "forward_backward_modifier": forward_backward_modifiers,
         },
     )
 

cursorless-talon/src/modifiers/relative_scope.py

@@ -3,12 +3,17 @@
 from talon import Module
 
 previous_next_modifiers = {"previous": "previous", "next": "next"}
-backward_modifiers = {"backward": "backward"}
+forward_backward_modifiers = {
+    "forward": "forward",
+    "backward": "backward",
+}
 
 mod = Module()
 
 mod.list("cursorless_previous_next_modifier", desc="Cursorless previous/next modifiers")
-mod.list("cursorless_backward_modifier", desc="Cursorless backward modifiers")
+mod.list(
+    "cursorless_forward_backward_modifier", desc="Cursorless forward/backward modifiers"
+)
 
 
 @mod.capture(rule="{user.cursorless_previous_next_modifier}")
@@ -44,26 +49,28 @@ def cursorless_relative_scope_plural(m) -> dict[str, Any]:
 
 
 @mod.capture(
-    rule="<user.private_cursorless_number_small> <user.cursorless_scope_type_plural> [{user.cursorless_backward_modifier}]"
+    rule="<user.private_cursorless_number_small> <user.cursorless_scope_type_plural> [{user.cursorless_forward_backward_modifier}]"
 )
 def cursorless_relative_scope_count(m) -> dict[str, Any]:
     """Relative count scope. `three funks`"""
     return create_relative_scope_modifier(
         m.cursorless_scope_type_plural,
         0,
         m.private_cursorless_number_small,
-        getattr(m, "cursorless_backward_modifier", "forward"),
+        getattr(m, "cursorless_forward_backward_modifier", "forward"),
     )
 
 
-@mod.capture(rule="<user.cursorless_scope_type> {user.cursorless_backward_modifier}")
+@mod.capture(
+    rule="<user.cursorless_scope_type> {user.cursorless_forward_backward_modifier}"
+)
 def cursorless_relative_scope_one_backward(m) -> dict[str, Any]:
     """Take scope backward, eg `funk backward`"""
     return create_relative_scope_modifier(
         m.cursorless_scope_type,
         0,
         1,
-        m.cursorless_backward_modifier,
+        m.cursorless_forward_backward_modifier,
     )
 
 

docs/user/customization.md

@@ -75,6 +75,20 @@ While the hats are hidden, you will not be able to address any marks, eg `"take
 
 If you'd like to map a voice command to toggle the hats, have a look at https://youtu.be/oWUJyDgz63k
 
+## Updating word separators
+
+The word separators are characters that defines the boundary between words in a identifier. eg `hello_world` is an identifier with two words separated by `_`. If you like to support other separators like `-` in `hello-world` that can be accomplished by changing the `cursorless.wordSeparators` setting. This setting is also language overridable.
+
+```json
+// Sets the word separator for all languages
+"cursorless.wordSeparators": ["_"]
+
+// Sets the word separator for css only
+"[css]": {
+  "cursorless.wordSeparators": ["_", "-"]
+}
+```
+
 ## Cursorless public API
 
 Cursorless exposes a couple talon actions and captures that you can use to define your own custom command grammar leveraging cursorless targets.

package.json

@@ -207,6 +207,18 @@
 					"description": "How much to vertically shift the hats as a percentage of font size; positive is up",
 					"order": 1
 				},
+				"cursorless.wordSeparators": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"default": [
+						"_"
+					],
+					"scope": "language-overridable",
+					"markdownDescription": "A list of characters that separate words in identifiers. For example `_` splits `hello_world` into two words.",
+					"order": 6
+				},
 				"cursorless.colors.dark": {
 					"description": "Colors to use for dark theme",
 					"type": "object",
@@ -602,6 +614,7 @@
 		"@types/lodash": "^4.14.168",
 		"immer": "^9.0.15",
 		"immutability-helper": "^3.1.1",
+		"itertools": "^1.7.1",
 		"lodash": "^4.17.21",
 		"node-html-parser": "^5.3.3"
 	}

src/core/Decorations.ts

@@ -55,6 +55,7 @@ export default class Decorations {
         },
       ),
 
+      // Don't use fine grained settings here until tokenizer has migrated to graph
       vscode.workspace.onDidChangeConfiguration(this.recomputeDecorationStyles),
     );
   }

src/core/commandRunner/CommandRunner.ts

@@ -177,7 +177,9 @@ export default class CommandRunner {
       console.error(err.stack);
       throw err;
     } finally {
-      this.graph.testCaseRecorder.finallyHook();
+      if (this.graph.testCaseRecorder.isActive()) {
+        this.graph.testCaseRecorder.finallyHook();
+      }
     }
   }