Merge branch 'main' into contiguous_scope

Author: AndreasArvidsson

.eslintrc.json

@@ -11,7 +11,13 @@
     "ecmaVersion": 6,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "unused-imports", "import", "unicorn"],
+  "plugins": [
+    "@typescript-eslint",
+    "unused-imports",
+    "import",
+    "unicorn",
+    "mocha"
+  ],
   "rules": {
     "import/no-relative-packages": "error",
     "@typescript-eslint/consistent-type-assertions": [
@@ -53,7 +59,9 @@
     ],
     "no-throw-literal": "warn",
     "semi": "off",
-    "unicorn/prefer-module": "error"
+    "unicorn/prefer-module": "error",
+    "mocha/no-skipped-tests": "error",
+    "mocha/no-exclusive-tests": "error"
   },
   "overrides": [
     {

changelog/2023-12-addedBreakLineAction.md

@@ -0,0 +1,6 @@
+---
+tags: [enhancement]
+pullRequest: 2103
+---
+
+- Added `break` action. This action will break a line in two. eg `"break air"`

changelog/2023-12-addedVisibleModifier.md

@@ -0,0 +1,6 @@
+---
+tags: [enhancement]
+pullRequest: 2094
+---
+
+- Added `visible` modifier. This modifier returns all visible ranges. In most cases this will just be a single range starting from the first visible line and ending at the last visible line. If there are visible folded regions these break the visible range into po multiple ranges.

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

@@ -1,12 +1,25 @@
-from ..get_list import get_lists
+from ..get_list import get_lists, get_raw_list
 
 
 def get_scopes():
-    return get_lists(
-        ["scope_type"],
-        "scopeType",
+    complex_scopes = get_raw_list("glyph_scope_type")
+    return [
+        *get_lists(
+            ["scope_type"],
+            "scopeType",
+            {
+                "argumentOrParameter": "Argument",
+                "boundedNonWhitespaceSequence": "Non whitespace sequence stopped by surrounding pair delimeters",
+            },
+        ),
         {
-            "argumentOrParameter": "Argument",
-            "boundedNonWhitespaceSequence": "Non whitespace sequence stopped by surrounding pair delimeters",
+            "id": "glyph",
+            "type": "scopeType",
+            "variations": [
+                {
+                    "spokenForm": f"{complex_scopes['glyph']} <character>",
+                    "description": "Instance of single character <character>",
+                },
+            ],
         },
-    )
+    ]

cursorless-talon/src/modifiers/glyph_scope.py

@@ -0,0 +1,30 @@
+from talon import Module
+
+mod = Module()
+
+mod.list(
+    "cursorless_glyph_scope_type",
+    desc="Cursorless glyph scope type",
+)
+mod.list(
+    "cursorless_glyph_scope_type_plural",
+    desc="Plural version of Cursorless glyph scope type",
+)
+
+
+@mod.capture(rule="{user.cursorless_glyph_scope_type} <user.any_alphanumeric_key>")
+def cursorless_glyph_scope_type(m) -> dict[str, str]:
+    return {
+        "type": "glyph",
+        "character": m.any_alphanumeric_key,
+    }
+
+
+@mod.capture(
+    rule="{user.cursorless_glyph_scope_type_plural} <user.any_alphanumeric_key>"
+)
+def cursorless_glyph_scope_type_plural(m) -> dict[str, str]:
+    return {
+        "type": "glyph",
+        "character": m.any_alphanumeric_key,
+    }

cursorless-talon/src/spoken_forms.json

@@ -3,6 +3,7 @@
   "actions.csv": {
     "simple_action": {
       "bottom": "scrollToBottom",
+      "break": "breakLine",
       "break point": "toggleLineBreakpoint",
       "carve": "cutToClipboard",
       "center": "scrollToCenter",
@@ -170,6 +171,9 @@
     },
     "surrounding_pair_scope_type": {
       "string": "string"
+    },
+    "glyph_scope_type": {
+      "glyph": "glyph"
     }
   },
   "paired_delimiters.csv": {

cursorless-talon/src/spoken_forms.py

@@ -68,6 +68,7 @@ def ret(filename: str, *args: P.args, **kwargs: P.kwargs) -> R:
     "wrapper_only_paired_delimiter": "pairedDelimiter",
     "surrounding_pair_scope_type": "pairedDelimiter",
     "scope_type": "simpleScopeTypeType",
+    "glyph_scope_type": "complexScopeTypeType",
     "custom_regex_scope_type": "customRegex",
 }
 
@@ -125,7 +126,7 @@ def handle_new_values(csv_name: str, values: list[SpokenFormEntry]):
         handle_csv("experimental/miscellaneous.csv"),
         handle_csv(
             "modifier_scope_types.csv",
-            pluralize_lists=["scope_type"],
+            pluralize_lists=["scope_type", "glyph_scope_type"],
             extra_allowed_values=[
                 "private.fieldAccess",
                 "private.switchStatementSubject",

docs/user/README.md

@@ -8,7 +8,7 @@ Welcome to Cursorless! You may find it helpful to start with the [tutorial video
 
 This guide assumes you've already [installed Cursorless](installation.md).
 
-Once you understand the concepts, you can pull up a cheatsheet for reference using either `"cursorless reference"` or `"cursorless cheatsheet"` commands within VSCode.
+Once you understand the concepts, you can pull up a cheatsheet for reference by saying either `"cursorless reference"` or `"cursorless cheatsheet"` with VSCode focused.
 
 You can get back to these docs by saying `"cursorless docs"`, `"cursorless help"` within VSCode.
 
@@ -717,6 +717,16 @@ eg:
 - `join air`: Join the line with the token containing the letter 'a' with its next line.
 - `join block air`: Joines all lines in the paragraph with the token containing the letter 'a' together into a single line.
 
+### Break
+
+Break line in two.
+
+- `"break <TARGET>"`
+
+eg:
+
+- `break air`: Break the line with the token containing the letter 'a'. 'a' is now the first token on the new line.
+
 ## Paired delimiters
 
 | Default spoken form | Delimiter name        | Symbol inserted before target | Symbol inserted after target | Is wrapper? | Is selectable? |

package.json

@@ -36,6 +36,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "3.5.5",
     "eslint-plugin-import": "2.28.1",
+    "eslint-plugin-mocha": "10.2.0",
     "eslint-plugin-unicorn": "49.0.0",
     "eslint-plugin-unused-imports": "^3.0.0",
     "prettier": "3.0.3",
@@ -61,6 +62,6 @@
   "engines": {
     "node": ">=18.18.2"
   },
-  "packageManager": "pnpm@8.6.12",
+  "packageManager": "pnpm@8.12.0",
   "type": "module"
 }

packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json

@@ -14,6 +14,16 @@
             }
           ]
         },
+        {
+          "id": "breakLine",
+          "type": "action",
+          "variations": [
+            {
+              "spokenForm": "break <target>",
+              "description": "Break line"
+            }
+          ]
+        },
         {
           "id": "callAsFunction",
           "type": "action",
@@ -228,6 +238,16 @@
             }
           ]
         },
