@salesforce/sf-plugins-core 1.12.1 → 1.13.0

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.13.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.3...v1.13.0) (2022-06-09)
+
+### Features
+
+- catch method supports base and SfError ([2b9a038](https://github.com/salesforcecli/sf-plugins-core/commit/2b9a038713c77e1230e21f5cc6f8ae2a6aaab5be))
+
+### Bug Fixes
+
+- error can't be spread ([30930b7](https://github.com/salesforcecli/sf-plugins-core/commit/30930b74ff5e6b59116228d547362a284ad98388))
+
+### [1.12.3](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.2...v1.12.3) (2022-05-04)
+
+### Bug Fixes
+
+- prevent multiple starts of progress bar ([8ec788c](https://github.com/salesforcecli/sf-plugins-core/commit/8ec788cfda452d2c227631fde64e01786f6f6a49))
+- stop using once ([970fb80](https://github.com/salesforcecli/sf-plugins-core/commit/970fb808ad14a8d8bce0daabd78854c4a046e621))
+
+### [1.12.2](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.1...v1.12.2) (2022-05-03)
+
+### Bug Fixes
+
+- update error message ([182cfa3](https://github.com/salesforcecli/sf-plugins-core/commit/182cfa30beb4e7fe052a0453d141e19ba7129647))
+
 ### [1.12.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.0...v1.12.1) (2022-04-20)
 
 ### Bug Fixes

package/lib/sfCommand.d.ts

@@ -1,5 +1,5 @@
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
-import { SfProject, StructuredMessage } from '@salesforce/core';
+import { SfProject, StructuredMessage, SfError } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import * as chalk from 'chalk';
 import { Progress, Prompter, Spinner, Ux } from './ux';
@@ -114,9 +114,9 @@ export declare abstract class SfCommand<T> extends Command {
     /**
      * Wrap the command error into the standardized JSON structure.
      */
-    protected toErrorJson(error: Error): SfCommand.Error;
+    protected toErrorJson(error: SfCommand.Error): SfCommand.Error;
     protected assignProject(): Promise<SfProject>;
-    protected catch(error: SfCommand.Error): Promise<SfCommand.Error>;
+    protected catch(error: Error | SfError | SfCommand.Error): Promise<SfCommand.Error>;
     /**
      * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',
      * When there are actions, we add 'Try this:' in blue
@@ -153,6 +153,8 @@ export declare namespace SfCommand {
         actions?: string[];
         code?: unknown;
         exitCode?: number;
+        data?: unknown;
+        context?: string;
     }
 }
 //# sourceMappingURL=sfCommand.d.ts.map

package/lib/sfCommand.js

@@ -178,12 +178,8 @@ class SfCommand extends core_1.Command {
      * Wrap the command error into the standardized JSON structure.
      */
     toErrorJson(error) {
-        var _a;
         return {
-            status: (_a = process.exitCode) !== null && _a !== void 0 ? _a : 1,
-            stack: error.stack,
-            name: error.name,
-            message: error.message,
+            ...error,
             warnings: this.warnings,
         };
     }
@@ -200,15 +196,30 @@ class SfCommand extends core_1.Command {
     }
     async catch(error) {
         var _a, _b;
-        process.exitCode = (_b = (_a = process.exitCode) !== null && _a !== void 0 ? _a : error.exitCode) !== null && _b !== void 0 ? _b : 1;
+        // transform an unknown error into one that conforms to the interface
+        const codeFromError = error instanceof core_2.SfError ? error.exitCode : 1;
+        (_a = process.exitCode) !== null && _a !== void 0 ? _a : (process.exitCode = codeFromError);
+        const sfErrorProperties = error instanceof core_2.SfError
+            ? { data: error.data, actions: error.actions, code: codeFromError, context: error.context }
+            : {};
+        const sfCommandError = {
+            ...sfErrorProperties,
+            ...{
+                message: error.message,
+                name: (_b = error.name) !== null && _b !== void 0 ? _b : 'Error',
+                status: process.exitCode,
+                stack: error.stack,
+                exitCode: process.exitCode,
+            },
+        };
         if (this.jsonEnabled()) {
-            core_1.CliUx.ux.styledJSON(this.toErrorJson(error));
+            core_1.CliUx.ux.styledJSON(this.toErrorJson(sfCommandError));
         }
         else {
             // eslint-disable-next-line no-console
-            console.error(this.formatError(error));
+            console.error(this.formatError(sfCommandError));
         }
-        return error;
+        return sfCommandError;
     }
     /**
      * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',

package/lib/ux/progress.d.ts

@@ -6,6 +6,7 @@ export declare class Progress extends UxBase {
     private static DEFAULT_OPTIONS;
     private bar;
     private total;
+    private started;
     constructor(outputEnabled: boolean);
     /**
      * Set the total number of expected components.
@@ -27,7 +28,6 @@ export declare class Progress extends UxBase {
      * Stop the progress bar.
      */
     stop(): void;
-    private _start;
 }
 export declare namespace Progress {
     type Bar = {

package/lib/ux/progress.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Progress = void 0;
 const util = require("util");
 const core_1 = require("@oclif/core");
-const kit_1 = require("@salesforce/kit");
 const _1 = require(".");
 /**
  * Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.
@@ -17,6 +16,7 @@ const _1 = require(".");
 class Progress extends _1.UxBase {
     constructor(outputEnabled) {
         super(outputEnabled);
+        this.started = false;
     }
     /**
      * Set the total number of expected components.
@@ -30,17 +30,23 @@ class Progress extends _1.UxBase {
      * Start the progress bar.
      */
     start(total, payload = {}, options = Progress.DEFAULT_OPTIONS) {
-        const opts = Object.assign(Progress.DEFAULT_OPTIONS, options);
-        opts.format = util.format(opts.format, opts.title);
-        this.bar = core_1.CliUx.ux.progress({
-            format: opts.format,
-            barCompleteChar: opts.barCompleteChar,
-            barIncompleteChar: opts.barIncompleteChar,
-            linewrap: opts.linewrap,
-        });
-        this.bar.setTotal(total);
+        if (this.started)
+            return;
+        this.started = true;
         this.maybeNoop(() => {
-            this._start(total, payload);
+            const opts = Object.assign(Progress.DEFAULT_OPTIONS, options);
+            opts.format = util.format(opts.format, opts.title);
+            this.bar = core_1.CliUx.ux.progress({
+                format: opts.format,
+                barCompleteChar: opts.barCompleteChar,
+                barIncompleteChar: opts.barIncompleteChar,
+                linewrap: opts.linewrap,
+            });
+            this.bar.setTotal(total);
+            this.bar.start(total);
+            if (Object.keys(payload).length) {
+                this.bar.update(0, payload);
+            }
         });
     }
     /**
@@ -66,15 +72,6 @@ class Progress extends _1.UxBase {
         if (this.bar)
             this.bar.stop();
     }
-    _start(total, payload = {}) {
-        const start = (0, kit_1.once)((bar, t, p = {}) => {
-            bar.start(t);
-            if (Object.keys(p).length) {
-                bar.update(0, p);
-            }
-        });
-        start(this.bar, total, payload);
-    }
 }
 exports.Progress = Progress;
 Progress.DEFAULT_OPTIONS = {

package/messages/messages.md

@@ -24,7 +24,7 @@ The id must begin with %s.
 
 # errors.NoDefaultEnv
 
-No default environment found. Use -e or --target-org to specify an environment.
+No default environment found. Use -o or --target-org to specify an environment.
 
 # errors.NoDefaultDevHub
 
@@ -40,7 +40,7 @@ Override the api version used for api requests made by this command
 
 # flags.apiVersion.overrideWarning
 
-apiVersion configuration overridden at %s
+org-api-version configuration overridden at %s
 
 # flags.apiVersion.warning.deprecated
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,9 +32,9 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.6.3",
-    "@salesforce/core": "^3.11.0",
-    "@salesforce/kit": "^1.5.34",
+    "@oclif/core": "^1.9.0",
+    "@salesforce/core": "^3.19.2",
+    "@salesforce/kit": "^1.5.41",
     "@salesforce/ts-types": "^1.5.20",
     "chalk": "^4",
     "inquirer": "^8.2.0"