changeDirectoryToWorkspaceRoot will return to previous dir

In windows use pushd and popd to change directory. In bash we can use a
subshell which has the benefit of guaranteeing that we return to the
original directory without needing to run a second command.

Author: andy-farmfocus

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the "spec-runner" extension will be documented in this file.
 
+## [4.0.0]
+
+- Changing directory to workspace root will now return to the previous directory after the command has finished
+  - (I don't have access to a windows machine so have done my best but can't guarantee that it isn't broken)
+
 ## [3.11.0]
 
 - Remove underline for passed tests to reduce visual noise

package.json

@@ -9,7 +9,7 @@
 	},
 	"icon": "images/icon.png",
 	"license": "MIT",
-	"version": "3.11.0",
+	"version": "4.0.0",
 	"engines": {
 		"vscode": "^1.94.0"
 	},

src/minitest/MinitestRunner.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import SpecRunnerConfig, { TerminalClear } from '../SpecRunnerConfig';
-import { cmdJoin, quote, remapPath, stringifyEnvs, teeCommand } from '../util';
+import { cdCommands, cmdJoin, quote, remapPath, stringifyEnvs, teeCommand } from '../util';
 import SpecResultPresenter from '../SpecResultPresenter';
 import { RubyDebugger, RunRspecOrMinitestArg } from '../types';
 
@@ -122,21 +122,33 @@ export class MinitestRunner {
     }
     const minitestArgs = [quote(testFile), testNameFilter].filter(Boolean).join(' -- ');
 
-    const cdCommand = this.buildChangeDirectoryToWorkspaceRootCommand();
+    const [cdCommand, returnCommand] = this.buildChangeDirectoryToWorkspaceRootCommand();
     const minitestCommand = [stringifyEnvs(this.config.minitestEnv), this.config.minitestCommand, minitestArgs].filter(Boolean).join(' ');
 
     const lineNumber = lines.length ? JSON.stringify(lines) : 'ALL';
     const saveRunOptions = cmdJoin(`echo ${fileName} > ${this.outputFilePath}`, `echo ${quote(lineNumber)} >> ${this.outputFilePath}`);
     const outputRedirect = `| ${teeCommand(this.outputFilePath, true, this.config.usingBashInWindows)}`;
+
+    let fullCommand;
     if (this.config.minitestDecorateEditorWithResults) {
-      return cmdJoin(cdCommand, saveRunOptions, [minitestCommand, outputRedirect].filter(Boolean).join(' '));
+      fullCommand = cmdJoin(cdCommand, saveRunOptions, [minitestCommand, outputRedirect].filter(Boolean).join(' '));
+    } else {
+      fullCommand = cmdJoin(cdCommand, minitestCommand);
     }
 
-    return cmdJoin(cdCommand, minitestCommand);
+    if (returnCommand === false) {
+      return `(${fullCommand})`;
+    } else {
+      return cmdJoin(fullCommand, returnCommand);
+    }
   }
 
   private buildChangeDirectoryToWorkspaceRootCommand() {
-    return this.config.changeDirectoryToWorkspaceRoot ? `cd ${quote(this.config.projectPath)}` : '';
+    if (!this.config.changeDirectoryToWorkspaceRoot) {
+      return ['', ''];
+    }
+
+    return cdCommands(this.config.projectPath, this.config.usingBashInWindows);
   }
 
   private remappedPath(filePath: string) {

src/rspec/SpecRunner.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import SpecRunnerConfig, { TerminalClear } from '../SpecRunnerConfig';
-import { cmdJoin, quote, remapPath, stringifyEnvs } from '../util';
+import { cdCommands, cmdJoin, quote, remapPath, stringifyEnvs } from '../util';
 import SpecResultPresenter from '../SpecResultPresenter';
 import { RubyDebugger, RunRspecOrMinitestArg } from '../types';
 
@@ -117,17 +117,23 @@ export class SpecRunner {
     const format = `-f ${this.config.rspecFormat}`;
     const jsonOutput = this.config.rspecDecorateEditorWithResults ? `-f j --out ${quote(this.outputFilePath)}` : '';
 
-    const cdCommand = this.buildChangeDirectoryToWorkspaceRootCommand();
+    const [cdCommand, returnCommand] = this.buildChangeDirectoryToWorkspaceRootCommand();
     const rspecCommand = [stringifyEnvs(this.config.rspecEnv), this.config.rspecCommand, failedOnlyModifier, format, jsonOutput, quote(file)].filter(Boolean).join(' ');
-    return cmdJoin(cdCommand, rspecCommand);
+
+    const fullCommand = cmdJoin(cdCommand, rspecCommand, returnCommand || '');
+    return returnCommand === false ? `(${fullCommand})` : fullCommand;
   }
 
   private remappedPath(filePath: string) {
     return remapPath(filePath, this.config.rewriteTestPaths);
   }
 
   private buildChangeDirectoryToWorkspaceRootCommand() {
-    return this.config.changeDirectoryToWorkspaceRoot ? `cd ${quote(this.config.projectPath)}` : '';
+    if (!this.config.changeDirectoryToWorkspaceRoot) {
+      return ['', ''];
+    }
+
+    return cdCommands(this.config.projectPath, this.config.usingBashInWindows);
   }
 
   private async runTerminalCommand(command: string) {

src/util.ts

@@ -16,9 +16,23 @@ export function teeCommand(outputFile: string, append = false, bashInWindowsOver
   return command.join(' ');
 }
 
-// Windows will still execute second command even if first command fails.
-export function cmdJoin(...args: string[]): string {
-  return args.filter(Boolean).join(isWindows() ? '; ' : ' && ');
+/**
+ * Returns two commands, the cdCommand and the returnCommand.
+ *
+ * If the returnCommand is false, then that means we should use a subshell to handle
+ * returning to the current directory.
+ */
+export function cdCommands(path: string, bashInWindowsOverride = false): [string, string | false] {
+  if (isWindows() && !bashInWindowsOverride) {
+    return [`pushd ${quote(path)} >nul`, 'popd >nul'];
+  }
+  return [`cd ${quote(path)}`, false];
+}
+
+export function cmdJoin(...args: Array<string>): string {
+  return args
+    .filter(Boolean)
+    .join(isWindows() ? '; ' : ' && ');
 }
 
 export function isRspecOutput(output: any): output is RspecOutput {