Migrate collection item and argument scopes

packages/cursorless-engine/src/languages/TreeSitterQuery/QueryCapture.ts

@@ -38,6 +38,9 @@ export interface QueryCapture {
 
   /** The insertion delimiter to use if any */
   readonly insertionDelimiter: string | undefined;
+
+  /** The insertion prefix to use if any */
+  readonly insertionPrefix: string | undefined;
 }
 
 /**
@@ -64,6 +67,7 @@ export interface MutableQueryCapture extends QueryCapture {
   range: Range;
   allowMultiple: boolean;
   insertionDelimiter: string | undefined;
+  insertionPrefix: string | undefined;
 }
 
 /**

packages/cursorless-engine/src/languages/TreeSitterQuery/TreeSitterQuery.ts

@@ -81,6 +81,7 @@ export class TreeSitterQuery {
             document,
             range: getNodeRange(node),
             insertionDelimiter: undefined,
+            insertionPrefix: undefined,
             allowMultiple: false,
           })),
         }),
@@ -117,6 +118,9 @@ export class TreeSitterQuery {
             insertionDelimiter: captures.find(
               (capture) => capture.insertionDelimiter != null,
             )?.insertionDelimiter,
+            insertionPrefix: captures.find(
+              (capture) => capture.insertionPrefix != null,
+            )?.insertionPrefix,
           };
         });
 

packages/cursorless-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts

@@ -5,7 +5,10 @@ import assert from "assert";
 
 interface TestCase {
   name: string;
-  captures: Omit<QueryCapture, "allowMultiple" | "insertionDelimiter">[];
+  captures: Omit<
+    QueryCapture,
+    "allowMultiple" | "insertionDelimiter" | "insertionPrefix"
+  >[];
   isValid: boolean;
   expectedErrorMessageIds: string[];
 }
@@ -193,6 +196,7 @@ suite("checkCaptureStartEnd", () => {
           ...capture,
           allowMultiple: false,
           insertionDelimiter: undefined,
+          insertionPrefix: undefined,
         })),
         messages,
       );

packages/cursorless-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts

@@ -214,6 +214,20 @@ class InsertionDelimiter extends QueryPredicateOperator<InsertionDelimiter> {
   }
 }
 
+class InsertionPrefix extends QueryPredicateOperator<InsertionPrefix> {
+  name = "insertion-prefix!" as const;
+  schema = z.union([z.tuple([q.node, q.string]), z.tuple([q.node, q.node])]);
+
+  run(nodeInfo: MutableQueryCapture, prefix: string | MutableQueryCapture) {
+    nodeInfo.insertionPrefix =
+      typeof prefix === "string"
+        ? prefix
+        : nodeInfo.document.getText(prefix.range);
+
+    return true;
+  }
+}
+
 export const queryPredicateOperators = [
   new Log(),
   new NotType(),
@@ -224,5 +238,6 @@ export const queryPredicateOperators = [
   new ShrinkToMatch(),
   new AllowMultiple(),
   new InsertionDelimiter(),
+  new InsertionPrefix(),
   new HasMultipleChildrenOfType(),
 ];

packages/cursorless-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.test.ts

@@ -55,6 +55,7 @@ function fillOutCapture(capture: NameRange): MutableQueryCapture {
     ...capture,
     allowMultiple: false,
     insertionDelimiter: undefined,
+    insertionPrefix: undefined,
     document: null as unknown as TextDocument,
     node: null as unknown as SyntaxNode,
   };

packages/cursorless-engine/src/languages/markdown.ts

@@ -1,17 +1,9 @@
-import { Range, SimpleScopeTypeType, TextEditor } from "@cursorless/common";
+import { SimpleScopeTypeType, TextEditor } from "@cursorless/common";
 import type { SyntaxNode } from "web-tree-sitter";
-import {
-  NodeFinder,
-  NodeMatcherAlternative,
-  SelectionWithContext,
-} from "../typings/Types";
-import { getMatchesInRange } from "../util/getMatchesInRange";
+import { NodeFinder, NodeMatcherAlternative } from "../typings/Types";
 import { leadingSiblingNodeFinder, patternFinder } from "../util/nodeFinders";
 import { createPatternMatchers, matcher } from "../util/nodeMatchers";
-import {
-  extendUntilNextMatchingSiblingOrLast,
-  selectWithLeadingDelimiter,
-} from "../util/nodeSelectors";
+import { extendUntilNextMatchingSiblingOrLast } from "../util/nodeSelectors";
 import { shrinkRangeToFitContent } from "../util/selectionUtils";
 
 const HEADING_MARKER_TYPES = [
@@ -69,48 +61,9 @@ function sectionMatcher(...patterns: string[]) {
   return matcher(leadingSiblingNodeFinder(finder), sectionExtractor);
 }
 
-const itemLeadingDelimiterExtractor = selectWithLeadingDelimiter(
-  "list_marker_parenthesis",
-  "list_marker_dot",
-  "list_marker_star",
-  "list_marker_minus",
-  "list_marker_plus",
-);
-
-function excludeTrailingNewline(editor: TextEditor, range: Range) {
-  const matches = getMatchesInRange(/\r?\n\s*$/g, editor, range);
-
-  if (matches.length > 0) {
-    return new Range(range.start, matches[0].start);
-  }
-
-  return range;
-}
-
-function itemExtractor(
-  editor: TextEditor,
-  node: SyntaxNode,
-): SelectionWithContext {
-  const { selection } = itemLeadingDelimiterExtractor(editor, node);
-  const line = editor.document.lineAt(selection.start);
-  const leadingRange = new Range(line.range.start, selection.start);
-  const indent = editor.document.getText(leadingRange);
-
-  return {
-    context: {
-      containingListDelimiter: `\n${indent}`,
-      leadingDelimiterRange: leadingRange,
-    },
-    selection: excludeTrailingNewline(editor, selection).toSelection(
-      selection.isReversed,
-    ),
-  };
-}
-
 const nodeMatchers: Partial<
   Record<SimpleScopeTypeType, NodeMatcherAlternative>
 > = {
-  collectionItem: matcher(patternFinder("list_item.paragraph!"), itemExtractor),
   section: sectionMatcher("atx_heading"),
   sectionLevelOne: sectionMatcher("atx_heading.atx_h1_marker"),
   sectionLevelTwo: sectionMatcher("atx_heading.atx_h2_marker"),

packages/cursorless-engine/src/processTargets/modifiers/EveryScopeStage.ts

@@ -73,13 +73,17 @@ export class EveryScopeStage implements ModifierStage {
     if (scopes == null) {
       // If target had no explicit range, or was contained by a single target
       // instance, expand to iteration scope before overlapping
-      scopes = this.getDefaultIterationRange(
-        scopeHandler,
-        this.scopeHandlerFactory,
-        target,
-      ).flatMap((iterationRange) =>
-        getScopesOverlappingRange(scopeHandler, editor, iterationRange),
-      );
+      try {
+        scopes = this.getDefaultIterationRange(
+          scopeHandler,
+          this.scopeHandlerFactory,
+          target,
+        ).flatMap((iterationRange) =>
+          getScopesOverlappingRange(scopeHandler, editor, iterationRange),
+        );
+      } catch (error) {
+        scopes = [];
+      }
     }
 
     if (scopes.length === 0) {

packages/cursorless-engine/src/processTargets/modifiers/ItemStage/ItemStage.ts

@@ -109,7 +109,7 @@ export class ItemStage implements ModifierStage {
     itemInfo: ItemInfo,
     removalRange?: Range,
   ) {
-    const delimiter = getInsertionDelimiter(
+    const insertionDelimiter = getInsertionDelimiter(
       target.editor,
       itemInfo.leadingDelimiterRange,
       itemInfo.trailingDelimiterRange,
@@ -120,7 +120,7 @@ export class ItemStage implements ModifierStage {
       editor: target.editor,
       isReversed: target.isReversed,
       contentRange: itemInfo.contentRange,
-      delimiter,
+      insertionDelimiter,
       leadingDelimiterRange: itemInfo.leadingDelimiterRange,
       trailingDelimiterRange: itemInfo.trailingDelimiterRange,
       removalRange,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/TreeSitterScopeHandler.ts

@@ -48,7 +48,12 @@ export class TreeSitterScopeHandler extends BaseTreeSitterScopeHandler {
       return undefined;
     }
 
-    const { range: contentRange, allowMultiple, insertionDelimiter } = capture;
+    const {
+      range: contentRange,
+      allowMultiple,
+      insertionDelimiter,
+      insertionPrefix,
+    } = capture;
 
     const domain =
       getRelatedRange(match, scopeTypeType, "domain", true) ?? contentRange;
@@ -84,7 +89,8 @@ export class TreeSitterScopeHandler extends BaseTreeSitterScopeHandler {
           leadingDelimiterRange,
           trailingDelimiterRange,
           interiorRange,
-          delimiter: insertionDelimiter,
+          insertionDelimiter,
+          insertionPrefix,
         }),
       ],
     };

packages/cursorless-engine/src/processTargets/modifiers/scopeTypeStages/LegacyContainingSyntaxScopeStage.ts

@@ -82,7 +82,7 @@ export class LegacyContainingSyntaxScopeStage implements ModifierStage {
         contentRange: contentSelection,
         removalRange: removalRange,
         interiorRange: interiorRange,
-        delimiter: containingListDelimiter,
+        insertionDelimiter: containingListDelimiter,
         leadingDelimiterRange,
         trailingDelimiterRange,
       });

packages/cursorless-engine/src/processTargets/targets/DestinationImpl.ts

@@ -4,6 +4,7 @@ import {
   Selection,
   TextEditor,
 } from "@cursorless/common";
+import { escapeRegExp } from "lodash";
 import { EditWithRangeUpdater } from "../../typings/Types";
 import {
   Destination,
@@ -44,6 +45,10 @@ export class DestinationImpl implements Destination {
     return this.target.insertionDelimiter;
   }
 
+  private get insertionPrefix(): string | undefined {
+    return this.target.insertionPrefix;
+  }
+
   get isRaw(): boolean {
     return this.target.isRaw;
   }
@@ -65,9 +70,10 @@ export class DestinationImpl implements Destination {
 
   getEditNewActionType(): EditNewActionType {
     if (
-      this.insertionDelimiter === "\n" &&
       this.insertionMode === "after" &&
-      this.target.contentRange.isSingleLine
+      this.target.contentRange.isSingleLine &&
+      this.insertionDelimiter === "\n" &&
+      this.insertionPrefix == null
     ) {
       // If the target that we're wrapping is not a single line, then we
       // want to compute indentation based on the entire target.  Otherwise,
@@ -116,12 +122,37 @@ export class DestinationImpl implements Destination {
 
       if (this.isLineDelimiter) {
         const line = this.editor.document.lineAt(contentPosition);
-        const nonWhitespaceCharacterIndex = this.isBefore
-          ? line.firstNonWhitespaceCharacterIndex
-          : line.lastNonWhitespaceCharacterIndex;
+
+        const useFullLineRange = (() => {
+          if (this.isBefore) {
+            // With an insertion prefix the position we want to insert before is extended to the left
+            if (this.insertionPrefix != null) {
+              // The leading text on the same line before the content range
+              const text = line.text.slice(
+                line.firstNonWhitespaceCharacterIndex,
+                contentPosition.character,
+              );
+
+              // The leading text on the line is the prefix with optional whitespace
+              const pattern = new RegExp(
+                `^${escapeRegExp(this.insertionPrefix)}\\s*$`,
+              );
+              return pattern.test(text);
+            }
+
+            return (
+              contentPosition.character ===
+              line.firstNonWhitespaceCharacterIndex
+            );
+          }
+
+          return (
+            contentPosition.character === line.lastNonWhitespaceCharacterIndex
+          );
+        })();
 
         // Use the full line to include indentation
-        if (contentPosition.character === nonWhitespaceCharacterIndex) {
+        if (useFullLineRange) {
           return this.isBefore ? line.range.start : line.range.end;
         }
       }
@@ -133,20 +164,23 @@ export class DestinationImpl implements Destination {
   }
 
   private getEditText(text: string) {
-    const insertionText = this.indentationString + text;
+    const insertionText =
+      this.indentationString + (this.insertionPrefix ?? "") + text;
 
     return this.isBefore
       ? insertionText + this.insertionDelimiter
       : this.insertionDelimiter + insertionText;
   }
 
   private updateRange(range: Range, text: string) {
-    const baseStartOffset = this.editor.document.offsetAt(range.start);
+    const baseStartOffset =
+      this.editor.document.offsetAt(range.start) +
+      this.indentationString.length +
+      (this.insertionPrefix?.length ?? 0);
+
     const startIndex = this.isBefore
-      ? baseStartOffset + this.indentationString.length
-      : baseStartOffset +
-        this.getLengthOfInsertionDelimiter() +
-        this.indentationString.length;
+      ? baseStartOffset
+      : baseStartOffset + this.getLengthOfInsertionDelimiter();
 
     const endIndex = startIndex + text.length;
 

packages/cursorless-engine/src/processTargets/targets/ScopeTypeTarget.ts

@@ -16,7 +16,8 @@ import {
 
 export interface ScopeTypeTargetParameters extends CommonTargetParameters {
   readonly scopeTypeType: SimpleScopeTypeType;
-  readonly delimiter?: string;
+  readonly insertionDelimiter?: string;
+  readonly insertionPrefix?: string;
   readonly removalRange?: Range;
   readonly interiorRange?: Range;
   readonly leadingDelimiterRange?: Range;
@@ -32,6 +33,7 @@ export class ScopeTypeTarget extends BaseTarget<ScopeTypeTargetParameters> {
   private trailingDelimiterRange_?: Range;
   private hasDelimiterRange_: boolean;
   insertionDelimiter: string;
+  insertionPrefix?: string;
 
   constructor(parameters: ScopeTypeTargetParameters) {
     super(parameters);
@@ -41,7 +43,9 @@ export class ScopeTypeTarget extends BaseTarget<ScopeTypeTargetParameters> {
     this.leadingDelimiterRange_ = parameters.leadingDelimiterRange;
     this.trailingDelimiterRange_ = parameters.trailingDelimiterRange;
     this.insertionDelimiter =
-      parameters.delimiter ?? getDelimiter(parameters.scopeTypeType);
+      parameters.insertionDelimiter ??
+      getInsertionDelimiter(parameters.scopeTypeType);
+    this.insertionPrefix = parameters.insertionPrefix;
     this.hasDelimiterRange_ =
       !!this.leadingDelimiterRange_ || !!this.trailingDelimiterRange_;
   }
@@ -126,7 +130,8 @@ export class ScopeTypeTarget extends BaseTarget<ScopeTypeTargetParameters> {
   protected getCloneParameters() {
     return {
       ...this.state,
-      delimiter: this.insertionDelimiter,
+      insertionDelimiter: this.insertionDelimiter,
+      insertionPrefix: this.insertionPrefix,
       removalRange: undefined,
       interiorRange: undefined,
       scopeTypeType: this.scopeTypeType_,
@@ -137,7 +142,7 @@ export class ScopeTypeTarget extends BaseTarget<ScopeTypeTargetParameters> {
   }
 }
 
-function getDelimiter(scopeType: SimpleScopeTypeType): string {
+function getInsertionDelimiter(scopeType: SimpleScopeTypeType): string {
   switch (scopeType) {
     case "class":
     case "namedFunction":

packages/cursorless-engine/src/typings/target.types.ts

@@ -42,6 +42,9 @@ export interface Target {
   /** If this selection has a delimiter use it for inserting before or after the target. For example, new line for a line or paragraph and comma for a list or argument */
   readonly insertionDelimiter: string;
 
+  /** If this selection has a prefix use it for inserting before the target. For example, dash or asterisk for a markdown item */
+  readonly insertionPrefix?: string;
+
   /** If true this target should be treated as a line */
   readonly isLine: boolean;