Added visible modifier (#2094)

Fixes #1607

Tested with `"from visible chuck every instance air"` and folded regions
will be untouched.




## 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

Author: AndreasArvidsson

cursorless-talon/src/spoken_forms.json

@@ -76,7 +76,8 @@
       "trailing": "trailing",
       "content": "keepContentFilter",
       "empty": "keepEmptyFilter",
-      "its": "inferPreviousMark"
+      "its": "inferPreviousMark",
+      "visible": "visible"
     },
     "simple_scope_modifier": { "every": "every" },
     "interior_modifier": {

packages/common/src/types/command/PartialTargetDescriptor.types.ts

@@ -232,6 +232,10 @@ export interface ExcludeInteriorModifier {
   type: "excludeInterior";
 }
 
+export interface VisibleModifier {
+  type: "visible";
+}
+
 export interface ContainingScopeModifier {
   type: "containingScope";
   scopeType: ScopeType;
@@ -375,6 +379,7 @@ export type Modifier =
   | EndOfModifier
   | InteriorOnlyModifier
   | ExcludeInteriorModifier
+  | VisibleModifier
   | ContainingScopeModifier
   | EveryScopeModifier
   | OrdinalScopeModifier

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

@@ -30,6 +30,7 @@ import { RangeModifierStage } from "./modifiers/RangeModifierStage";
 import { RawSelectionStage } from "./modifiers/RawSelectionStage";
 import { RelativeScopeStage } from "./modifiers/RelativeScopeStage";
 import { SurroundingPairStage } from "./modifiers/SurroundingPairStage";
+import { VisibleStage } from "./modifiers/VisibleStage";
 import { ScopeHandlerFactory } from "./modifiers/scopeHandlers/ScopeHandlerFactory";
 import { BoundedNonWhitespaceSequenceStage } from "./modifiers/scopeTypeStages/BoundedNonWhitespaceStage";
 import {
@@ -68,6 +69,8 @@ export class ModifierStageFactoryImpl implements ModifierStageFactory {
         return new LeadingStage(this, modifier);
       case "trailing":
         return new TrailingStage(this, modifier);
+      case "visible":
+        return new VisibleStage(modifier);
       case "containingScope":
         return new ContainingScopeStage(
           this,

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

@@ -0,0 +1,19 @@
+import { VisibleModifier } from "@cursorless/common";
+import { Target } from "../../typings/target.types";
+import { ModifierStage } from "../PipelineStages.types";
+import { PlainTarget } from "../targets";
+
+export class VisibleStage implements ModifierStage {
+  constructor(private modifier: VisibleModifier) {}
+
+  run(target: Target): Target[] {
+    return target.editor.visibleRanges.map(
+      (range) =>
+        new PlainTarget({
+          editor: target.editor,
+          isReversed: target.isReversed,
+          contentRange: range,
+        }),
+    );
+  }
+}

packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts

@@ -117,6 +117,7 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = {
     startOf: "start of",
     endOf: "end of",
     interiorOnly: "inside",
+    visible: "visible",
     extendThroughStartOf: "head",
     extendThroughEndOf: "tail",
     everyScope: "every",

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/modifiers/changeVisible.yml

@@ -0,0 +1,29 @@
+languageId: typescript
+command:
+  version: 6
+  spokenForm: change visible
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - {type: visible}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |-
+    // Hello
+
+    function helloWorld() {
+        // Hello
+    }
+
+    // Hello
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

packages/cursorless-vscode-e2e/src/suite/visible.vscode.test.ts

@@ -0,0 +1,66 @@
+import * as assert from "assert";
+import * as vscode from "vscode";
+import { openNewEditor } from "@cursorless/vscode-common";
+import { endToEndTestSetup } from "../endToEndTestSetup";
+import { runCursorlessCommand } from "@cursorless/vscode-common";
+
+suite("visible", async function () {
+  endToEndTestSetup(this);
+
+  test("visible multiple regions", testMultipleRegions);
+});
+
+async function testMultipleRegions() {
+  const editor = await openEditor();
+
+  await foldRegion();
+
+  assert.equal(editor.visibleRanges.length, 2);
+
+  await clearVisible();
+
+  assert.equal(editor.selections.length, 2);
+
+  assert.equal(editor.document.getText(), "\n    // 2\n");
+}
+
+const content = `
+// 1
+
+function myFunk() {
+    // 2
+}
+
+// 3
+`;
+
+function openEditor() {
+  return openNewEditor(content, {
+    languageId: "typescript",
+  });
+}
+
+function foldRegion() {
+  return vscode.commands.executeCommand("editor.fold", {
+    levels: 1,
+    direction: "down",
+    selectionLines: [3],
+  });
+}
+
+function clearVisible() {
+  return runCursorlessCommand({
+    version: 6,
+    usePrePhraseSnapshot: false,
+    action: {
+      name: "clearAndSetSelection",
+      target: {
+        type: "primitive",
+        mark: {
+          type: "cursor",
+        },
+        modifiers: [{ type: "visible" }],
+      },
+    },
+  });
+}