@salesforce/sf-plugins-core 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -2,143 +2,149 @@
 
 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.0.2](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.1...v1.0.2) (2021-10-11)
+## [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
 
-* bump oclif and sfdx-core versions ([3d38a70](https://github.com/salesforcecli/sf-plugins-core/commit/3d38a70dcad79aa151529bf51d281f68fe92a3ce))
+- 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.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.0...v1.0.1) (2021-10-06)
+### [1.0.5](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.4...v1.0.5) (2021-12-16)
+
+### Bug Fixes
+
+- bump dependencies ([4f78d8c](https://github.com/salesforcecli/sf-plugins-core/commit/4f78d8c940aab41bb406c45a9df98f686e626d28))
+
+### [1.0.4](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.3...v1.0.4) (2021-10-13)
+
+### Bug Fixes
+
+- bump module versions ([abdf5e3](https://github.com/salesforcecli/sf-plugins-core/commit/abdf5e37205b464a36393ca1887ce90a7c1ba302))
+
+### [1.0.3](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.2...v1.0.3) (2021-10-12)
+
+### [1.0.2](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.1...v1.0.2) (2021-10-11)
 
+### Bug Fixes
+
+- bump oclif and sfdx-core versions ([3d38a70](https://github.com/salesforcecli/sf-plugins-core/commit/3d38a70dcad79aa151529bf51d281f68fe92a3ce))
+
+### [1.0.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.0.0...v1.0.1) (2021-10-06)
 
 ### Bug Fixes
 
-* update inquirer ([067bbfb](https://github.com/salesforcecli/sf-plugins-core/commit/067bbfbbfcd271ae25260e6b83452093b1fe4deb))
+- update inquirer ([067bbfb](https://github.com/salesforcecli/sf-plugins-core/commit/067bbfbbfcd271ae25260e6b83452093b1fe4deb))
 
 ## [1.0.0](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.28...v1.0.0) (2021-09-29)
 
 ### [0.0.28](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.27...v0.0.28) (2021-09-29)
 
-
 ### Bug Fixes
 
-* allow empty message in logSensitive ([5b8edf5](https://github.com/salesforcecli/sf-plugins-core/commit/5b8edf509647887500d9e71b506939b3cc6945d9))
+- allow empty message in logSensitive ([5b8edf5](https://github.com/salesforcecli/sf-plugins-core/commit/5b8edf509647887500d9e71b506939b3cc6945d9))
 
 ### [0.0.27](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.26...v0.0.27) (2021-09-29)
 
-
 ### Bug Fixes
 
-* publish messages ([91a6aa6](https://github.com/salesforcecli/sf-plugins-core/commit/91a6aa6c396f9b33049407820d0b8bd9caaa30f4))
+- publish messages ([91a6aa6](https://github.com/salesforcecli/sf-plugins-core/commit/91a6aa6c396f9b33049407820d0b8bd9caaa30f4))
 
 ### [0.0.26](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.25...v0.0.26) (2021-09-29)
 
-
 ### Features
 
-* logSensitive, capture warnings ([a8b3e76](https://github.com/salesforcecli/sf-plugins-core/commit/a8b3e76ff20806b136ee606797b84a70c8f5a528))
+- logSensitive, capture warnings ([a8b3e76](https://github.com/salesforcecli/sf-plugins-core/commit/a8b3e76ff20806b136ee606797b84a70c8f5a528))
 
 ### [0.0.25](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.24...v0.0.25) (2021-09-21)
 
-
 ### Bug Fixes
 
-* add envirnment type to env list ([8f020df](https://github.com/salesforcecli/sf-plugins-core/commit/8f020dfc8695be19a7fd1f4b811b8c2b8c321418))
+- add envirnment type to env list ([8f020df](https://github.com/salesforcecli/sf-plugins-core/commit/8f020dfc8695be19a7fd1f4b811b8c2b8c321418))
 
 ### [0.0.24](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.23...v0.0.24) (2021-09-16)
 
-
 ### Bug Fixes
 
-* allow null for EnvDisplay ([0868d3f](https://github.com/salesforcecli/sf-plugins-core/commit/0868d3f0ed23e28c53ce11cb447e41b9b0144ac1))
+- allow null for EnvDisplay ([0868d3f](https://github.com/salesforcecli/sf-plugins-core/commit/0868d3f0ed23e28c53ce11cb447e41b9b0144ac1))
 
 ### [0.0.23](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.22...v0.0.23) (2021-09-15)
 
-
 ### Bug Fixes
 
-* update to latest oclif/core and enable json flag ([b486ef1](https://github.com/salesforcecli/sf-plugins-core/commit/b486ef173b27ba465cc8fddf53e3a53d339f8734))
+- update to latest oclif/core and enable json flag ([b486ef1](https://github.com/salesforcecli/sf-plugins-core/commit/b486ef173b27ba465cc8fddf53e3a53d339f8734))
 
 ### [0.0.22](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.21...v0.0.22) (2021-09-15)
 
-
 ### Bug Fixes
 
-* bump oclif/core ([c7a07f7](https://github.com/salesforcecli/sf-plugins-core/commit/c7a07f7671699197f3db93ec750e009eb9dfd56f))
+- bump oclif/core ([c7a07f7](https://github.com/salesforcecli/sf-plugins-core/commit/c7a07f7671699197f3db93ec750e009eb9dfd56f))
 
 ### [0.0.21](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.20...v0.0.21) (2021-09-14)
 
-
 ### Bug Fixes
 
-* move sf command to this repo ([968f80f](https://github.com/salesforcecli/sf-plugins-core/commit/968f80f0b8aecd0d47fe8d428c605117828f886f))
+- move sf command to this repo ([968f80f](https://github.com/salesforcecli/sf-plugins-core/commit/968f80f0b8aecd0d47fe8d428c605117828f886f))
 
 ### [0.0.20](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.19...v0.0.20) (2021-09-14)
 
 ### [0.0.19](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.18...v0.0.19) (2021-09-13)
 
-
 ### Features
 
-* add logout hook ([4a4d79b](https://github.com/salesforcecli/sf-plugins-core/commit/4a4d79bcd9f2017e70f75967bb0661ae3eb4aa4a))
+- add logout hook ([4a4d79b](https://github.com/salesforcecli/sf-plugins-core/commit/4a4d79bcd9f2017e70f75967bb0661ae3eb4aa4a))
 
 ### [0.0.18](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.17...v0.0.18) (2021-09-10)
 
-
 ### Bug Fixes
 
-* missed export ([63086ae](https://github.com/salesforcecli/sf-plugins-core/commit/63086aee3dc26c6f674c0bad8054205ed3992597))
+- missed export ([63086ae](https://github.com/salesforcecli/sf-plugins-core/commit/63086aee3dc26c6f674c0bad8054205ed3992597))
 
 ### [0.0.17](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.16...v0.0.17) (2021-09-10)
 
-
 ### Features
 
-* add help section helper function ([379d14f](https://github.com/salesforcecli/sf-plugins-core/commit/379d14f45eedc46736f64bb5c37a7f906e235d4c))
+- add help section helper function ([379d14f](https://github.com/salesforcecli/sf-plugins-core/commit/379d14f45eedc46736f64bb5c37a7f906e235d4c))
 
 ### [0.0.16](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.15...v0.0.16) (2021-09-08)
 
-
 ### Bug Fixes
 
-* bump oclif/core ([1cd3df6](https://github.com/salesforcecli/sf-plugins-core/commit/1cd3df66dde4d1e5386221e892aa01a7d504261c))
+- bump oclif/core ([1cd3df6](https://github.com/salesforcecli/sf-plugins-core/commit/1cd3df66dde4d1e5386221e892aa01a7d504261c))
 
 ### [0.0.15](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.14...v0.0.15) (2021-08-31)
 
-
 ### Bug Fixes
 
-* improve jsdocs ([e3e3784](https://github.com/salesforcecli/sf-plugins-core/commit/e3e3784954fc2d6b06f96459c824cf77795a9de9))
-* improve jsdocs ([aefdd06](https://github.com/salesforcecli/sf-plugins-core/commit/aefdd06b164d413b3f3c4d51b36dea475efcc3ef))
+- improve jsdocs ([e3e3784](https://github.com/salesforcecli/sf-plugins-core/commit/e3e3784954fc2d6b06f96459c824cf77795a9de9))
+- improve jsdocs ([aefdd06](https://github.com/salesforcecli/sf-plugins-core/commit/aefdd06b164d413b3f3c4d51b36dea475efcc3ef))
 
 ### [0.0.14](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.13...v0.0.14) (2021-08-31)
 
-
 ### Bug Fixes
 
-* improve env types ([e7a7c1d](https://github.com/salesforcecli/sf-plugins-core/commit/e7a7c1df001d02b60c31bcbe5abe4ab31d5faf8d))
+- improve env types ([e7a7c1d](https://github.com/salesforcecli/sf-plugins-core/commit/e7a7c1df001d02b60c31bcbe5abe4ab31d5faf8d))
 
 ### [0.0.13](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.12...v0.0.13) (2021-08-30)
 
-
 ### Bug Fixes
 
-* update exports ([548ab46](https://github.com/salesforcecli/sf-plugins-core/commit/548ab4646bd1e2d79dbda0609551e6f805b69d09))
+- update exports ([548ab46](https://github.com/salesforcecli/sf-plugins-core/commit/548ab4646bd1e2d79dbda0609551e6f805b69d09))
 
 ### [0.0.12](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.11...v0.0.12) (2021-08-30)
 
-
 ### Features
 
-* support env display ([446af15](https://github.com/salesforcecli/sf-plugins-core/commit/446af15385ed57e7d5ebd40c4a4964b2bf326e16))
+- support env display ([446af15](https://github.com/salesforcecli/sf-plugins-core/commit/446af15385ed57e7d5ebd40c4a4964b2bf326e16))
 
 ### [0.0.11](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.10...v0.0.11) (2021-08-30)
 
-
 ### Features
 
-* rename to sf-plugins-core ([e51d6aa](https://github.com/salesforcecli/sf-plugins-core/commit/e51d6aa6879c085ae9efac990d6d406a79615088))
+- rename to sf-plugins-core ([e51d6aa](https://github.com/salesforcecli/sf-plugins-core/commit/e51d6aa6879c085ae9efac990d6d406a79615088))
 
 ### [0.0.10](https://github.com/salesforcecli/sf-plugins-core/compare/v0.0.9...v0.0.10) (2021-08-10)
 

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018, 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;
@@ -9,15 +10,17 @@ export interface SfCommandInterface extends Interfaces.Command {
  * output formatting. Extend this command and set specific properties
  * to add help sections to the command's help output.
  *
- * @extends @oclif/command
- * @see https://github.com/oclif/command
+ * @extends @oclif/core/command
+ * @see https://github.com/oclif/core/blob/main/src/command.ts
  */
 export declare abstract class SfCommand<T> extends Command {
     static enableJsonFlag: boolean;
     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');
 /**
@@ -16,13 +17,14 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * output formatting. Extend this command and set specific properties
  * to add help sections to the command's help output.
  *
- * @extends @oclif/command
- * @see https://github.com/oclif/command
+ * @extends @oclif/core/command
+ * @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/types/index.d.ts

@@ -95,19 +95,19 @@ export declare namespace EnvList {
 }
 export declare namespace Deploy {
     type HookMeta<T extends Deployer> = {
-        options: {};
+        options: Record<string, unknown>;
         return: T[];
     };
 }
 export declare namespace Login {
     type HookMeta = {
-        options: {};
+        options: Record<string, unknown>;
         return: void;
     };
 }
 export declare namespace Logout {
     type HookMeta<T extends Deauthorizer> = {
-        options: {};
+        options: Record<string, unknown>;
         return: T;
     };
 }

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.2",
+  "version": "1.1.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -9,7 +9,7 @@
     "build": "sf-build",
     "ci-docs": "yarn sf-ci-docs",
     "clean": "sf-clean",
-    "clean-all": "sf clean-all",
+    "clean-all": "sf-clean all",
     "compile": "sf-compile",
     "docs": "sf-docs",
     "format": "sf-format",
@@ -17,6 +17,7 @@
     "lint-fix": "yarn sf-lint --fix",
     "postcompile": "tsc -p test",
     "prepack": "sf-prepack",
+    "prepare": "sf-install",
     "pretest": "sf-compile-test",
     "test": "sf-test"
   },
@@ -30,48 +31,42 @@
     "!lib/**/*.map",
     "/messages"
   ],
-  "husky": {
-    "hooks": {
-      "commit-msg": "sf-husky-commit-msg",
-      "pre-commit": "sf-husky-pre-commit",
-      "pre-push": "sf-husky-pre-push"
-    }
-  },
   "dependencies": {
-    "@oclif/core": "^1.0.1",
-    "@salesforce/core": "^3.6.6",
+    "@oclif/core": "^1.0.10",
+    "@salesforce/core": "3.6.6",
     "@salesforce/kit": "^1.5.17",
     "@salesforce/ts-types": "^1.5.20",
-    "cli-ux": "^5.6.3",
+    "cli-ux": "^6.0.6",
     "inquirer": "^8.2.0"
   },
   "devDependencies": {
     "@salesforce/dev-config": "^2.1.2",
-    "@salesforce/dev-scripts": "^0.9.18",
+    "@salesforce/dev-scripts": "^1.0.2",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.2.3",
     "@types/inquirer": "^8.1.3",
-    "@typescript-eslint/eslint-plugin": "^2.30.0",
-    "@typescript-eslint/parser": "^2.30.0",
+    "@typescript-eslint/eslint-plugin": "^4.2.0",
+    "@typescript-eslint/parser": "^4.2.0",
+    "chai": "^4.2.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-config-salesforce": "^0.1.0",
-    "eslint-config-salesforce-license": "^0.1.0",
-    "eslint-config-salesforce-typescript": "^0.1.0",
+    "eslint-config-salesforce": "^0.1.6",
+    "eslint-config-salesforce-license": "^0.1.6",
+    "eslint-config-salesforce-typescript": "^0.2.7",
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "^2.20.2",
     "eslint-plugin-jsdoc": "^27.0.3",
     "eslint-plugin-prettier": "^3.1.3",
-    "husky": "^4.2.5",
-    "mocha": "^7.2.0",
+    "husky": "^7.0.4",
+    "mocha": "^8.4.0",
     "nyc": "^15.1.0",
     "prettier": "^2.0.5",
-    "pretty-quick": "^2.0.1",
+    "pretty-quick": "^3.1.0",
     "shelljs": "0.8.1",
-    "sinon": "^9.0.2",
+    "sinon": "10.0.0",
     "strip-ansi": "6.0.0",
-    "ts-node": "^8.10.2",
-    "typescript": "^4"
+    "ts-node": "^10.4.0",
+    "typescript": "^4.1.3"
   },
   "publishConfig": {
     "access": "public"