@salesforce/sf-plugins-core 1.4.0 → 1.5.1

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.5.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.5.0...v1.5.1) (2022-03-07)
+
+## [1.5.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.4.1...v1.5.0) (2022-03-03)
+
+### Features
+
+- friendly default help for org flags ([f4d55b3](https://github.com/salesforcecli/sf-plugins-core/commit/f4d55b30c08e988c0231b97acce8ba2bc9733a06))
+
+### [1.4.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.4.0...v1.4.1) (2022-03-02)
+
+### Bug Fixes
+
+- make toHelpSection types more friendly ([add364b](https://github.com/salesforcecli/sf-plugins-core/commit/add364b6be532dae6fb49f62164dad486b186347))
+
 ## [1.4.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.3.0...v1.4.0) (2022-03-02)
 
 ### Features

package/lib/exported.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/flags/orgFlags.js

@@ -58,6 +58,7 @@ exports.optionalOrgFlag = core_1.Flags.build({
     char: 'e',
     parse: async (input) => await maybeGetOrg(input),
     default: async () => await maybeGetOrg(),
+    defaultHelp: async () => { var _a; return (_a = (await maybeGetOrg(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 /**
  * An required org, specified by username or alias
@@ -82,6 +83,7 @@ exports.requiredOrgFlag = core_1.Flags.build({
     char: 'e',
     parse: async (input) => await getOrgOrThrow(input),
     default: async () => await getOrgOrThrow(undefined),
+    defaultHelp: async () => { var _a; return (_a = (await getOrgOrThrow(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 /**
  * An required org that is a devHub
@@ -106,5 +108,6 @@ exports.requiredHubFlag = core_1.Flags.build({
     char: 'v',
     parse: async (input) => await getHubOrThrow(input),
     default: async () => await getHubOrThrow(undefined),
+    defaultHelp: async () => { var _a; return (_a = (await getHubOrThrow(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 //# sourceMappingURL=orgFlags.js.map

package/lib/sfCommand.d.ts

@@ -1,5 +1,5 @@
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
-import { SfdxProject } from '@salesforce/core';
+import { SfProject, StructuredMessage } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { Progress, Prompter, Spinner, Ux } from './ux';
 export interface SfCommandInterface extends Interfaces.Command {
@@ -16,6 +16,7 @@ export interface SfCommandInterface extends Interfaces.Command {
  * @see https://github.com/oclif/core/blob/main/src/command.ts
  */
 export declare abstract class SfCommand<T> extends Command {
+    static SF_ENV: string;
     static enableJsonFlag: boolean;
     static configurationVariablesSection?: HelpSection;
     static envVariablesSection?: HelpSection;
@@ -24,7 +25,7 @@ export declare abstract class SfCommand<T> extends Command {
     static requiresProject: boolean;
     spinner: Spinner;
     progress: Progress;
-    project: SfdxProject;
+    project: SfProject;
     private warnings;
     private ux;
     private prompter;
@@ -36,6 +37,10 @@ export declare abstract class SfCommand<T> extends Command {
      * will be added to the json output under the warnings property.
      */
     warn(input: SfCommand.Warning): SfCommand.Warning;
+    /**
+     * Log info message to users.
+     */
+    info(input: SfCommand.Info): void;
     /**
      * Warn user about sensitive information (access tokens, etc...) before
      * logging to the console.
@@ -80,11 +85,30 @@ 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>;
+    protected assignProject(): Promise<SfProject>;
+    protected catch(error: SfCommand.Error): Promise<SfCommand.Error>;
+    /**
+     * Format errors and actions for human consumption. Adds 'Error:',
+     * When there are actions, we add 'Try this:' in blue
+     * followed by each action in red on its own line.
+     * If Error.code is present it is output last in parentheses
+     *
+     * @returns {string} Returns decorated messages.
+     */
+    protected formatError(error: SfCommand.Error): string;
+    /**
+     * Utility function to format actions lines
+     *
+     * @param actions
+     * @param options
+     * @private
+     */
+    private formatActions;
     abstract run(): Promise<T>;
 }
 export declare namespace SfCommand {
-    type Warning = string | Error;
+    type Info = StructuredMessage | string;
+    type Warning = StructuredMessage | string;
     interface Json<T> {
         status: number;
         result: T;
@@ -96,6 +120,9 @@ export declare namespace SfCommand {
         message: string;
         stack: string | undefined;
         warnings?: Warning[];
+        actions?: string[];
+        code?: unknown;
+        exitCode?: number;
     }
 }
 //# sourceMappingURL=sfCommand.d.ts.map

package/lib/sfCommand.js

@@ -7,8 +7,10 @@ exports.SfCommand = void 0;
  * 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 os = require("os");
 const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
+const chalk_1 = require("chalk");
 const ux_1 = require("./ux");
 core_2.Messages.importMessagesDirectory(__dirname);
 const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
@@ -39,10 +41,24 @@ class SfCommand extends core_1.Command {
      * will be added to the json output under the warnings property.
      */
     warn(input) {
-        const warning = super.warn(input);
-        this.warnings.push(warning);
+        const colorizedArgs = [];
+        this.warnings.push(input);
+        const message = typeof input === 'string' ? input : input.message;
+        colorizedArgs.push(`${chalk_1.default.bold.yellow(messages.getMessage('warning.prefix'))} ${message}`);
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: chalk_1.default.reset }));
+        this.log(colorizedArgs.join(os.EOL));
         return input;
     }
+    /**
+     * Log info message to users.
+     */
+    info(input) {
+        const colorizedArgs = [];
+        const message = typeof input === 'string' ? input : input.message;
+        colorizedArgs.push(`${chalk_1.default.bold(messages.getMessage('info.prefix'))} ${message}`);
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: chalk_1.default.reset }));
+        this.log(colorizedArgs.join(os.EOL));
+    }
     /**
      * Warn user about sensitive information (access tokens, etc...) before
      * logging to the console.
@@ -126,7 +142,7 @@ class SfCommand extends core_1.Command {
     }
     async assignProject() {
         try {
-            return await core_2.SfdxProject.resolve();
+            return await core_2.SfProject.resolve();
         }
         catch (err) {
             if (err instanceof Error && err.name === 'InvalidProjectWorkspaceError') {
@@ -135,8 +151,56 @@ class SfCommand extends core_1.Command {
             throw err;
         }
     }
+    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;
+        this.log(this.formatError(error));
+        if (this.jsonEnabled()) {
+            core_1.CliUx.ux.styledJSON(this.toErrorJson(error));
+        }
+        return error;
+    }
+    /**
+     * Format errors and actions for human consumption. Adds 'Error:',
+     * When there are actions, we add 'Try this:' in blue
+     * followed by each action in red on its own line.
+     * If Error.code is present it is output last in parentheses
+     *
+     * @returns {string} Returns decorated messages.
+     */
+    formatError(error) {
+        const colorizedArgs = [];
+        colorizedArgs.push(`${chalk_1.default.bold.red(messages.getMessage('error.prefix'))} ${error.message}`);
+        colorizedArgs.push(...this.formatActions(error.actions || []));
+        if (error.stack && core_2.envVars.getString(SfCommand.SF_ENV) === core_2.Mode.DEVELOPMENT) {
+            colorizedArgs.push(chalk_1.default.red(`\n*** Internal Diagnostic ***\n\n${error.stack}\n******\n`));
+        }
+        if (error.code) {
+            colorizedArgs.push(chalk_1.default.bold(`\n(${error.code})`));
+        }
+        return colorizedArgs.join('\n');
+    }
+    /**
+     * Utility function to format actions lines
+     *
+     * @param actions
+     * @param options
+     * @private
+     */
+    formatActions(actions, options = { actionColor: chalk_1.default.red }) {
+        const colorizedArgs = [];
+        // Format any actions.
+        if (actions === null || actions === void 0 ? void 0 : actions.length) {
+            colorizedArgs.push(`\n${chalk_1.default.blue.bold(messages.getMessage('actions.tryThis'))}\n`);
+            actions.forEach((action) => {
+                colorizedArgs.push(`${options.actionColor(action)}`);
+            });
+        }
+        return colorizedArgs;
+    }
 }
 exports.SfCommand = SfCommand;
+SfCommand.SF_ENV = 'SF_ENV';
 SfCommand.enableJsonFlag = true;
 SfCommand.tableFlags = core_1.CliUx.ux.table.flags;
 //# sourceMappingURL=sfCommand.js.map

package/lib/util.d.ts

@@ -1,5 +1,11 @@
-import { HelpSection } from '@oclif/core';
-import { OrgConfigProperties, SfdxPropertyKeys, EnvironmentVariable } from '@salesforce/core';
+import { EnvironmentVariable, OrgConfigProperties, SfdxPropertyKeys } from '@salesforce/core';
+export declare type HelpSection = {
+    header: string;
+    body: Array<{
+        name: string;
+        description: string;
+    } | undefined>;
+};
 /**
  * Function to build a help section for command help.
  * Takes a string to be used as section header text and an array of enums
@@ -9,5 +15,5 @@ import { OrgConfigProperties, SfdxPropertyKeys, EnvironmentVariable } from '@sal
  * @param header
  * @param vars
  */
-export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable>): HelpSection;
+export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable | string>): HelpSection;
 //# sourceMappingURL=util.d.ts.map

package/lib/ux/progress.js

@@ -67,7 +67,7 @@ class Progress extends _1.UxBase {
             this.bar.stop();
     }
     _start(total, payload = {}) {
-        const start = kit_1.once((bar, t, p = {}) => {
+        const start = (0, kit_1.once)((bar, t, p = {}) => {
             bar.start(t);
             if (Object.keys(p).length) {
                 bar.update(0, p);

package/lib/ux/prompter.js

@@ -14,7 +14,7 @@ class Prompter {
      * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
      */
     async prompt(questions, initialAnswers) {
-        const answers = await inquirer_1.prompt(questions, initialAnswers);
+        const answers = await (0, inquirer_1.prompt)(questions, initialAnswers);
         return answers;
     }
 }
@@ -32,7 +32,7 @@ function generateTableChoices(columns, choices,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 padForCheckbox = true) {
     const columnEntries = Object.entries(columns);
-    const columnLengths = columnEntries.map(([key, value]) => Math.max(ts_types_1.ensureString(value).length, ...choices.map((option) => ts_types_1.ensureString(option[key], `Type ${typeof option[key]} for ${key} in ${Object.keys(option).join(', ')}`)
+    const columnLengths = columnEntries.map(([key, value]) => Math.max((0, ts_types_1.ensureString)(value).length, ...choices.map((option) => (0, ts_types_1.ensureString)(option[key], `Type ${typeof option[key]} for ${key} in ${Object.keys(option).join(', ')}`)
         .length)) + 1);
     const choicesOptions = [
         new inquirer_1.Separator(`${padForCheckbox ? ' '.repeat(2) : ''}${columnEntries
@@ -41,9 +41,9 @@ padForCheckbox = true) {
     ];
     for (const meta of choices) {
         const name = columnEntries
-            .map(([key], index) => ts_types_1.ensureString(meta[key]).padEnd(columnLengths[index], ' '))
+            .map(([key], index) => (0, ts_types_1.ensureString)(meta[key]).padEnd(columnLengths[index], ' '))
             .join('');
-        const choice = { name, value: meta.value, short: ts_types_1.ensureString(meta.name) };
+        const choice = { name, value: meta.value, short: (0, ts_types_1.ensureString)(meta.name) };
         choicesOptions.push(choice);
     }
     return choicesOptions;

package/messages/messages.md

@@ -1,3 +1,7 @@
+# error.prefix
+
+Error:
+
 # 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>
@@ -57,3 +61,15 @@ The value must be an integer.
 # errors.DurationBounds
 
 The value must be between %s and %s (inclusive).
+
+# warning.prefix
+
+Warning:
+
+# info.prefix
+
+Info:
+
+# actions.tryThis
+
+Try this:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,40 +32,42 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.5.0",
-    "@salesforce/core": "^3.7.6",
-    "@salesforce/kit": "^1.5.17",
+    "@oclif/core": "^1.5.1",
+    "@salesforce/core": "^3.7.8",
+    "@salesforce/kit": "^1.5.34",
     "@salesforce/ts-types": "^1.5.20",
+    "chalk": "^2.4.2",
     "inquirer": "^8.2.0"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^2.1.2",
-    "@salesforce/dev-scripts": "^1.0.2",
+    "@oclif/test": "^2.1.0",
+    "@salesforce/dev-config": "^2.1.3",
+    "@salesforce/dev-scripts": "^1.0.4",
     "@salesforce/prettier-config": "^0.0.2",
-    "@salesforce/ts-sinon": "^1.2.3",
-    "@types/inquirer": "^8.1.3",
-    "@typescript-eslint/eslint-plugin": "^4.2.0",
-    "@typescript-eslint/parser": "^4.2.0",
-    "chai": "^4.2.0",
+    "@salesforce/ts-sinon": "^1.3.21",
+    "@types/inquirer": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "chai": "^4.3.6",
     "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint-config-prettier": "^6.15.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",
+    "eslint-config-salesforce-typescript": "^0.2.8",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^27.1.2",
+    "eslint-plugin-prettier": "^3.4.1",
     "husky": "^7.0.4",
     "mocha": "^8.4.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.0.5",
-    "pretty-quick": "^3.1.0",
+    "prettier": "^2.5.1",
+    "pretty-quick": "^3.1.3",
     "shelljs": "0.8.5",
-    "sinon": "10.0.0",
-    "strip-ansi": "6.0.0",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.1.3"
+    "sinon": "10.0.1",
+    "strip-ansi": "6.0.1",
+    "ts-node": "^10.6.0",
+    "typescript": "^4.5.5"
   },
   "publishConfig": {
     "access": "public"