Merge pull request #633 from checkupjs/require-format-for-outputfile

.eslintrc

@@ -25,7 +25,8 @@
     "@typescript-eslint/no-unused-vars": "error",
     "no-global-assign": ["error", { "exceptions": ["console"] }],
     "unicorn/no-reduce": "off",
-    "unicorn/prevent-abbreviations": "off"
+    "unicorn/prevent-abbreviations": "off",
+    "unicorn/no-process-exit": "off"
   },
   "overrides": [
     {

packages/cli/src/commands/run.ts

@@ -89,7 +89,8 @@ export default class RunCommand extends BaseCommand {
     outputFile: flags.string({
       char: 'o',
       default: '',
-      description: 'Specify file to write report to.',
+      description:
+        'Specify file to write JSON output to. Requires the `--format` flag to be set to `json`',
     }),
     listTasks: flags.boolean({
       char: 'l',
@@ -111,6 +112,14 @@ export default class RunCommand extends BaseCommand {
   public async init() {
     let { argv, flags } = this.parse(RunCommand);
 
+    if (flags.outputFile && flags.format !== OutputFormat.json) {
+      this.error(
+        new Error(
+          'Missing --format flag. --format=json must also be provided when using --outputFile'
+        )
+      );
+    }
+
     this.runArgs = argv;
     this.runFlags = flags;
   }
@@ -161,6 +170,7 @@ export default class RunCommand extends BaseCommand {
             'Run `checkup --listTasks` to see available tasks'
           )
         );
+        ui.action.stop();
       }
     } else {
       [this.pluginTaskResults, this.pluginTaskErrors] = await this.pluginTasks.runTasks();