Use scope instead of modifier

AndreasArvidsson · AndreasArvidsson · commit 9b6324e8182c · 2025-11-04T09:42:12.000+01:00
diff --git a/cursorless-talon/src/spoken_forms.json b/cursorless-talon/src/spoken_forms.json
@@ -89,7 +89,6 @@
       "trailing": "trailing",
       "content": "keepContentFilter",
       "empty": "keepEmptyFilter",
-      "expand": "expandToFullLine",
       "its": "inferPreviousMark",
       "visible": "visible"
     },
@@ -175,6 +174,7 @@
       "token": "token",
       "identifier": "identifier",
       "line": "line",
+      "full line": "fullLine",
       "sentence": "sentence",
       "block": "paragraph",
       "file": "document",
diff --git a/data/fixtures/recorded/modifiers/changeExpand.yml b/data/fixtures/recorded/modifiers/changeExpand.yml
diff --git a/data/fixtures/scopes/plaintext/fullLine.scope b/data/fixtures/scopes/plaintext/fullLine.scope
@@ -0,0 +1,10 @@
+    Hello world  
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-0:17
+  >-----------------<
+0|     Hello world  
+
+[Insertion delimiter] = "\n"
diff --git a/data/fixtures/scopes/plaintext/fullLine2.scope b/data/fixtures/scopes/plaintext/fullLine2.scope
@@ -0,0 +1,96 @@
+
+Hello
+ world 
+  
+---
+
+[#1 Content] =
+[#1 Domain] = 0:0-0:0
+  ><
+0|
+
+[#1 Removal] = 0:0-1:0
+  >
+0|
+1| Hello
+   <
+
+[#1 Trailing delimiter] = 0:0-1:0
+  >
+0|
+1| Hello
+   <
+
+[#1 Insertion delimiter] = "\n"
+
+
+[#2 Content] =
+[#2 Domain] = 1:0-1:5
+  >-----<
+1| Hello
+
+[#2 Removal] = 1:0-2:0
+  >-----
+1| Hello
+2|  world 
+   <
+
+[#2 Leading delimiter] = 0:0-1:0
+  >
+0|
+1| Hello
+   <
+
+[#2 Trailing delimiter] = 1:5-2:0
+       >
+1| Hello
+2|  world 
+   <
+
+[#2 Insertion delimiter] = "\n"
+
+
+[#3 Content] =
+[#3 Domain] = 2:0-2:7
+  >-------<
+2|  world 
+
+[#3 Removal] = 2:0-3:0
+  >-------
+2|  world 
+3|   
+   <
+
+[#3 Leading delimiter] = 1:5-2:0
+       >
+1| Hello
+2|  world 
+   <
+
+[#3 Trailing delimiter] = 2:7-3:0
+         >
+2|  world 
+3|   
+   <
+
+[#3 Insertion delimiter] = "\n"
+
+
+[#4 Content] =
+[#4 Domain] = 3:0-3:2
+  >--<
+3|   
+
+[#4 Removal] = 2:7-3:2
+         >
+2|  world 
+3|   
+   --<
+
+[#4 Leading delimiter] = 2:7-3:0
+         >
+2|  world 
+3|   
+   <
+
+[#4 Insertion delimiter] = "\n"
diff --git a/data/scopeSupportFacetInfos.md b/data/scopeSupportFacetInfos.md
@@ -141,6 +141,10 @@
 
 - `fieldAccess` A field access
 
+### fullLine
+
+- `fullLine` A single full line in the document. Includes leading and trailing whitespace.
+
 ### functionCall
 
 - `functionCall` A function call
@@ -196,7 +200,7 @@
 
 ### line
 
-- `line` A single line in the document
+- `line` A single line in the document. Excludes leading and trailing whitespace.
 
 ### list
 
diff --git a/packages/common/src/scopeSupportFacets/PlaintextScopeSupportFacetInfos.ts b/packages/common/src/scopeSupportFacets/PlaintextScopeSupportFacetInfos.ts
@@ -24,9 +24,15 @@ export const plaintextScopeSupportFacetInfos: Record<
     scopeType: "identifier",
   },
   line: {
-    description: "A single line in the document",
+    description:
+      "A single line in the document. Excludes leading and trailing whitespace.",
     scopeType: "line",
   },
+  fullLine: {
+    description:
+      "A single full line in the document. Includes leading and trailing whitespace.",
+    scopeType: "fullLine",
+  },
   sentence: {
     description: "A single sentence in the document",
     scopeType: "sentence",
diff --git a/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts b/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts
@@ -303,6 +303,7 @@ export type PlaintextScopeSupportFacet =
   | "token"
   | "identifier"
   | "line"
+  | "fullLine"
   | "sentence"
   | "paragraph"
   | "boundedParagraph"
diff --git a/packages/common/src/types/command/PartialTargetDescriptor.types.ts b/packages/common/src/types/command/PartialTargetDescriptor.types.ts
@@ -193,6 +193,7 @@ export const simpleScopeTypeTypes = [
   "token",
   "identifier",
   "line",
+  "fullLine",
   "sentence",
   "paragraph",
   "boundedParagraph",
@@ -397,10 +398,6 @@ export interface TrailingModifier {
   type: "trailing";
 }
 
-export interface ExpandToFullLineModifier {
-  type: "expandToFullLine";
-}
-
 export interface KeepContentFilterModifier {
   type: "keepContentFilter";
 }
@@ -486,7 +483,6 @@ export type Modifier =
   | LeadingModifier
   | TrailingModifier
   | RawSelectionModifier
-  | ExpandToFullLineModifier
   | ModifyIfUntypedModifier
   | FallbackModifier
   | RangeModifier
diff --git a/packages/cursorless-engine/src/processTargets/ModifierStageFactoryImpl.ts b/packages/cursorless-engine/src/processTargets/ModifierStageFactoryImpl.ts
@@ -7,7 +7,6 @@ import { ClassFunctionNameStage } from "./modifiers/ClassFunctionNameStage";
 import { ModifyIfUntypedStage } from "./modifiers/ConditionalModifierStages";
 import { ContainingScopeStage } from "./modifiers/ContainingScopeStage";
 import { EveryScopeStage } from "./modifiers/EveryScopeStage";
-import { ExpandToFullLineStage } from "./modifiers/ExpandToFullLineStage";
 import { FallbackStage } from "./modifiers/FallbackStage";
 import {
   KeepContentFilterStage,
@@ -58,8 +57,6 @@ export class ModifierStageFactoryImpl implements ModifierStageFactory {
         return new LeadingStage(this, modifier);
       case "trailing":
         return new TrailingStage(this, modifier);
-      case "expandToFullLine":
-        return new ExpandToFullLineStage(modifier);
       case "visible":
         return new VisibleStage(modifier);
 
diff --git a/packages/cursorless-engine/src/processTargets/modifiers/ExpandToFullLineStage.ts b/packages/cursorless-engine/src/processTargets/modifiers/ExpandToFullLineStage.ts
diff --git a/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/LineScopeHandler.ts b/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/LineScopeHandler.ts
@@ -9,15 +9,21 @@ import { LineTarget } from "../../targets";
 import { BaseScopeHandler } from "./BaseScopeHandler";
 import type { TargetScope } from "./scope.types";
 
+interface LineScopeType {
+  type: "line" | "fullLine";
+}
+
 export class LineScopeHandler extends BaseScopeHandler {
-  public readonly scopeType = { type: "line" } as const;
   public readonly iterationScopeType: ScopeType = {
     type: "paragraph",
   } as const;
   protected readonly isHierarchical = false;
   public readonly includeAdjacentInEvery = true;
 
-  constructor(_scopeType: ScopeType, _languageId: string) {
+  constructor(
+    public readonly scopeType: LineScopeType,
+    _languageId: string,
+  ) {
     super();
   }
 
@@ -26,40 +32,48 @@ export class LineScopeHandler extends BaseScopeHandler {
     position: Position,
     direction: Direction,
   ): Iterable<TargetScope> {
+    const useFullLine = this.scopeType.type === "fullLine";
+
     if (direction === "forward") {
       for (let i = position.line; i < editor.document.lineCount; i++) {
-        yield lineNumberToScope(editor, i);
+        yield lineNumberToScope(editor, useFullLine, i);
       }
     } else {
       for (let i = position.line; i >= 0; i--) {
-        yield lineNumberToScope(editor, i);
+        yield lineNumberToScope(editor, useFullLine, i);
       }
     }
   }
 }
 
 function lineNumberToScope(
   editor: TextEditor,
+  useFullLine: boolean,
   lineNumber: number,
 ): TargetScope {
   const { range } = editor.document.lineAt(lineNumber);
 
   return {
     editor,
     domain: range,
-    getTargets: (isReversed) => [createLineTarget(editor, isReversed, range)],
+    getTargets: (isReversed) => [
+      createLineTarget(editor, isReversed, range, useFullLine),
+    ],
   };
 }
 
 export function createLineTarget(
   editor: TextEditor,
   isReversed: boolean,
   range: Range,
+  useUnmodifiedRange = false,
 ) {
   return new LineTarget({
     editor,
     isReversed,
-    contentRange: fitRangeToLineContent(editor, range),
+    contentRange: useUnmodifiedRange
+      ? range
+      : fitRangeToLineContent(editor, range),
   });
 }
 
diff --git a/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts b/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts
@@ -65,7 +65,9 @@ export class ScopeHandlerFactoryImpl implements ScopeHandlerFactory {
       case "identifier":
         return new IdentifierScopeHandler(this, scopeType, languageId);
       case "line":
-        return new LineScopeHandler(scopeType, languageId);
+        return new LineScopeHandler({ type: scopeType.type }, languageId);
+      case "fullLine":
+        return new LineScopeHandler({ type: scopeType.type }, languageId);
       case "sentence":
         return new SentenceScopeHandler(this, scopeType, languageId);
       case "paragraph":
diff --git a/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts b/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts
@@ -171,6 +171,7 @@ function isLanguageSpecific(scopeType: ScopeType): boolean {
     case "token":
     case "identifier":
     case "line":
+    case "fullLine":
     case "sentence":
     case "paragraph":
     case "boundedParagraph":
diff --git a/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts b/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts
@@ -93,6 +93,7 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = {
     token: "token",
     identifier: "identifier",
     line: "line",
+    fullLine: "full line",
     sentence: "sentence",
     paragraph: "block",
     boundedParagraph: "short block",
@@ -122,7 +123,6 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = {
     toRawSelection: "just",
     leading: "leading",
     trailing: "trailing",
-    expandToFullLine: "expand",
     keepContentFilter: "content",
     keepEmptyFilter: "empty",
     inferPreviousMark: "its",
diff --git a/packages/cursorless-engine/src/util/getScopeType.ts b/packages/cursorless-engine/src/util/getScopeType.ts
@@ -22,7 +22,6 @@ export function getScopeType(modifier: Modifier): ScopeType | undefined {
     case "endOf":
     case "extendThroughStartOf":
     case "extendThroughEndOf":
-    case "expandToFullLine":
     case "fallback":
     case "range":
     case "modifyIfUntyped":
diff --git a/packages/cursorless-org-docs/src/docs/contributing/scopes/fullLine.mdx b/packages/cursorless-org-docs/src/docs/contributing/scopes/fullLine.mdx
@@ -0,0 +1,5 @@
+import { Scopes } from "./components/Scopes";
+
+# Full line
+
+<Scopes scopeTypeType="fullLine" />
