Added stage and unstage file as separate functions in the editor interface

Author: AndreasArvidsson

packages/common/src/types/TextEditor.ts

@@ -250,15 +250,25 @@ export interface EditableTextEditor extends TextEditor {
    */
   gitRevert(range?: Range): Promise<void>;
 
+  /**
+   * Git stage file
+   */
+  gitStageFile(): Promise<void>;
+
+  /**
+   * Git unstage file
+   */
+  gitUnstageFile(): Promise<void>;
+
   /**
    * Git stage range
    * @param range A {@link Range range}
    */
-  gitStage(range?: Range): Promise<void>;
+  gitStageRange(range?: Range): Promise<void>;
 
   /**
    * Git unstage range
    * @param range A {@link Range range}
    */
-  gitUnstage(range?: Range): Promise<void>;
+  gitUnstageRange(range?: Range): Promise<void>;
 }

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

@@ -46,7 +46,8 @@ abstract class SimpleIdeCommandAction {
       callback: (editor, targets) =>
         callback(
           editor,
-          acceptsLocation ? targets.map((t) => t.contentRange) : undefined,
+          targets.map((t) => t.contentRange),
+          acceptsLocation,
           this.command,
         ),
       setSelection: !acceptsLocation,
@@ -150,9 +151,12 @@ export class GitUnstage extends SimpleIdeCommandAction {
 
 function callback(
   editor: EditableTextEditor,
-  ranges: Range[] | undefined,
+  targetRanges: Range[],
+  acceptsLocation: boolean,
   command: CommandId,
 ): Promise<void> {
+  const ranges = acceptsLocation ? targetRanges : undefined;
+
   switch (command) {
     // Multi target actions
     case "toggleLineComment":
@@ -192,12 +196,25 @@ function callback(
     case "gitRevert":
       return editor.gitRevert(ranges?.[0]);
     case "gitStage":
-      return editor.gitStage(ranges?.[0]);
+      if (rangeIsEntireDocument(editor, targetRanges)) {
+        return editor.gitStageFile();
+      }
+      return editor.gitStageRange(ranges?.[0]);
     case "gitUnstage":
-      return editor.gitUnstage(ranges?.[0]);
+      if (rangeIsEntireDocument(editor, targetRanges)) {
+        return editor.gitUnstageFile();
+      }
+      return editor.gitUnstageRange(ranges?.[0]);
 
     // Unsupported as simple action
     case "highlight":
       throw Error("Highlight command not supported as simple action");
   }
 }
+
+function rangeIsEntireDocument(
+  editor: EditableTextEditor,
+  ranges: Range[],
+): boolean {
+  return ranges.length === 1 && ranges[0].isRangeEqual(editor.document.range);
+}

packages/cursorless-everywhere-talon-core/src/ide/TalonJsEditor.ts

@@ -163,11 +163,19 @@ export class TalonJsEditor implements EditableTextEditor {
     throw Error("gitRevert not implemented");
   }
 
-  public async gitStage(_range?: Range): Promise<void> {
-    throw Error("gitStage not implemented");
+  public async gitStageFile(): Promise<void> {
+    throw Error("gitStageFile not implemented");
   }
 
-  public async gitUnstage(_range?: Range): Promise<void> {
-    throw Error("gitUnstage not implemented");
+  public async gitUnstageFile(): Promise<void> {
+    throw Error("gitUnstageFile not implemented");
+  }
+
+  public async gitStageRange(_range?: Range): Promise<void> {
+    throw Error("gitStageRange not implemented");
+  }
+
+  public async gitUnstageRange(_range?: Range): Promise<void> {
+    throw Error("gitUnstageRange not implemented");
   }
 }

packages/cursorless-vscode/src/ide/vscode/VscodeTextEditorImpl.ts

@@ -251,26 +251,19 @@ export class VscodeTextEditorImpl implements EditableTextEditor {
     await vscode.commands.executeCommand("git.revertSelectedRanges");
   }
 
-  public async gitStage(_range?: Range): Promise<void> {
-    if (this.selectionIsEntireDocument()) {
-      await vscode.commands.executeCommand("git.stage");
-    } else {
-      await vscode.commands.executeCommand("git.stageSelectedRanges");
-    }
+  public async gitStageFile(): Promise<void> {
+    await vscode.commands.executeCommand("git.stage");
   }
 
-  public async gitUnstage(_range?: Range): Promise<void> {
-    if (this.selectionIsEntireDocument()) {
-      await vscode.commands.executeCommand("git.unstage");
-    } else {
-      await vscode.commands.executeCommand("git.unstageSelectedRanges");
-    }
+  public async gitUnstageFile(): Promise<void> {
+    await vscode.commands.executeCommand("git.unstage");
+  }
+
+  public async gitStageRange(_range?: Range): Promise<void> {
+    await vscode.commands.executeCommand("git.stageSelectedRanges");
   }
 
-  private selectionIsEntireDocument(): boolean {
-    return (
-      this.selections.length === 1 &&
-      this.selections[0].isRangeEqual(this.document.range)
-    );
+  public async gitUnstageRange(_range?: Range): Promise<void> {
+    await vscode.commands.executeCommand("git.unstageSelectedRanges");
   }
 }

packages/neovim-common/src/ide/neovim/NeovimTextEditorImpl.ts

@@ -199,11 +199,19 @@ export class NeovimTextEditorImpl implements EditableTextEditor {
     throw Error("gitRevert Not implemented");
   }
 
-  public async gitStage(_range?: Range): Promise<void> {
-    throw Error("gitStage Not implemented");
+  public async gitStageFile(): Promise<void> {
+    throw Error("gitStageFile not implemented");
   }
 
-  public async gitUnstage(_range?: Range): Promise<void> {
-    throw Error("gitUnstage Not implemented");
+  public async gitUnstageFile(): Promise<void> {
+    throw Error("gitUnstageFile not implemented");
+  }
+
+  public async gitStageRange(_range?: Range): Promise<void> {
+    throw Error("gitStageRange not implemented");
+  }
+
+  public async gitUnstageRange(_range?: Range): Promise<void> {
+    throw Error("gitUnstageRange not implemented");
   }
 }