Add support for setting test output file path

Author: andy-farmfocus

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the "spec-runner" extension will be documented in this file.
 
+## [4.1.0]
+
+- Add config item `ruby-spec-runner.outputFilePath` to aid with running rspec via guard.
+
 ## [4.0.1]
 
 - Fix issue with changeDirectoryToWorkspaceRoot setting and fish shell (fixes #11, thanks @steveclarke)

README.md

@@ -65,6 +65,7 @@ This extension contributes the following settings:
 - `ruby-spec-runner.clearTerminalOnTestRun`: Clear the terminal before running a test command
 - `ruby-spec-runner.rubyDebugger`: Select which debugging extension to use
 - `ruby-spec-runner.rewriteTestPaths`: Change the test path that is run. See [Rewriting the test file path](#rewriting-the-test-file-path) for more info.
+- `ruby-spec-runner.outputFilePath`: Specify the test output file path. Having a predictable path can allow for test runs to be triggered by other programs (eg guard)
 
 ### Rewriting the test file path
 

package.json

@@ -9,7 +9,7 @@
 	},
 	"icon": "images/icon.png",
 	"license": "MIT",
-	"version": "4.0.1",
+	"version": "4.1.0",
 	"engines": {
 		"vscode": "^1.94.0"
 	},
@@ -270,6 +270,12 @@
 							}
 						}
 					}
+				},
+				"ruby-spec-runner.outputFilePath": {
+					"type": "string",
+					"default": "",
+					"markdownDescription": "Specify the absolute path (e.g. `/path/to/my/rspec-results.json`) for the test result output. Useful for triggering rspec manually (eg from Guard).\n\nUses a temp file if left blank. **Changes require vscode restart**",
+					"scope": "window"
 				}
 			}
 		}

src/SpecRunnerConfig.ts

@@ -165,6 +165,16 @@ export class SpecRunnerConfig {
       ));
   }
 
+  get outputFilePath(): string | undefined {
+    const config = vscode.workspace.getConfiguration().get<string>('ruby-spec-runner.outputFilePath');
+    return config?.trim() === '' ? undefined : config;
+  }
+
+  get usingCustomOutputPath(): boolean {
+    // eslint-disable-next-line eqeqeq
+    return this.outputFilePath != undefined;
+  }
+
   private getBooleanConfig(key: string, defaultValue: boolean) {
     const result = vscode.workspace.getConfiguration().get(key) as boolean | undefined;
     // eslint-disable-next-line eqeqeq

src/rspec/SpecResultInterpreter.ts

@@ -12,7 +12,7 @@ export class SpecResultInterpreter {
   private config: SpecRunnerConfig;
   private presenter: SpecResultPresenter;
 
-  private _tmpOutputFile!: tmp.FileResult;
+  private _outputFile!: tmp.FileResult;
 
   constructor(config: SpecRunnerConfig, context: vscode.ExtensionContext, presenter: SpecResultPresenter) {
     this.config = config;
@@ -160,7 +160,26 @@ export class SpecResultInterpreter {
   }
 
   private get outputFile() {
-    return this._tmpOutputFile ||= this.createTempFile();
+
+    return this._outputFile ||= (this.config.usingCustomOutputPath ? this.createOutputFile() : this.createTempFile());
+  }
+
+  private createOutputFile() {
+    if (!this.config.outputFilePath) {
+      throw new Error('Output file path is not set');
+    }
+
+    vscode.workspace.fs.writeFile(vscode.Uri.file(this.config.outputFilePath), Buffer.from(''))
+
+    const file: tmp.FileResult = {
+      name: this.config.outputFilePath,
+      fd: -1,  // dummy fd since we're not using real tmp file
+      removeCallback: () => {} // dummy callback since we don't need to remove custom files
+    };
+
+    chokidar.watch(file.name).on('change', (_event, _path) => this.updateFromOutputFile());
+
+    return file;
   }
 
   private createTempFile() {