fix: write test classes to a text file to ensure clean output

Author: mcarvin8

README.md

@@ -22,17 +22,19 @@ chore: add sandbox refresh class Apex::PrepareMySandboxTest::Apex`
 fix: fix quoting issues Apex::QuoteControllerTest::Apex`
 ```
 
-The 3 commit messages above will be parsed and the plugin will return the following space-separated string, sorted alphabetically:
+The 3 commit messages above will be parsed to retrieve all test classes found using the regular expression. Test classes can be separated by commas, spaces, or both in the commit message. This plugin will separate all tests by a single space and sort them alphabetically when creating the final output.
 
 ```
 AccountTriggerHandlerTest OpportunityTriggerHandlerTest PrepareMySandboxTest QuoteControllerTest
 ```
 
-You could then pass the plugin's output to the `sf project deploy` command:
+This plugin will also save its output to a text file, `runTests.txt` by default unless you provide a different file path via the `--output` flag.
 
-```
-testclasses=$(sf apex-tests-git-delta delta --from "sha_hash" --to "sha_hash")
+You could then save the contents of this text file to a variable and use that variable in the `sf project deploy` command:
 
+```
+sf apex-tests-git-delta delta --from "c7603c25581afe7c443c57e687f2d6abd654ea77" --to "HEAD" --output "runTests.txt"
+testclasses=$(<runTests.txt)
 sf project deploy start -x manifest/package.xml -l RunSpecifiedTests -t $testclasses
 ```
 
@@ -62,12 +64,13 @@ Recommend running this command in your project's root directory.
 
 ```
 USAGE
-  $ sf apex-tests-git-delta delta -f <value> -t <value> -e <value> [--json]
+  $ sf apex-tests-git-delta delta -f <value> -t <value> -e <value> --output <value> [--json]
 
 FLAGS
   -f, --from=<value> Git commit SHA from where the commit message log is done. This SHA's commit message will be included in the results.
   -t, --to=<value> [default: HEAD] Git commit SHA to where the commit message log is done.
   -e, --regular-expression=<value> [default: regex.txt] The text file containing the Apex Tests regular expression to search for.
+  --output=<value> [default: runTests.txt] The text file to save the delta test classes to.
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -76,5 +79,5 @@ DESCRIPTION
   Given 2 git commits, this plugin will parse all of the commit messages between this range, including the '--from' commit, and return the delta Apex test class string. This can be used to execute delta deployments.
 
 EXAMPLES
-    $ sf apex-tests-git-delta delta --from "abcdef" --to "ghifb" --regular-expression "regex.txt"
+    $ sf apex-tests-git-delta delta --from "abcdef" --to "ghifb" --regular-expression "regex.txt" --output "runTests.txt"
 ```

messages/delta.md

@@ -8,7 +8,7 @@ Given 2 git commits, this plugin will parse all of the commit messages between t
 
 # examples
 
-- `sf apex-tests-git-delta delta --from "abcdef" --to "ghifb" --regular-expression "regex.txt"`
+- `sf apex-tests-git-delta delta --from "abcdef" --to "ghifb" --regular-expression "regex.txt" --output "runTests.txt"`
 
 # flags.from.summary
 
@@ -21,3 +21,7 @@ Git commit SHA to where the commit message log is done.
 # flags.regular-expression.summary
 
 The text file containing the Apex Tests regular expression to search for.
+
+# flags.output.summary
+
+The text file to save the delta test classes to.

src/commands/apex-tests-git-delta/delta.ts

@@ -1,5 +1,7 @@
 'use strict';
 
+import * as fs from 'node:fs';
+
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { TO_DEFAULT_VALUE } from '../../constants/gitConstants.js';
@@ -36,16 +38,24 @@ export default class ApexTestDelta extends SfCommand<TestDeltaResult> {
       exists: true,
       default: 'regex.txt',
     }),
+    'output': Flags.file({
+      summary: messages.getMessage('flags.output.summary'),
+      required: true,
+      exists: false,
+      default: 'runTests.txt',
+    }),
   };
 
   public async run(): Promise<TestDeltaResult> {
     const { flags } = await this.parse(ApexTestDelta);
     const toGitRef = flags['to'];
     const fromGitRef = flags['from'];
     const regExFile = flags['regular-expression'];
+    const output = flags['output'];
 
     const deltaTests = extractTestClasses(fromGitRef, toGitRef, regExFile);
     this.log(deltaTests);
+    fs.writeFileSync(output, deltaTests);
 
     return { tests: deltaTests };
   }