Add support for 'all' modifier for items within a collection

cursorless-talon/src/modifiers/containing_scope.py

@@ -1,9 +1,9 @@
 from typing import Any
-from talon import Module, app
+from talon import Module, Context, app
 from ..csv_overrides import init_csv_and_watch_changes
 
 mod = Module()
-
+ctx = Context()
 
 mod.list("cursorless_scope_type", desc="Supported scope types")
 
@@ -46,17 +46,29 @@
     "end tag": "xmlEndTag",
 }
 
+mod.list("select_multiple_modifiers", desc="modifiers for multiple selections")
+multiple_modifiers = {"every", "all"}
+ctx.lists["user.select_multiple_modifiers"] = multiple_modifiers
+
 
-@mod.capture(rule="[every] {user.cursorless_scope_type}")
+@mod.capture(rule="[{user.select_multiple_modifiers}] {user.cursorless_scope_type}")
 def cursorless_containing_scope(m) -> dict[str, dict[str, Any]]:
-    """Expand to containing scope"""
-    return {
-        "modifier": {
-            "type": "containingScope",
-            "scopeType": m.cursorless_scope_type,
-            "includeSiblings": m[0] == "every",
+    """Expand to every scope"""
+    if m[0] in multiple_modifiers:
+        return {
+            "modifier": {
+                "type": "everyScope",
+                "scopeType": m.cursorless_scope_type,
+                "contiguousRange": m[0] == "all" and m[1] == "collectionItem",
+            }
+        }
+    else:
+        return {
+            "modifier": {
+                "type": "containingScope",
+                "scopeType": m.cursorless_scope_type,
+            }
         }
-    }
 
 
 # NOTE: Please do not change these dicts.  Use the CSVs for customization.

docs/user/README.md

@@ -27,6 +27,7 @@ Note: If you'd like to customize any of the spoken forms, please see the [docume
     - [Modifiers](#modifiers)
       - [Syntactic scopes](#syntactic-scopes)
       - [`"every"`](#every)
+      - [`"all"`](#all)
       - [Sub-token modifiers](#sub-token-modifiers)
         - [`"word"`](#word)
         - [`"char"`](#char)
@@ -200,6 +201,13 @@ The command `"every"` can be used to select a syntactic element and all of its m
 
 For example, the command `take every key [blue] air` will select every key in the map/object/dict including the token with a blue hat over the letter 'a'.
 
+##### `"all"`
+
+The command `"all"` can be used to select items within a collection and return a single selection. This differs `"every"` in that is can only be used on collection items, not keys or values, as it returns a single selection.
+
+- `"take all item air"`
+- `"take all item"` (if cursor is currently within a key)
+
 ##### Sub-token modifiers
 
 ###### `"word"`

src/actions/WrapWithSnippet.ts

@@ -42,8 +42,7 @@ export default class WrapWithSnippet implements Action {
             ? undefined
             : {
                 type: "containingScope",
-                scopeType: defaultScopeType,
-                includeSiblings: false,
+                scopeType: defaultScopeType
               },
       },
     ];

src/languages/getNodeMatcher.ts

@@ -23,11 +23,12 @@ import go from "./go";
 import { patternMatchers as ruby } from "./ruby";
 import { UnsupportedLanguageError } from "../errors";
 import { SupportedLanguageId } from "./constants";
+import { Selection } from "vscode";
+
 
 export function getNodeMatcher(
   languageId: string,
   scopeType: ScopeType,
-  includeSiblings: boolean
 ): NodeMatcher {
   const matchers = languageMatchers[languageId as SupportedLanguageId];
 
@@ -41,13 +42,47 @@ export function getNodeMatcher(
     return notSupported;
   }
 
-  if (includeSiblings) {
-    return matcherIncludeSiblings(matcher);
-  }
-
   return matcher;
 }
 
+export function getNodeMatcherWithSiblings(
+  languageId: string,
+  scopeType: ScopeType,
+  contiguousRange: boolean
+): NodeMatcher {
+  return (
+    selection: SelectionWithEditor,
+    node: SyntaxNode
+  ): NodeMatcherValue[] | null => {
+
+    const matcher = getNodeMatcher(languageId, scopeType);
+    let matches = matcher(selection, node);
+    if (matches == null) {
+      return null;
+    }
+    matches = matches.flatMap((match) =>
+      iterateNearestIterableAncestor(
+        match.node,
+        selectionWithEditorFromRange(selection, match.selection.selection),
+        matcher
+      )
+    ) as NodeMatcherValue[];
+    if (matches.length > 0) {
+      if (matches.length >= 2 && contiguousRange) {
+        const start = matches[0].selection.selection;
+        const end = matches[matches.length - 1].selection.selection;
+
+        matches[0].selection.selection = start.union(end) as Selection;
+
+        return [matches[0]] as NodeMatcherValue[];
+      } else {
+        return matches;
+      }
+    }
+    return null;
+  };
+}
+
 const languageMatchers: Record<
   SupportedLanguageId,
   Record<ScopeType, NodeMatcher>
@@ -75,29 +110,6 @@ const languageMatchers: Record<
   xml: html,
 };
 
-function matcherIncludeSiblings(matcher: NodeMatcher): NodeMatcher {
-  return (
-    selection: SelectionWithEditor,
-    node: SyntaxNode
-  ): NodeMatcherValue[] | null => {
-    let matches = matcher(selection, node);
-    if (matches == null) {
-      return null;
-    }
-    matches = matches.flatMap((match) =>
-      iterateNearestIterableAncestor(
-        match.node,
-        selectionWithEditorFromRange(selection, match.selection.selection),
-        matcher
-      )
-    ) as NodeMatcherValue[];
-    if (matches.length > 0) {
-      return matches;
-    }
-    return null;
-  };
-}
-
 function iterateNearestIterableAncestor(
   node: SyntaxNode,
   selection: SelectionWithEditor,
@@ -115,3 +127,4 @@ function iterateNearestIterableAncestor(
   }
   return [];
 }
+

src/languages/getTextFragmentExtractor.ts

@@ -22,7 +22,7 @@ function constructDefaultTextFragmentExtractor(
   languageId: SupportedLanguageId,
   stringTextFragmentExtractor?: TextFragmentExtractor
 ): TextFragmentExtractor {
-  const commentNodeMatcher = getNodeMatcher(languageId, "comment", false);
+  const commentNodeMatcher = getNodeMatcher(languageId, "comment");
   stringTextFragmentExtractor =
     stringTextFragmentExtractor ??
     constructDefaultStringTextFragmentExtractor(languageId);
@@ -54,7 +54,7 @@ function constructDefaultTextFragmentExtractor(
 function constructDefaultStringTextFragmentExtractor(
   languageId: SupportedLanguageId
 ): TextFragmentExtractor {
-  const stringNodeMatcher = getNodeMatcher(languageId, "string", false);
+  const stringNodeMatcher = getNodeMatcher(languageId, "string");
 
   return (node: SyntaxNode, selection: SelectionWithEditor) => {
     if (stringNodeMatcher(selection, node) != null) {
@@ -82,7 +82,7 @@ function constructDefaultStringTextFragmentExtractor(
 function constructHackedStringTextFragmentExtractor(
   languageId: SupportedLanguageId
 ) {
-  const stringNodeMatcher = getNodeMatcher(languageId, "string", false);
+  const stringNodeMatcher = getNodeMatcher(languageId, "string");
 
   return (node: SyntaxNode, selection: SelectionWithEditor) => {
     if (stringNodeMatcher(selection, node) != null) {

src/processTargets/modifiers/processModifier.ts

@@ -6,6 +6,7 @@ import { SUBWORD_MATCHER } from "../../core/constants";
 import { selectionWithEditorFromRange } from "../../util/selectionUtils";
 import {
   ContainingScopeModifier,
+  EveryScopeModifier,
   HeadModifier,
   NodeMatcher,
   PrimitiveTarget,
@@ -16,7 +17,7 @@ import {
   TailModifier,
 } from "../../typings/Types";
 import { processSurroundingPair } from "./surroundingPair";
-import { getNodeMatcher } from "../../languages/getNodeMatcher";
+import { getNodeMatcher, getNodeMatcherWithSiblings } from "../../languages/getNodeMatcher";
 
 export type SelectionWithEditorWithContext = {
   selection: SelectionWithEditor;
@@ -45,6 +46,7 @@ export default function (
       result = [{ selection, context: {} }];
       break;
 
+    case "everyScope":
     case "containingScope":
       result = processScopeType(context, selection, modifier);
       break;
@@ -81,13 +83,22 @@ export default function (
 function processScopeType(
   context: ProcessedTargetsContext,
   selection: SelectionWithEditor,
-  modifier: ContainingScopeModifier
+  modifier: ContainingScopeModifier | EveryScopeModifier,
 ): SelectionWithEditorWithContext[] | null {
-  const nodeMatcher = getNodeMatcher(
-    selection.editor.document.languageId,
-    modifier.scopeType,
-    modifier.includeSiblings ?? false
-  );
+  let nodeMatcher; 
+  if ("contiguousRange" in modifier) {
+    nodeMatcher = getNodeMatcherWithSiblings(
+      selection.editor.document.languageId,
+      modifier.scopeType,
+      modifier.contiguousRange
+    );
+  } else {
+    nodeMatcher = getNodeMatcher(
+      selection.editor.document.languageId,
+      modifier.scopeType
+    );
+  }
+
   const node: SyntaxNode | null = context.getNodeAtLocation(
     new Location(selection.editor.document.uri, selection.selection)
   );

src/test/suite/fixtures/recorded/actions/chuckEveryArgMade.yml

@@ -5,7 +5,7 @@ command:
   action: remove
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}
       mark: {type: decoratedSymbol, symbolColor: default, character: m}
 initialState:
   documentContents: "function myFunk(value: string, name: string, age: number) { };"
@@ -24,4 +24,4 @@ finalState:
   thatMark:
     - anchor: {line: 0, character: 16}
       active: {line: 0, character: 16}
-fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: outside, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}, isImplicit: false}]
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: outside, modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}, isImplicit: false}]

src/test/suite/fixtures/recorded/actions/cutEveryArgMade.yml

@@ -5,7 +5,7 @@ command:
   action: cutToClipboard
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}
       mark: {type: decoratedSymbol, symbolColor: default, character: m}
 initialState:
   documentContents: "function myFunk(value: string, name: string, age: number) { };"
@@ -24,4 +24,4 @@ finalState:
   thatMark:
     - anchor: {line: 0, character: 16}
       active: {line: 0, character: 16}
-fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}, isImplicit: false}]
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}, isImplicit: false}]

src/test/suite/fixtures/recorded/actions/moveEveryArgMade.yml

@@ -5,7 +5,7 @@ command:
   action: moveToTarget
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}
       mark: {type: decoratedSymbol, symbolColor: default, character: m}
     - {type: primitive, isImplicit: true}
 initialState:
@@ -31,4 +31,4 @@ finalState:
   sourceMark:
     - anchor: {line: 0, character: 16}
       active: {line: 0, character: 16}
-fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}, isImplicit: false}, {type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: true}]
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}, isImplicit: false}, {type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: true}]

