Added target textual type (#2765)

Fixes #2075

## Checklist

- [/] 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

---------

Co-authored-by: Phil Cohen <[email protected]>

Author: AndreasArvidsson

packages/cursorless-engine/src/actions/InsertEmptyLines.ts

@@ -142,6 +142,6 @@ function constructChangeEdit(
 ): EditWithFlashType {
   return {
     ...target.toDestination(insertionMode).constructChangeEdit("", true),
-    isLine: target.isLine,
+    isLine: target.textualType === "line",
   };
 }

packages/cursorless-engine/src/actions/JoinLines.ts

@@ -61,9 +61,9 @@ function getEdits(editor: TextEditor, targets: Target[]): Edit[] {
 
   for (const target of targets) {
     const targetsEdits =
-      target.joinAs === "line"
-        ? getLineTargetEdits(target)
-        : getTokenTargetEdits(target);
+      target.textualType === "token"
+        ? getTokenTargetEdits(target)
+        : getLineTargetEdits(target);
 
     edits.push(...targetsEdits);
   }

packages/cursorless-engine/src/processTargets/createContinuousRangeTarget.ts

@@ -1,10 +1,10 @@
 import type { Target } from "../typings/target.types";
 import { isSameType } from "../util/typeUtils";
+import { LineTarget, UntypedTarget } from "./targets";
 import {
   createContinuousLineRange,
   createContinuousRange,
 } from "./targets/util/createContinuousRange";
-import { LineTarget, UntypedTarget } from "./targets";
 
 /**
  * Creates a target consisting of a range between two targets. If the targets
@@ -48,7 +48,7 @@ export function createContinuousRangeTarget(
     }
   }
 
-  if (startTarget.isLine && endTarget.isLine) {
+  if (startTarget.textualType === "line" && endTarget.textualType === "line") {
     return new LineTarget({
       editor: startTarget.editor,
       isReversed,
@@ -71,7 +71,12 @@ export function createContinuousRangeTarget(
       includeStart,
       includeEnd,
     ),
-    isToken:
-      includeStart && includeEnd && startTarget.isToken && endTarget.isToken,
+    textualType:
+      includeStart &&
+      includeEnd &&
+      startTarget.textualType === "token" &&
+      endTarget.textualType === "token"
+        ? "token"
+        : "character",
   });
 }

packages/cursorless-engine/src/processTargets/marks/CursorStage.ts

@@ -13,7 +13,7 @@ export class CursorStage implements MarkStage {
           isReversed: selection.selection.isReversed,
           contentRange: selection.selection,
           hasExplicitRange: !selection.selection.isEmpty,
-          isToken: false,
+          textualType: "character",
         }),
     );
   }

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

@@ -135,7 +135,7 @@ export class InstanceStage implements ModifierStage {
           contentRange: range,
           editor,
           isReversed: false,
-          isToken: false,
+          textualType: "character",
         }),
     );
 
@@ -182,19 +182,14 @@ export class InstanceStage implements ModifierStage {
 }
 
 function getFilterScopeType(target: Target): ScopeType | null {
-  if (target.isLine) {
-    return { type: "line" };
+  switch (target.textualType) {
+    case "line":
+    case "token":
+    case "word":
+      return { type: target.textualType };
+    default:
+      return null;
   }
-
-  if (target.isToken) {
-    return { type: "token" };
-  }
-
-  if (target.isWord) {
-    return { type: "word" };
-  }
-
-  return null;
 }
 
 /**

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

@@ -15,7 +15,7 @@ abstract class PositionStage implements ModifierStage {
     return [
       target.isRaw
         ? new RawSelectionTarget(parameters)
-        : new PlainTarget({ ...parameters, isToken: false }),
+        : new PlainTarget({ ...parameters, textualType: "character" }),
     ];
   }
 

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

@@ -39,7 +39,7 @@ export class CharacterScopeHandler extends NestedScopeHandler {
             editor,
             contentRange: range,
             isReversed,
-            isToken: false,
+            textualType: "character",
           }),
         ],
       }),

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

@@ -12,8 +12,8 @@ import { isEqual } from "lodash-es";
 import type { EditWithRangeUpdater } from "../../typings/Types";
 import type {
   Destination,
-  JoinAsType,
   Target,
+  TextualType,
 } from "../../typings/target.types";
 import { toGeneralizedRange } from "../../util/targetUtils";
 import { DestinationImpl } from "./DestinationImpl";
@@ -47,15 +47,12 @@ export abstract class BaseTarget<
 {
   protected abstract readonly type: string;
   protected readonly state: EnforceUndefined<CommonTargetParameters>;
-  isLine = false;
-  isToken = true;
   hasExplicitScopeType = true;
   hasExplicitRange = true;
   isRaw = false;
   isImplicit = false;
   isNotebookCell = false;
-  isWord = false;
-  joinAs: JoinAsType = "line";
+  textualType: TextualType = "token";
 
   constructor(parameters: TParameters & CommonTargetParameters) {
     this.state = {

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

@@ -1,5 +1,6 @@
 import { toLineRange, type Range } from "@cursorless/common";
 import type { InteriorTarget, ParagraphTarget } from ".";
+import type { TextualType } from "../../typings/target.types";
 import { expandToFullLine } from "../../util/rangeUtils";
 import type { MinimumTargetParameters } from "./BaseTarget";
 import { BaseTarget } from "./BaseTarget";
@@ -12,8 +13,8 @@ interface BoundedParagraphTargetParameters extends MinimumTargetParameters {
 
 export class BoundedParagraphTarget extends BaseTarget<BoundedParagraphTargetParameters> {
   readonly type = "BoundedParagraphTarget";
+  readonly textualType: TextualType = "line";
   readonly insertionDelimiter = "\n\n";
-  readonly isLine = true;
   private containingInterior: InteriorTarget;
   private paragraphTarget: ParagraphTarget;
   private startLineGap: number;

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

@@ -1,12 +1,13 @@
 import type { Range } from "@cursorless/common";
+import type { TextualType } from "../../typings/target.types";
 import { shrinkRangeToFitContent } from "../../util/selectionUtils";
 import { BaseTarget, type CommonTargetParameters } from "./BaseTarget";
 import { PlainTarget } from "./PlainTarget";
 
 export class DocumentTarget extends BaseTarget<CommonTargetParameters> {
   type = "DocumentTarget";
+  textualType: TextualType = "line";
   insertionDelimiter = "\n";
-  isLine = true;
 
   constructor(parameters: CommonTargetParameters) {
     super(parameters);