@salesforce/sf-plugins-core 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.3.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.2.1...v1.3.0) (2022-02-23)
+
+### Features
+
+- add requiresProject property ([5ff0cf3](https://github.com/salesforcecli/sf-plugins-core/commit/5ff0cf34fffe896e1ed312585705ff13436e58cf))
+
 ### [1.2.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.2.0...v1.2.1) (2022-01-27)
 
 ### Bug Fixes

package/lib/sfCommand.d.ts

@@ -1,4 +1,5 @@
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
+import { SfdxProject } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { Progress, Prompter, Spinner, Ux } from './ux';
 export interface SfCommandInterface extends Interfaces.Command {
@@ -20,11 +21,14 @@ export declare abstract class SfCommand<T> extends Command {
     static envVariablesSection?: HelpSection;
     static errorCodes?: HelpSection;
     static tableFlags: typeof CliUx.Table.table.flags;
+    static requiresProject: boolean;
     spinner: Spinner;
     progress: Progress;
+    project: SfdxProject;
     private warnings;
     private ux;
     private prompter;
+    protected get statics(): typeof SfCommand;
     constructor(argv: string[], config: Config);
     /**
      * Log warning to users. If --json is enabled, then the warning
@@ -66,6 +70,7 @@ export declare abstract class SfCommand<T> extends Command {
      * }
      */
     prompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
+    _run<R>(): Promise<R | undefined>;
     /**
      * Wrap the command result into the standardized JSON structure.
      */
@@ -74,6 +79,7 @@ export declare abstract class SfCommand<T> extends Command {
      * Wrap the command error into the standardized JSON structure.
      */
     protected toErrorJson(error: Error): SfCommand.Error;
+    protected assignProject(): Promise<SfdxProject>;
     abstract run(): Promise<T>;
 }
 export declare namespace SfCommand {

package/lib/sfCommand.js

@@ -30,6 +30,9 @@ class SfCommand extends core_1.Command {
         this.ux = new ux_1.Ux(outputEnabled);
         this.prompter = new ux_1.Prompter();
     }
+    get statics() {
+        return this.constructor;
+    }
     /**
      * Log warning to users. If --json is enabled, then the warning
      * will be added to the json output under the warnings property.
@@ -87,6 +90,12 @@ class SfCommand extends core_1.Command {
     async prompt(questions, initialAnswers) {
         return this.prompter.prompt(questions, initialAnswers);
     }
+    async _run() {
+        if (this.statics.requiresProject) {
+            this.project = await this.assignProject();
+        }
+        return super._run();
+    }
     /**
      * Wrap the command result into the standardized JSON structure.
      */
@@ -111,6 +120,17 @@ class SfCommand extends core_1.Command {
             warnings: this.warnings,
         };
     }
+    async assignProject() {
+        try {
+            return await core_2.SfdxProject.resolve();
+        }
+        catch (err) {
+            if (err instanceof Error && err.name === 'InvalidProjectWorkspaceError') {
+                throw messages.createError('errors.RequiresProject');
+            }
+            throw err;
+        }
+    }
 }
 exports.SfCommand = SfCommand;
 SfCommand.enableJsonFlag = true;

package/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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",