src/test/suite/fixtures/recorded/languages/clojure/clearEveryItem.yml

@@ -5,7 +5,7 @@ command:
   action: clearAndSetSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}
 initialState:
   documentContents: |-
 
@@ -36,4 +36,4 @@ finalState:
       active: {line: 2, character: 4}
     - anchor: {line: 4, character: 4}
       active: {line: 4, character: 4}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}}]

src/test/suite/fixtures/recorded/languages/clojure/clearEveryKey.yml

@@ -5,7 +5,7 @@ command:
   action: clearAndSetSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: collectionKey, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: collectionKey, contiguousRange: false}
 initialState:
   documentContents: |-
 
@@ -36,4 +36,4 @@ finalState:
       active: {line: 2, character: 4}
     - anchor: {line: 4, character: 4}
       active: {line: 4, character: 4}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: containingScope, scopeType: collectionKey, includeSiblings: true}}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: everyScope, scopeType: collectionKey, contiguousRange: false}}]

src/test/suite/fixtures/recorded/languages/clojure/clearEveryValue.yml

@@ -5,7 +5,7 @@ command:
   action: clearAndSetSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: value, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: value, contiguousRange: false}
 initialState:
   documentContents: |-
 
@@ -36,4 +36,4 @@ finalState:
       active: {line: 2, character: 9}
     - anchor: {line: 4, character: 9}
       active: {line: 4, character: 9}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: containingScope, scopeType: value, includeSiblings: true}}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: everyScope, scopeType: value, contiguousRange: false}}]

