@salesforce/sf-plugins-core 1.9.0 → 1.11.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.11.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.11.0...v1.11.1) (2022-04-07)
+
+### Bug Fixes
+
+- adjust message formats ([5b62ced](https://github.com/salesforcecli/sf-plugins-core/commit/5b62cedeb522c08dcce01159a22060be72c1bf62))
+
+## [1.11.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.10.0...v1.11.0) (2022-03-31)
+
+### Features
+
+- support error codes help section ([4852a4f](https://github.com/salesforcecli/sf-plugins-core/commit/4852a4f75bcc744febf276293ed5bf45080436e6))
+
+## [1.10.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.9.0...v1.10.0) (2022-03-31)
+
+### Features
+
+- warn users when using a beta command ([2cf26f2](https://github.com/salesforcecli/sf-plugins-core/commit/2cf26f2d363a40b0739f082bfe4aedd62fd4531f))
+
 ## [1.9.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.8.1...v1.9.0) (2022-03-24)
 
 ### Features

package/lib/exported.d.ts

@@ -5,7 +5,7 @@ export { Deauthorizer } from './deauthorizer';
 export { Progress, Prompter, generateTableChoices } from './ux';
 export { SfHook } from './hooks';
 export * from './types';
-export { SfCommand, SfCommandInterface } from './sfCommand';
+export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
 export declare const Flags: {
     boolean: typeof import("@oclif/core/lib/parser/flags").boolean;
     directory: (opts?: ({

package/lib/exported.js

@@ -20,7 +20,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Flags = exports.SfCommand = exports.SfHook = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Deauthorizer = exports.Deployer = exports.Deployable = exports.toHelpSection = void 0;
+exports.Flags = exports.StandardColors = exports.SfCommand = exports.SfHook = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Deauthorizer = exports.Deployer = exports.Deployable = exports.toHelpSection = void 0;
 const core_1 = require("@oclif/core");
 var util_1 = require("./util");
 Object.defineProperty(exports, "toHelpSection", { enumerable: true, get: function () { return util_1.toHelpSection; } });
@@ -38,6 +38,7 @@ Object.defineProperty(exports, "SfHook", { enumerable: true, get: function () {
 __exportStar(require("./types"), exports);
 var sfCommand_1 = require("./sfCommand");
 Object.defineProperty(exports, "SfCommand", { enumerable: true, get: function () { return sfCommand_1.SfCommand; } });
+Object.defineProperty(exports, "StandardColors", { enumerable: true, get: function () { return sfCommand_1.StandardColors; } });
 // custom flags
 const orgFlags_1 = require("./flags/orgFlags");
 const salesforceId_1 = require("./flags/salesforceId");

package/lib/sfCommand.d.ts

@@ -1,12 +1,19 @@
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
 import { SfProject, StructuredMessage } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
+import * as chalk from 'chalk';
 import { Progress, Prompter, Spinner, Ux } from './ux';
 export interface SfCommandInterface extends Interfaces.Command {
     configurationVariablesSection?: HelpSection;
     envVariablesSection?: HelpSection;
     errorCodes?: HelpSection;
 }
+export declare const StandardColors: {
+    error: chalk.Chalk;
+    warning: chalk.Chalk;
+    info: chalk.Chalk;
+    success: chalk.Chalk;
+};
 /**
  * A base command that provides convenient access to CLI help
  * output formatting. Extend this command and set specific properties
@@ -32,6 +39,13 @@ export declare abstract class SfCommand<T> extends Command {
     private lifecycle;
     protected get statics(): typeof SfCommand;
     constructor(argv: string[], config: Config);
+    /**
+     * Log a success message that has the standard success message color applied
+     *
+     * @param message
+     * @param args
+     */
+    logSuccess(message: string): void;
     /**
      * Log warning to users. If --json is enabled, then the warning
      * will be added to the json output under the warnings property.
@@ -104,7 +118,7 @@ export declare abstract class SfCommand<T> extends Command {
     protected assignProject(): Promise<SfProject>;
     protected catch(error: SfCommand.Error): Promise<SfCommand.Error>;
     /**
-     * Format errors and actions for human consumption. Adds 'Error:',
+     * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',
      * 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

package/lib/sfCommand.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SfCommand = void 0;
+exports.SfCommand = exports.StandardColors = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -10,10 +10,16 @@ exports.SfCommand = void 0;
 const os = require("os");
 const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
-const chalk_1 = require("chalk");
+const chalk = require("chalk");
 const ux_1 = require("./ux");
 core_2.Messages.importMessagesDirectory(__dirname);
 const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
+exports.StandardColors = {
+    error: chalk.hex('BF0201'),
+    warning: chalk.hex('FF9A3C'),
+    info: chalk.dim,
+    success: chalk.hex('4BCA81'),
+};
 /**
  * A base command that provides convenient access to CLI help
  * output formatting. Extend this command and set specific properties
@@ -36,6 +42,15 @@ class SfCommand extends core_1.Command {
     get statics() {
         return this.constructor;
     }
+    /**
+     * Log a success message that has the standard success message color applied
+     *
+     * @param message
+     * @param args
+     */
+    logSuccess(message) {
+        this.log(exports.StandardColors.success(message));
+    }
     /**
      * Log warning to users. If --json is enabled, then the warning
      * will be added to the json output under the warnings property.
@@ -44,8 +59,8 @@ class SfCommand extends core_1.Command {
         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 }));
+        colorizedArgs.push(`${exports.StandardColors.warning(messages.getMessage('warning.prefix'))} ${message}`);
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: exports.StandardColors.info }));
         this.log(colorizedArgs.join(os.EOL));
         return input;
     }
@@ -55,8 +70,8 @@ class SfCommand extends core_1.Command {
     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 }));
+        colorizedArgs.push(`${exports.StandardColors.info(message)}`);
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: exports.StandardColors.info }));
         this.log(colorizedArgs.join(os.EOL));
     }
     /**
@@ -140,6 +155,9 @@ class SfCommand extends core_1.Command {
         if (this.statics.requiresProject) {
             this.project = await this.assignProject();
         }
+        if (this.statics.state === 'beta') {
+            this.warn(messages.getMessage('warning.CommandInBeta'));
+        }
         this.lifecycle.onWarning(async (warning) => {
             this.warn(warning);
         });
@@ -193,7 +211,7 @@ class SfCommand extends core_1.Command {
         return error;
     }
     /**
-     * Format errors and actions for human consumption. Adds 'Error:',
+     * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',
      * 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
@@ -202,13 +220,12 @@ class SfCommand extends core_1.Command {
      */
     formatError(error) {
         const colorizedArgs = [];
-        colorizedArgs.push(`${chalk_1.default.bold.red(messages.getMessage('error.prefix'))} ${error.message}`);
+        const errorCode = error.code ? ` (${error.code})` : '';
+        const errorPrefix = `${exports.StandardColors.error(messages.getMessage('error.prefix', [errorCode]))}`;
+        colorizedArgs.push(`${errorPrefix} ${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})`));
+            colorizedArgs.push(exports.StandardColors.info(`\n*** Internal Diagnostic ***\n\n${error.stack}\n******\n`));
         }
         return colorizedArgs.join('\n');
     }
@@ -219,11 +236,11 @@ class SfCommand extends core_1.Command {
      * @param options
      * @private
      */
-    formatActions(actions, options = { actionColor: chalk_1.default.red }) {
+    formatActions(actions, options = { actionColor: exports.StandardColors.info }) {
         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`);
+            colorizedArgs.push(`\n${exports.StandardColors.info(messages.getMessage('actions.tryThis'))}\n`);
             actions.forEach((action) => {
                 colorizedArgs.push(`${options.actionColor(action)}`);
             });

package/lib/util.d.ts

@@ -15,5 +15,5 @@ export declare type HelpSection = {
  * @param header
  * @param vars
  */
-export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable | string>): HelpSection;
+export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable | string | Record<string, string>>): HelpSection;
 //# sourceMappingURL=util.d.ts.map

package/lib/util.js

@@ -19,23 +19,28 @@ const core_1 = require("@salesforce/core");
  */
 function toHelpSection(header, ...vars) {
     const body = vars
-        .map((v) => {
-        const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => {
-            return key === v;
-        });
-        if (orgConfig) {
-            return { name: orgConfig.key, description: orgConfig.description };
+        .flatMap((v) => {
+        if (typeof v === 'string') {
+            const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => {
+                return key === v;
+            });
+            if (orgConfig) {
+                return { name: orgConfig.key, description: orgConfig.description };
+            }
+            const sfdxProperty = core_1.SFDX_ALLOWED_PROPERTIES.find(({ key }) => key === v);
+            if (sfdxProperty) {
+                return { name: sfdxProperty.key.valueOf(), description: sfdxProperty.description };
+            }
+            const envVar = Object.entries(core_1.SUPPORTED_ENV_VARS).find(([k]) => k === v);
+            if (envVar) {
+                const [eKey, data] = envVar;
+                return { name: eKey, description: data.description };
+            }
+            return undefined;
         }
-        const sfdxProperty = core_1.SFDX_ALLOWED_PROPERTIES.find(({ key }) => key === v);
-        if (sfdxProperty) {
-            return { name: sfdxProperty.key.valueOf(), description: sfdxProperty.description };
+        else {
+            return Object.entries(v).map(([name, description]) => ({ name, description }));
         }
-        const envVar = Object.entries(core_1.SUPPORTED_ENV_VARS).find(([k]) => k === v);
-        if (envVar) {
-            const [eKey, data] = envVar;
-            return { name: eKey, description: data.description };
-        }
-        return undefined;
     })
         .filter((b) => b);
     return { header, body };

package/messages/messages.md

@@ -1,6 +1,6 @@
 # error.prefix
 
-Error:
+Error%s:
 
 # warning.security
 
@@ -66,10 +66,10 @@ The value must be between %s and %s (inclusive).
 
 Warning:
 
-# info.prefix
-
-Info:
-
 # actions.tryThis
 
 Try this:
+
+# warning.CommandInBeta
+
+This command is currently in beta. Any aspect of this command can change without advanced notice. Don't use beta commands in your scripts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.9.0",
+  "version": "1.11.1",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,11 +32,11 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.6.0",
-    "@salesforce/core": "^3.7.9",
+    "@oclif/core": "^1.6.3",
+    "@salesforce/core": "^3.11.0",
     "@salesforce/kit": "^1.5.34",
     "@salesforce/ts-types": "^1.5.20",
-    "chalk": "^2.4.2",
+    "chalk": "^4",
     "inquirer": "^8.2.0"
   },
   "devDependencies": {