+        {
+          "id": "joinLines",
+          "type": "action",
+          "variations": [
+            {
+              "spokenForm": "join <target>",
+              "description": "Join lines"
+            }
+          ]
+        },
         {
           "id": "moveToTarget",
           "type": "action",
@@ -905,6 +925,16 @@
               "description": "Trailing delimiter range"
             }
           ]
+        },
+        {
+          "id": "visible",
+          "type": "modifier",
+          "variations": [
+            {
+              "spokenForm": "visible",
+              "description": "Visible"
+            }
+          ]
         }
       ]
     },
@@ -1058,6 +1088,16 @@
             }
           ]
         },
+        {
+          "id": "show_scope_sidebar",
+          "type": "command",
+          "variations": [
+            {
+              "spokenForm": "bar cursorless",
+              "description": "Show cursorless sidebar"
+            }
+          ]
+        },
         {
           "id": "show_scope_visualizer",
           "type": "command",
@@ -1272,6 +1312,16 @@
             }
           ]
         },
+        {
+          "id": "glyph",
+          "type": "scopeType",
+          "variations": [
+            {
+              "spokenForm": "glyph <character>",
+              "description": "Instance of single character <character>"
+            }
+          ]
+        },
         {
           "id": "identifier",
           "type": "scopeType",
@@ -1537,7 +1587,7 @@
           "type": "scopeType",
           "variations": [
             {
-              "spokenForm": "word",
+              "spokenForm": "sub",
               "description": "Word"
             }
           ]