src/test/suite/fixtures/recorded/languages/cpp/takeEveryArg.yml

@@ -5,7 +5,7 @@ command:
   action: setSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}
 initialState:
   documentContents: |-
     int f(int a, int b) {
@@ -30,4 +30,4 @@ finalState:
       active: {line: 1, character: 14}
     - anchor: {line: 1, character: 16}
       active: {line: 1, character: 17}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: true}, insideOutsideType: inside}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, modifier: {type: everyScope, scopeType: argumentOrParameter, contiguousRange: false}, insideOutsideType: inside}]

src/test/suite/fixtures/recorded/languages/cpp/takeEveryItem.yml

@@ -5,7 +5,7 @@ command:
   action: setSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}
 initialState:
   documentContents: |-
     int f(int a, int b) {
@@ -30,4 +30,4 @@ finalState:
       active: {line: 1, character: 26}
     - anchor: {line: 1, character: 28}
       active: {line: 1, character: 29}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}, insideOutsideType: inside}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}, insideOutsideType: inside}]

src/test/suite/fixtures/recorded/languages/go/takeEveryItem.yml

@@ -5,7 +5,7 @@ command:
   action: setSelection
   targets:
     - type: primitive
-      modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}
+      modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}
 initialState:
   documentContents: "map[string]string{\"air\": \"bat\", \"cap\": \"drum\"}"
   selections:
@@ -24,4 +24,4 @@ finalState:
       active: {line: 0, character: 30}
     - anchor: {line: 0, character: 32}
       active: {line: 0, character: 45}
-fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: containingScope, scopeType: collectionItem, includeSiblings: true}}]
+fullTargets: [{type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: inside, modifier: {type: everyScope, scopeType: collectionItem, contiguousRange: false}}]