@salesforce/sf-plugins-core 1.0.5 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 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.1.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.5...v1.1.0) (2022-01-03)
+
+### Features
+
+- add spinner methods ([f209f8f](https://github.com/salesforcecli/sf-plugins-core/commit/f209f8f4e6736b9de91e37f865d66b5356e5abec))
+
+### Bug Fixes
+
+- add status method ([9cf2069](https://github.com/salesforcecli/sf-plugins-core/commit/9cf20694d76e2509785b7c8faa4bd63ab190707e))
+- make status a getter/setter ([441c55a](https://github.com/salesforcecli/sf-plugins-core/commit/441c55acd3d811664213e9801a8bcc270e3aca7b))
+
 ### [1.0.5](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.4...v1.0.5) (2021-12-16)
 
 ### Bug Fixes

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021, Salesforce.com, Inc.
+Copyright (c) 2022, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/sfCommand.d.ts

@@ -1,4 +1,5 @@
-import { Command, HelpSection, Interfaces } from '@oclif/core';
+import { Command, Config, HelpSection, Interfaces } from '@oclif/core';
+import { Spinner } from './ux';
 export interface SfCommandInterface extends Interfaces.Command {
     configurationVariablesSection?: HelpSection;
     envVariablesSection?: HelpSection;
@@ -17,7 +18,9 @@ export declare abstract class SfCommand<T> extends Command {
     static configurationVariablesSection?: HelpSection;
     static envVariablesSection?: HelpSection;
     static errorCodes?: HelpSection;
+    spinner: Spinner;
     private warnings;
+    constructor(argv: string[], config: Config);
     /**
      * Log warning to users. If --json is enabled, then the warning
      * will be added to the json output under the warnings property.

package/lib/sfCommand.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SfCommand = void 0;
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
+const ux_1 = require("./ux");
 core_2.Messages.importMessagesDirectory(__dirname);
 const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
 /**
@@ -20,9 +21,10 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * @see https://github.com/oclif/core/blob/main/src/command.ts
  */
 class SfCommand extends core_1.Command {
-    constructor() {
-        super(...arguments);
+    constructor(argv, config) {
+        super(argv, config);
         this.warnings = [];
+        this.spinner = new ux_1.Spinner(this.jsonEnabled());
     }
     /**
      * Log warning to users. If --json is enabled, then the warning

package/lib/ux.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This class is a light wrapper around cli.action that allows us to
+ * automatically suppress any actions if `--json` flag is present.
+ */
+export declare class Spinner {
+    private jsonEnabled;
+    constructor(jsonEnabled: boolean);
+    /**
+     * Start a spinner on the console.
+     */
+    start(action: string, status?: string, opts?: {
+        stdout?: boolean;
+    }): void;
+    /**
+     * Stop the spinner on the console.
+     */
+    stop(msg?: string): void;
+    /**
+     * Set the status of the current spinner.
+     */
+    set status(status: string | undefined);
+    /**
+     * Get the status of the current spinner.
+     */
+    get status(): string | undefined;
+    /**
+     * Pause the spinner on the console.
+     */
+    pause(fn: () => unknown, icon?: string): void;
+}

package/lib/ux.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Spinner = void 0;
+const cli_ux_1 = require("cli-ux");
+/**
+ * This class is a light wrapper around cli.action that allows us to
+ * automatically suppress any actions if `--json` flag is present.
+ */
+class Spinner {
+    constructor(jsonEnabled) {
+        this.jsonEnabled = jsonEnabled;
+    }
+    /**
+     * Start a spinner on the console.
+     */
+    start(action, status, opts) {
+        if (!this.jsonEnabled)
+            cli_ux_1.cli.action.start(action, status, opts);
+    }
+    /**
+     * Stop the spinner on the console.
+     */
+    stop(msg) {
+        if (!this.jsonEnabled)
+            cli_ux_1.cli.action.stop(msg);
+    }
+    /**
+     * Set the status of the current spinner.
+     */
+    set status(status) {
+        if (!this.jsonEnabled)
+            cli_ux_1.cli.action.status = status;
+    }
+    /**
+     * Get the status of the current spinner.
+     */
+    get status() {
+        return cli_ux_1.cli.action.status;
+    }
+    /**
+     * Pause the spinner on the console.
+     */
+    pause(fn, icon) {
+        if (!this.jsonEnabled)
+            cli_ux_1.cli.action.pause(fn, icon);
+    }
+}
+exports.Spinner = Spinner;
+//# sourceMappingURL=ux.js.map

package/package.json

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