Added action replace (#135)

Author: AndreasArvidsson

src/CommandAction.ts

@@ -63,8 +63,7 @@ export default class CommandAction implements Action {
   ]): Promise<ActionReturnValue> {
     await displayPendingEditDecorations(
       targets,
-      this.graph.editStyles.referenced,
-      this.graph.editStyles.referencedLine
+      this.graph.editStyles.referenced
     );
 
     const originalEditor = window.activeTextEditor;

src/Types.ts

@@ -2,7 +2,7 @@ import { SyntaxNode } from "web-tree-sitter";
 import * as vscode from "vscode";
 import { Location } from "vscode";
 import { SymbolColor } from "./constants";
-import EditStyles from "./editStyles";
+import { EditStyles } from "./editStyles";
 import NavigationMap from "./NavigationMap";
 
 /**
@@ -256,6 +256,7 @@ export type ActionType =
   | "move"
   | "outdentLines"
   | "paste"
+  | "replaceWithText"
   | "scrollToBottom"
   | "scrollToCenter"
   | "scrollToTop"

src/actions/BringMoveSwap.ts

@@ -9,17 +9,11 @@ import {
 import { runForEachEditor } from "../targetUtils";
 import update from "immutability-helper";
 import displayPendingEditDecorations from "../editDisplayUtils";
-import { performInsideOutsideAdjustment } from "../performInsideOutsideAdjustment";
+import { performOutsideAdjustment } from "../performInsideOutsideAdjustment";
 import { flatten, zip } from "lodash";
-import { Selection, TextEditorDecorationType, TextEditor, Range } from "vscode";
+import { Selection, TextEditor, Range } from "vscode";
 import { performEditsAndUpdateSelections } from "../updateSelections";
-
-interface DecorationTypes {
-  sourceStyle: TextEditorDecorationType;
-  sourceLineStyle: TextEditorDecorationType;
-  destinationStyle: TextEditorDecorationType;
-  destinationLineStyle: TextEditorDecorationType;
-}
+import { getTextWithPossibleDelimiter } from "../getTextWithPossibleDelimiter";
 
 interface ExtendedEdit extends Edit {
   editor: TextEditor;
@@ -37,7 +31,7 @@ interface ThatMarkEntry {
 class BringMoveSwap implements Action {
   targetPreferences: ActionPreferences[] = [
     { insideOutsideType: null },
-    { insideOutsideType: "inside" },
+    { insideOutsideType: null },
   ];
 
   constructor(private graph: Graph, private type: string) {
@@ -56,25 +50,20 @@ class BringMoveSwap implements Action {
     return sources;
   }
 
-  private getDecorationStyles(): DecorationTypes {
-    let sourceStyle, sourceLineStyle;
+  private getDecorationStyles() {
+    let sourceStyle;
     if (this.type === "bring") {
       sourceStyle = this.graph.editStyles.referenced;
-      sourceLineStyle = this.graph.editStyles.referencedLine;
-    } else if (this.type === "swap") {
-      sourceStyle = this.graph.editStyles.pendingModification1;
-      sourceLineStyle = this.graph.editStyles.pendingLineModification1;
     } else if (this.type === "move") {
       sourceStyle = this.graph.editStyles.pendingDelete;
-      sourceLineStyle = this.graph.editStyles.pendingLineDelete;
-    } else {
-      throw Error(`Unknown type "${this.type}"`);
+    }
+    // NB this.type === "swap"
+    else {
+      sourceStyle = this.graph.editStyles.pendingModification1;
     }
     return {
       sourceStyle,
-      sourceLineStyle,
       destinationStyle: this.graph.editStyles.pendingModification0,
-      destinationLineStyle: this.graph.editStyles.pendingLineModification0,
     };
   }
 
@@ -84,15 +73,10 @@ class BringMoveSwap implements Action {
   ) {
     const decorationTypes = this.getDecorationStyles();
     await Promise.all([
-      displayPendingEditDecorations(
-        sources,
-        decorationTypes.sourceStyle,
-        decorationTypes.sourceLineStyle
-      ),
+      displayPendingEditDecorations(sources, decorationTypes.sourceStyle),
       displayPendingEditDecorations(
         destinations,
-        decorationTypes.destinationStyle,
-        decorationTypes.destinationLineStyle
+        decorationTypes.destinationStyle
       ),
     ]);
   }
@@ -107,54 +91,45 @@ class BringMoveSwap implements Action {
         throw new Error("Targets must have same number of args");
       }
 
-      const sourceText = source.selection.editor.document.getText(
-        source.selection.selection
-      );
-
-      const { containingListDelimiter } = destination.selectionContext;
-      const newText =
-        containingListDelimiter == null || destination.position === "contents"
-          ? sourceText
-          : destination.position === "after"
-          ? containingListDelimiter + sourceText
-          : sourceText + containingListDelimiter;
+      // Get text adjusting for destination position
+      const text = getTextWithPossibleDelimiter(source, destination);
 
       // Add destination edit
       const result = [
         {
-          isSource: false,
+          range: destination.selection.selection as Range,
+          text,
           editor: destination.selection.editor,
           originalSelection: destination,
-          range: destination.selection.selection as Range,
-          text: newText,
+          isSource: false,
         },
       ];
 
       // Add source edit for move and swap
       // Prevent multiple instances of the same expanded source.
       if (this.type !== "bring" && !usedSources.includes(source)) {
-        let newText: string;
+        let text: string;
         let range: Range;
 
         if (this.type === "swap") {
-          newText = destination.selection.editor.document.getText(
+          text = destination.selection.editor.document.getText(
             destination.selection.selection
           );
           range = source.selection.selection;
-        } else {
-          // NB: this.type === "move"
-          newText = "";
-          range = performInsideOutsideAdjustment(source, "outside").selection
-            .selection;
+        }
+        // NB: this.type === "move"
+        else {
+          text = "";
+          range = performOutsideAdjustment(source).selection.selection;
         }
 
         usedSources.push(source);
         result.push({
-          isSource: true,
+          range,
+          text,
           editor: source.selection.editor,
           originalSelection: source,
-          range,
-          text: newText,
+          isSource: true,
         });
       }
 
@@ -206,15 +181,13 @@ class BringMoveSwap implements Action {
         thatMark
           .filter(({ isSource }) => isSource)
           .map(({ typedSelection }) => typedSelection),
-        decorationTypes.sourceStyle,
-        decorationTypes.sourceLineStyle
+        decorationTypes.sourceStyle
       ),
       displayPendingEditDecorations(
         thatMark
           .filter(({ isSource }) => !isSource)
           .map(({ typedSelection }) => typedSelection),
-        decorationTypes.destinationStyle,
-        decorationTypes.destinationLineStyle
+        decorationTypes.destinationStyle
       ),
     ]);
   }

src/actions/CopyLines.ts

@@ -46,8 +46,7 @@ class CopyLines implements Action {
   async run([targets]: [TypedSelection[]]): Promise<ActionReturnValue> {
     await displayPendingEditDecorations(
       targets,
-      this.graph.editStyles.referenced,
-      this.graph.editStyles.referencedLine
+      this.graph.editStyles.referenced
     );
 
     const thatMark = flatten(

src/actions/Find.ts

@@ -18,10 +18,14 @@ export class FindInFiles implements Action {
   async run([targets]: [TypedSelection[]]): Promise<ActionReturnValue> {
     ensureSingleTarget(targets);
 
-    const { returnValue: query, thatMark } =
-      await this.graph.actions.getText.run([targets]);
+    const {
+      returnValue: [query],
+      thatMark,
+    } = await this.graph.actions.getText.run([targets]);
 
-    await commands.executeCommand("workbench.action.findInFiles", { query });
+    await commands.executeCommand("workbench.action.findInFiles", {
+      query,
+    });
 
     return { returnValue: null, thatMark };
   }

src/actions/GetText.ts

@@ -16,24 +16,21 @@ export default class GetText implements Action {
 
   async run(
     [targets]: [TypedSelection[]],
-    showDecorations = true
+    { showDecorations = true } = {}
   ): Promise<ActionReturnValue> {
     if (showDecorations) {
       await displayPendingEditDecorations(
         targets,
-        this.graph.editStyles.referenced,
-        this.graph.editStyles.referencedLine
+        this.graph.editStyles.referenced
       );
     }
 
-    const text = targets
-      .map((target) =>
-        target.selection.editor.document.getText(target.selection.selection)
-      )
-      .join("\n");
+    const returnValue = targets.map((target) =>
+      target.selection.editor.document.getText(target.selection.selection)
+    );
 
     return {
-      returnValue: text,
+      returnValue,
       thatMark: targets.map((target) => target.selection),
     };
   }

src/actions/InsertEmptyLines.ts

@@ -24,7 +24,6 @@ class InsertEmptyLines implements Action {
     displayPendingEditDecorations(
       targets,
       this.graph.editStyles.referenced,
-      this.graph.editStyles.referencedLine
     );
 
     const edits = await runForEachEditor(

src/actions/Paste.ts

@@ -23,7 +23,6 @@ export default class Paste implements Action {
     await displayPendingEditDecorations(
       targets,
       this.graph.editStyles.pendingModification0,
-      this.graph.editStyles.pendingLineModification0
     );
 
     const text = await env.clipboard.readText();
@@ -78,7 +77,6 @@ export default class Paste implements Action {
     await displayPendingEditDecorations(
       thatMark.map(({ typedSelection }) => typedSelection),
       this.graph.editStyles.pendingModification0,
-      this.graph.editStyles.pendingLineModification0
     );
 
     return { returnValue: null, thatMark };

src/actions/ReplaceWithText.ts

@@ -0,0 +1,66 @@
+import {
+  Action,
+  ActionPreferences,
+  ActionReturnValue,
+  Graph,
+  TypedSelection,
+} from "../Types";
+import displayPendingEditDecorations from "../editDisplayUtils";
+import { runForEachEditor } from "../targetUtils";
+import { flatten, zip } from "lodash";
+import { maybeAddDelimiter } from "../getTextWithPossibleDelimiter";
+import { performEditsAndUpdateSelections } from "../updateSelections";
+
+export default class implements Action {
+  targetPreferences: ActionPreferences[] = [{ insideOutsideType: null }];
+
+  constructor(private graph: Graph) {
+    this.run = this.run.bind(this);
+  }
+
+  async run(
+    [targets]: [TypedSelection[]],
+    texts: string[]
+  ): Promise<ActionReturnValue> {
+    await displayPendingEditDecorations(
+      targets,
+      this.graph.editStyles.pendingModification0
+    );
+
+    // Broadcast single text for each target
+    if (texts.length === 1) {
+      texts = Array(targets.length).fill(texts[0]);
+    }
+
+    if (targets.length !== texts.length) {
+      throw new Error("Targets and texts must have same length");
+    }
+
+    const edits = zip(targets, texts).map(([target, text]) => ({
+      editor: target!.selection.editor,
+      range: target!.selection.selection,
+      text: maybeAddDelimiter(text!, target!),
+    }));
+
+    const thatMark = flatten(
+      await runForEachEditor(
+        edits,
+        (edit) => edit.editor,
+        async (editor, edits) => {
+          const [updatedSelections] = await performEditsAndUpdateSelections(
+            editor,
+            edits,
+            [targets.map((target) => target.selection.selection)]
+          );
+
+          return updatedSelections.map((selection) => ({
+            editor,
+            selection,
+          }));
+        }
+      )
+    );
+
+    return { returnValue: null, thatMark };
+  }
+}

src/actions/Scroll.ts

@@ -56,7 +56,7 @@ class Scroll implements Action {
 
     await displayDecorationsWhileRunningFunc(
       targets.map((target) => target.selection),
-      this.graph.editStyles.referencedLine,
+      this.graph.editStyles.referenced.line,
       scrollCallback,
       showAdditionalHighlightBeforeScroll
     );

src/actions/SetBreakpoint.ts

@@ -41,8 +41,7 @@ export default class SetBreakpoint implements Action {
   ]): Promise<ActionReturnValue> {
     await displayPendingEditDecorations(
       targets,
-      this.graph.editStyles.referenced,
-      this.graph.editStyles.referencedLine
+      this.graph.editStyles.referenced
     );
 
     const lines = targets.flatMap((target) => {

src/actions/copy.ts

@@ -18,8 +18,9 @@ export default class Copy implements Action {
     const { returnValue, thatMark } = await this.graph.actions.getText.run([
       targets,
     ]);
+    const text = returnValue.join("\n");
 
-    await env.clipboard.writeText(returnValue);
+    await env.clipboard.writeText(text);
 
     return { returnValue: null, thatMark };
   }