Use containing scope stage in preferred scope stage (#2639)

ContainingScopeStage have some logic around how to treat legacy scopes
that we were missing from PreferredScopeStage.

## Checklist

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

data/fixtures/recorded/modifiers/preferredScope/clearItem.yml

@@ -0,0 +1,24 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: clear item
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: preferredScope
+          scopeType: {type: collectionItem}
+  usePrePhraseSnapshot: true
+spokenFormError: Modifier 'preferredScope'
+initialState:
+  documentContents: foo, bar
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: ", bar"
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

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

@@ -1,8 +1,12 @@
-import { type Position, type PreferredScopeModifier } from "@cursorless/common";
+import {
+  NoContainingScopeError,
+  type Position,
+  type PreferredScopeModifier,
+} from "@cursorless/common";
 import type { Target } from "../../typings/target.types";
 import type { ModifierStageFactory } from "../ModifierStageFactory";
 import type { ModifierStage } from "../PipelineStages.types";
-import { getContainingScopeTarget } from "./getContainingScopeTarget";
+import { ContainingScopeStage } from "./ContainingScopeStage";
 import type { TargetScope } from "./scopeHandlers/scope.types";
 import type { ScopeHandler } from "./scopeHandlers/scopeHandler.types";
 import type { ScopeHandlerFactory } from "./scopeHandlers/ScopeHandlerFactory";
@@ -22,6 +26,21 @@ export class PreferredScopeStage implements ModifierStage {
   run(target: Target): Target[] {
     const { scopeType } = this.modifier;
 
+    const containingScopeStage = new ContainingScopeStage(
+      this.modifierStageFactory,
+      this.scopeHandlerFactory,
+      { type: "containingScope", scopeType },
+    );
+
+    try {
+      return containingScopeStage.run(target);
+    } catch (ex) {
+      // NoContainingScopeError is thrown if no containing scope was found, which is fine.
+      if (!(ex instanceof NoContainingScopeError)) {
+        throw ex;
+      }
+    }
+
     const scopeHandler = this.scopeHandlerFactory.create(
       this.modifier.scopeType,
       target.editor.document.languageId,
@@ -31,17 +50,13 @@ export class PreferredScopeStage implements ModifierStage {
       throw Error(`Couldn't create scope handler for: ${scopeType.type}`);
     }
 
-    const containingTargets = getContainingScopeTarget(target, scopeHandler);
-    if (containingTargets != null) {
-      return containingTargets;
-    }
-
     const closestTargets = getClosestScopeTargets(target, scopeHandler);
-    if (closestTargets != null) {
-      return closestTargets;
+
+    if (closestTargets == null) {
+      throw Error(`No scopes found for scope type: ${scopeType.type}`);
     }
 
-    throw Error(`No scopes found for scope type: ${scopeType.type}`);
+    return closestTargets;
   }
 }