feat: add requiresProject property

messages/messages.md

@@ -1,3 +1,7 @@
 # warning.security
 
 This command will expose sensitive information that allows for subsequent activity using your current authenticated session. Sharing this information is equivalent to logging someone in under the current credential, resulting in unintended access and escalation of privilege. For additional information, please review the authorization section of the https://developer.salesforce.com/docs/atlas.en-us.234.0.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm
+
+# errors.RequiresProject
+
+This command is required to run from within a Salesforce project directory.

src/sfCommand.ts

@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
-import { Messages } from '@salesforce/core';
+import { Messages, SfdxProject } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { Progress, Prompter, Spinner, Ux } from './ux';
 
@@ -33,14 +33,20 @@ export abstract class SfCommand<T> extends Command {
   public static envVariablesSection?: HelpSection;
   public static errorCodes?: HelpSection;
   public static tableFlags = CliUx.ux.table.flags;
+  public static requiresProject: boolean;
 
   public spinner: Spinner;
   public progress: Progress;
+  public project!: SfdxProject;
 
   private warnings: SfCommand.Warning[] = [];
   private ux: Ux;
   private prompter: Prompter;
 
+  protected get statics(): typeof SfCommand {
+    return this.constructor as typeof SfCommand;
+  }
+
   public constructor(argv: string[], config: Config) {
     super(argv, config);
     const outputEnabled = !this.jsonEnabled();
@@ -114,6 +120,13 @@ export abstract class SfCommand<T> extends Command {
     return this.prompter.prompt(questions, initialAnswers);
   }
 
+  public async _run<R>(): Promise<R | undefined> {
+    if (this.statics.requiresProject) {
+      this.project = await this.assignProject();
+    }
+    return super._run<R>();
+  }
+
   /**
    * Wrap the command result into the standardized JSON structure.
    */
@@ -138,6 +151,17 @@ export abstract class SfCommand<T> extends Command {
     };
   }
 
+  protected async assignProject(): Promise<SfdxProject> {
+    try {
+      return await SfdxProject.resolve();
+    } catch (err) {
+      if (err instanceof Error && err.name === 'InvalidProjectWorkspaceError') {
+        throw messages.createError('errors.RequiresProject');
+      }
+      throw err;
+    }
+  }
+
   public abstract run(): Promise<T>;
 }