@salesforce/sf-plugins-core 1.14.1 → 1.15.0

package/lib/sfCommand.d.ts

@@ -15,49 +15,148 @@ export declare const StandardColors: {
     success: chalk.Chalk;
 };
 /**
- * A base command that provides convenient access to CLI help
- * output formatting. Extend this command and set specific properties
- * to add help sections to the command's help output.
+ * A base command that provided common functionality for all sf commands.
+ * Functionality includes:
+ *  - JSON support
+ *  - progress bars
+ *  - spinners
+ *  - prompts
+ *  - stylized output (JSON, url, objects, headers)
+ *  - lifecycle events
+ *  - configuration variables help section
+ *  - environment variables help section
+ *  - error codes help section
  *
- * @extends @oclif/core/command
- * @see https://github.com/oclif/core/blob/main/src/command.ts
+ * All implementations of this class need to implement the run() method.
+ *
+ * Additionally, all implementations of this class need to provide a generic type that describes the JSON output.
+ *
+ * See {@link https://github.com/salesforcecli/plugin-template-sf/blob/main/src/commands/hello/world.ts example implementation}.
+ *
+ * @example
+ *
+ * ```
+ * import { SfCommand } from '@salesforce/sf-plugins-core';
+ * export type MyJsonOutput = { success: boolean };
+ * export default class MyCommand extends SfCommand<MyJsonOutput> {
+ *   public async run(): Promise<MyJsonOutput> {
+ *    return { success: true };
+ *  }
+ * }
+ * ```
  */
 export declare abstract class SfCommand<T> extends Command {
     static SF_ENV: string;
     static enableJsonFlag: boolean;
+    /**
+     * Add a CONFIGURATION VARIABLES section to the help output.
+     *
+     * @example
+     * ```
+     * import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
+     * import { OrgConfigProperties } from '@salesforce/core';
+     * export default class MyCommand extends SfCommand {
+     *   public static configurationVariablesSection = toHelpSection(
+     *     'CONFIGURATION VARIABLES',
+     *     OrgConfigProperties.TARGET_ORG,
+     *     OrgConfigProperties.ORG_API_VERSION,
+     *   );
+     * }
+     * ```
+     */
     static configurationVariablesSection?: HelpSection;
+    /**
+     * Add an Environment VARIABLES section to the help output.
+     *
+     * @example
+     * ```
+     * import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
+     * import { EnvironmentVariable } from '@salesforce/core';
+     * export default class MyCommand extends SfCommand {
+     *   public static envVariablesSection = toHelpSection(
+     *     'ENVIRONMENT VARIABLES',
+     *     EnvironmentVariable.SF_TARGET_ORG,
+     *     EnvironmentVariable.SF_USE_PROGRESS_BAR,
+     *   );
+     * }
+     * ```
+     */
     static envVariablesSection?: HelpSection;
+    /**
+     * Add an ERROR CODES section to the help output.
+     *
+     * @example
+     * ```
+     * import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
+     * export default class MyCommand extends SfCommand {
+     *   public static errorCodes = toHelpSection(
+     *     'ERROR CODES',
+     *     { 0: 'Success', 1: 'Failure' },
+     *   );
+     * }
+     * ```
+     */
     static errorCodes?: HelpSection;
+    /**
+     * Flags that you can use for manipulating tables.
+     *
+     * @example
+     * ```
+     * import { SfCommand } from '@salesforce/sf-plugins-core';
+     * export default class MyCommand extends SfCommand {
+     *   public static flags = {
+     *    ...SfCommand.tableFags,
+     *    'my-flags: flags.string({ char: 'm', description: 'my flag' }),
+     *   }
+     * }
+     * ```
+     */
     static tableFlags: typeof CliUx.Table.table.flags;
+    /**
+     * Set to true if the command must be executed inside a Salesforce project directory.
+     *
+     * If set to true the command will throw an error if the command is executed outside of a Salesforce project directory.
+     * Additionally, this.project will be set to the current Salesforce project (SfProject).
+     *
+     */
     static requiresProject: boolean;
+    /**
+     * Add a spinner to the console. {@link Spinner}
+     */
     spinner: Spinner;
+    /**
+     * Add a progress bar to the console. {@link Progress}
+     */
     progress: Progress;
     project: SfProject;
     private warnings;
     private ux;
     private prompter;
     private lifecycle;
-    protected get statics(): typeof SfCommand;
     constructor(argv: string[], config: Config);
+    protected get statics(): typeof SfCommand;
     /**
-     * Log a success message that has the standard success message color applied
+     * Log a success message that has the standard success message color applied.
      *
-     * @param message
-     * @param args
+     * @param message The message to log.
      */
     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.
+     * Log warning to users. If --json is enabled, then the warning will be added to the json output under the warnings property.
+     *
+     * @param input {@link SfCommand.Warning} The message to log.
      */
     warn(input: SfCommand.Warning): SfCommand.Warning;
     /**
      * Log info message to users.
+     *
+     * @param input {@link SfCommand.Info} The message to log.
      */
     info(input: SfCommand.Info): void;
     /**
-     * Warn user about sensitive information (access tokens, etc...) before
-     * logging to the console.
+     * Warn user about sensitive information (access tokens, etc...) before logging to the console.
+     *
+     * @param msg The message to log.
      */
     logSensitive(msg?: string): void;
     /**
@@ -66,18 +165,27 @@ export declare abstract class SfCommand<T> extends Command {
     table<R extends Ux.Table.Data>(data: R[], columns: Ux.Table.Columns<R>, options?: Ux.Table.Options): void;
     /**
      * Log a stylized url to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param text The text to display for the url.
+     * @param uri The url to display.
      */
     url(text: string, uri: string, params?: {}): void;
     /**
      * Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param obj The JSON to log.
      */
     styledJSON(obj: AnyJson): void;
     /**
      * Log stylized object to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param obj The object to log.
      */
     styledObject(obj: AnyJson): void;
     /**
      * Log stylized header to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param text the text to display as a header.
      */
     styledHeader(text: string): void;
     /**
@@ -93,9 +201,9 @@ export declare abstract class SfCommand<T> extends Command {
      *   await this.prompt();
      * }
      */
-    prompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
+    prompt<R extends Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
     /**
-     * Simplified prompt for single-question confirmation.  Times out and throws after 10s
+     * Simplified prompt for single-question confirmation. Times out and throws after 10s
      *
      * @param message text to display.  Do not include a question mark.
      * @param ms milliseconds to wait for user input.  Defaults to 10s.
@@ -105,7 +213,7 @@ export declare abstract class SfCommand<T> extends Command {
     /**
      * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */
-    timedPrompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, ms?: number, initialAnswers?: Partial<R>): Promise<R>;
+    timedPrompt<R extends Prompter.Answers>(questions: Prompter.Questions<R>, ms?: number, initialAnswers?: Partial<R>): Promise<R>;
     _run<R>(): Promise<R | undefined>;
     /**
      * Wrap the command result into the standardized JSON structure.

package/lib/sfCommand.js

@@ -21,12 +21,35 @@ exports.StandardColors = {
     success: chalk.bold.green,
 };
 /**
- * A base command that provides convenient access to CLI help
- * output formatting. Extend this command and set specific properties
- * to add help sections to the command's help output.
+ * A base command that provided common functionality for all sf commands.
+ * Functionality includes:
+ *  - JSON support
+ *  - progress bars
+ *  - spinners
+ *  - prompts
+ *  - stylized output (JSON, url, objects, headers)
+ *  - lifecycle events
+ *  - configuration variables help section
+ *  - environment variables help section
+ *  - error codes help section
  *
- * @extends @oclif/core/command
- * @see https://github.com/oclif/core/blob/main/src/command.ts
+ * All implementations of this class need to implement the run() method.
+ *
+ * Additionally, all implementations of this class need to provide a generic type that describes the JSON output.
+ *
+ * See {@link https://github.com/salesforcecli/plugin-template-sf/blob/main/src/commands/hello/world.ts example implementation}.
+ *
+ * @example
+ *
+ * ```
+ * import { SfCommand } from '@salesforce/sf-plugins-core';
+ * export type MyJsonOutput = { success: boolean };
+ * export default class MyCommand extends SfCommand<MyJsonOutput> {
+ *   public async run(): Promise<MyJsonOutput> {
+ *    return { success: true };
+ *  }
+ * }
+ * ```
  */
 class SfCommand extends core_1.Command {
     constructor(argv, config) {
@@ -43,40 +66,43 @@ class SfCommand extends core_1.Command {
         return this.constructor;
     }
     /**
-     * Log a success message that has the standard success message color applied
+     * Log a success message that has the standard success message color applied.
      *
-     * @param message
-     * @param args
+     * @param message The message to log.
      */
     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.
+     * Log warning to users. If --json is enabled, then the warning will be added to the json output under the warnings property.
+     *
+     * @param input {@link SfCommand.Warning} The message to log.
      */
     warn(input) {
         const colorizedArgs = [];
         this.warnings.push(input);
         const message = typeof input === 'string' ? input : input.message;
         colorizedArgs.push(`${exports.StandardColors.warning(messages.getMessage('warning.prefix'))} ${message}`);
-        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: exports.StandardColors.info }));
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions ?? [], { actionColor: exports.StandardColors.info }));
         this.log(colorizedArgs.join(os.EOL));
         return input;
     }
     /**
      * Log info message to users.
+     *
+     * @param input {@link SfCommand.Info} The message to log.
      */
     info(input) {
         const colorizedArgs = [];
         const message = typeof input === 'string' ? input : input.message;
         colorizedArgs.push(`${exports.StandardColors.info(message)}`);
-        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions || [], { actionColor: exports.StandardColors.info }));
+        colorizedArgs.push(...this.formatActions(typeof input === 'string' ? [] : input.actions ?? [], { actionColor: exports.StandardColors.info }));
         this.log(colorizedArgs.join(os.EOL));
     }
     /**
-     * Warn user about sensitive information (access tokens, etc...) before
-     * logging to the console.
+     * Warn user about sensitive information (access tokens, etc...) before logging to the console.
+     *
+     * @param msg The message to log.
      */
     logSensitive(msg) {
         this.warn(messages.getMessage('warning.security'));
@@ -90,24 +116,33 @@ class SfCommand extends core_1.Command {
     }
     /**
      * Log a stylized url to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param text The text to display for the url.
+     * @param uri The url to display.
      */
     url(text, uri, params = {}) {
         this.ux.url(text, uri, params);
     }
     /**
      * Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param obj The JSON to log.
      */
     styledJSON(obj) {
         this.ux.styledJSON(obj);
     }
     /**
      * Log stylized object to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param obj The object to log.
      */
     styledObject(obj) {
         this.ux.styledObject(obj);
     }
     /**
      * Log stylized header to the console. Will automatically be suppressed when --json flag is present.
+     *
+     * @param text the text to display as a header.
      */
     styledHeader(text) {
         this.ux.styledHeader(text);
@@ -129,7 +164,7 @@ class SfCommand extends core_1.Command {
         return this.prompter.prompt(questions, initialAnswers);
     }
     /**
-     * Simplified prompt for single-question confirmation.  Times out and throws after 10s
+     * Simplified prompt for single-question confirmation. Times out and throws after 10s
      *
      * @param message text to display.  Do not include a question mark.
      * @param ms milliseconds to wait for user input.  Defaults to 10s.
@@ -167,9 +202,8 @@ class SfCommand extends core_1.Command {
      * Wrap the command result into the standardized JSON structure.
      */
     toSuccessJson(result) {
-        var _a;
         return {
-            status: (_a = process.exitCode) !== null && _a !== void 0 ? _a : 0,
+            status: process.exitCode ?? 0,
             result,
             warnings: this.warnings,
         };
@@ -183,6 +217,7 @@ class SfCommand extends core_1.Command {
             warnings: this.warnings,
         };
     }
+    // eslint-disable-next-line class-methods-use-this
     async assignProject() {
         try {
             return await core_2.SfProject.resolve();
@@ -195,10 +230,9 @@ class SfCommand extends core_1.Command {
         }
     }
     async catch(error) {
-        var _a, _b;
         // 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);
+        process.exitCode ?? (process.exitCode = codeFromError);
         const sfErrorProperties = error instanceof core_2.SfError
             ? { data: error.data, actions: error.actions, code: codeFromError, context: error.context }
             : {};
@@ -206,7 +240,7 @@ class SfCommand extends core_1.Command {
             ...sfErrorProperties,
             ...{
                 message: error.message,
-                name: (_b = error.name) !== null && _b !== void 0 ? _b : 'Error',
+                name: error.name ?? 'Error',
                 status: process.exitCode,
                 stack: error.stack,
                 exitCode: process.exitCode,
@@ -234,7 +268,7 @@ class SfCommand extends core_1.Command {
         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 || []));
+        colorizedArgs.push(...this.formatActions(error.actions ?? []));
         if (error.stack && core_2.envVars.getString(SfCommand.SF_ENV) === core_2.Mode.DEVELOPMENT) {
             colorizedArgs.push(exports.StandardColors.info(`\n*** Internal Diagnostic ***\n\n${error.stack}\n******\n`));
         }
@@ -247,10 +281,11 @@ class SfCommand extends core_1.Command {
      * @param options
      * @private
      */
+    // eslint-disable-next-line class-methods-use-this
     formatActions(actions, options = { actionColor: exports.StandardColors.info }) {
         const colorizedArgs = [];
         // Format any actions.
-        if (actions === null || actions === void 0 ? void 0 : actions.length) {
+        if (actions?.length) {
             colorizedArgs.push(`\n${exports.StandardColors.info(messages.getMessage('actions.tryThis'))}\n`);
             actions.forEach((action) => {
                 colorizedArgs.push(`${options.actionColor(action)}`);
@@ -262,5 +297,19 @@ class SfCommand extends core_1.Command {
 exports.SfCommand = SfCommand;
 SfCommand.SF_ENV = 'SF_ENV';
 SfCommand.enableJsonFlag = true;
+/**
+ * Flags that you can use for manipulating tables.
+ *
+ * @example
+ * ```
+ * import { SfCommand } from '@salesforce/sf-plugins-core';
+ * export default class MyCommand extends SfCommand {
+ *   public static flags = {
+ *    ...SfCommand.tableFags,
+ *    'my-flags: flags.string({ char: 'm', description: 'my flag' }),
+ *   }
+ * }
+ * ```
+ */
 SfCommand.tableFlags = core_1.CliUx.ux.table.flags;
 //# sourceMappingURL=sfCommand.js.map

package/lib/types/index.d.ts

@@ -9,13 +9,18 @@ export declare type JsonObject = {
  * you can specify how a key should be displayed to the user.
  *
  * @example
+ *
+ * ```
  * { data: { theURL: 'https://example.com' } }
  * // Renders as:
  * Key     Value
  * ------- -------------------
  * The URL https://example.com
+ * ```
  *
  * @example
+ *
+ * ```
  * {
  *   data: { theURL: 'https://example.com' }
  *   keys: { theURL: 'Url' },
@@ -24,11 +29,13 @@ export declare type JsonObject = {
  * Key Value
  * --- -------------------
  * Url https://example.com
- *
+ *```
  * If no environment matches the provided targetEnv, then return null in the data field.
  *
  * @example
+ * ```
  * { data: null }
+ * ```
  */
 export declare namespace EnvDisplay {
     type Keys<T> = Record<keyof T, string>;
@@ -50,6 +57,8 @@ export declare namespace EnvDisplay {
  * the `keys` property.
  *
  * @example
+ *
+ * ```
  * {
  *   title: 'My Envs',
  *   data: [{ username: 'foo', theURL: 'https://example.com' }]
@@ -59,8 +68,11 @@ export declare namespace EnvDisplay {
  * ================================
  * | Username | The URL
  * | foo      | https://example.com
+ *```
  *
  * @example
+ *
+ * ```
  * {
  *   data: [{ username: 'foo', theURL: 'https://example.com' }]
  *   keys: { theURL: 'Url', username: 'Name' },
@@ -71,6 +83,8 @@ export declare namespace EnvDisplay {
  * ============================
  * | Name | Url
  * | foo  | https://example.com
+ *
+ *```
  */
 export declare namespace EnvList {
     export enum EnvType {

package/lib/types/index.js

@@ -14,6 +14,8 @@ exports.EnvList = void 0;
  * the `keys` property.
  *
  * @example
+ *
+ * ```
  * {
  *   title: 'My Envs',
  *   data: [{ username: 'foo', theURL: 'https://example.com' }]
@@ -23,8 +25,11 @@ exports.EnvList = void 0;
  * ================================
  * | Username | The URL
  * | foo      | https://example.com
+ *```
  *
  * @example
+ *
+ * ```
  * {
  *   data: [{ username: 'foo', theURL: 'https://example.com' }]
  *   keys: { theURL: 'Url', username: 'Name' },
@@ -35,6 +40,8 @@ exports.EnvList = void 0;
  * ============================
  * | Name | Url
  * | foo  | https://example.com
+ *
+ *```
  */
 var EnvList;
 (function (EnvList) {

package/lib/util.d.ts

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

package/lib/util.js

@@ -6,8 +6,10 @@
  * 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.toHelpSection = void 0;
+exports.parseVarArgs = exports.toHelpSection = void 0;
 const core_1 = require("@salesforce/core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
 /**
  * Function to build a help section for command help.
  * Takes a string to be used as section header text and an array of enums
@@ -21,9 +23,7 @@ function toHelpSection(header, ...vars) {
     const body = vars
         .flatMap((v) => {
         if (typeof v === 'string') {
-            const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => {
-                return key === v;
-            });
+            const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => key === v);
             if (orgConfig) {
                 return { name: orgConfig.key, description: orgConfig.description };
             }
@@ -46,4 +46,28 @@ function toHelpSection(header, ...vars) {
     return { header, body };
 }
 exports.toHelpSection = toHelpSection;
+function parseVarArgs(args, argv) {
+    const final = {};
+    const argVals = Object.values(args);
+    // Remove arguments from varargs
+    const varargs = argv.filter((val) => !argVals.includes(val));
+    // Support `config set key value`
+    if (varargs.length === 2 && !varargs[0].includes('=')) {
+        return { [varargs[0]]: varargs[1] };
+    }
+    // Ensure that all args are in the right format (e.g. key=value key1=value1)
+    varargs.forEach((arg) => {
+        const split = arg.split('=');
+        if (split.length !== 2) {
+            throw messages.createError('error.InvalidArgumentFormat', [arg]);
+        }
+        const [name, value] = split;
+        if (final[name]) {
+            throw messages.createError('error.DuplicateArgument', [name]);
+        }
+        final[name] = value || undefined;
+    });
+    return final;
+}
+exports.parseVarArgs = parseVarArgs;
 //# sourceMappingURL=util.js.map

package/lib/ux/prompter.d.ts

@@ -4,24 +4,27 @@ export declare class Prompter {
     /**
      * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
      */
-    prompt<T = Prompter.Answers>(questions: Prompter.Questions<T>, initialAnswers?: Partial<T>): Promise<T>;
+    prompt<T extends Prompter.Answers>(questions: Prompter.Questions<T>, initialAnswers?: Partial<T>): Promise<T>;
     /**
      * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */
-    timedPrompt<T = Prompter.Answers>(questions: Prompter.Questions<T>, ms?: number, initialAnswers?: Partial<T>): Promise<T>;
+    timedPrompt<T extends Prompter.Answers>(questions: Prompter.Questions<T>, ms?: number, initialAnswers?: Partial<T>): Promise<T>;
 }
 export declare namespace Prompter {
     type Answers<T = Record<string, unknown>> = T & Record<string, unknown>;
-    type Questions<T> = QuestionCollection<T>;
+    type Questions<T extends Answers> = QuestionCollection<T>;
 }
 /**
  * Generate a formatted table for list and checkbox prompts
  *
  * Each option should contain the same keys as specified in columns.
- * For example,
+ *
+ * @example
+ * ```
  * const columns = { name: 'Name', type: 'Type', path: 'Path' };
  * const options = [{ name: 'foo', type: 'org', path: '/path/to/foo/' }];
  * generateTableChoices(columns, options);
+ * ```
  */
 export declare function generateTableChoices<T>(columns: Dictionary<string>, choices: Array<Dictionary<Nullable<string> | T>>, padForCheckbox?: boolean): ChoiceBase[];
 //# sourceMappingURL=prompter.d.ts.map

package/lib/ux/prompter.js

@@ -14,6 +14,7 @@ class Prompter {
     /**
      * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
      */
+    // eslint-disable-next-line class-methods-use-this
     async prompt(questions, initialAnswers) {
         const answers = await (0, inquirer_1.prompt)(questions, initialAnswers);
         return answers;
@@ -21,6 +22,7 @@ class Prompter {
     /**
      * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */
+    // eslint-disable-next-line class-methods-use-this
     async timedPrompt(questions, ms = 10000, initialAnswers) {
         let id;
         const thePrompt = (0, inquirer_1.prompt)(questions, initialAnswers);
@@ -45,10 +47,13 @@ exports.Prompter = Prompter;
  * Generate a formatted table for list and checkbox prompts
  *
  * Each option should contain the same keys as specified in columns.
- * For example,
+ *
+ * @example
+ * ```
  * const columns = { name: 'Name', type: 'Type', path: 'Path' };
  * const options = [{ name: 'foo', type: 'org', path: '/path/to/foo/' }];
  * generateTableChoices(columns, options);
+ * ```
  */
 function generateTableChoices(columns, choices, 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -58,7 +63,7 @@ padForCheckbox = true) {
         .length)) + 1);
     const choicesOptions = [
         new inquirer_1.Separator(`${padForCheckbox ? ' '.repeat(2) : ''}${columnEntries
-            .map(([, value], index) => value === null || value === void 0 ? void 0 : value.padEnd(columnLengths[index], ' '))
+            .map(([, value], index) => value?.padEnd(columnLengths[index], ' '))
             .join('')}`),
     ];
     for (const meta of choices) {

package/lib/ux/spinner.d.ts

@@ -5,6 +5,14 @@ import { UxBase } from '.';
  */
 export declare class Spinner extends UxBase {
     constructor(outputEnabled: boolean);
+    /**
+     * Get the status of the current spinner.
+     */
+    get status(): string | undefined;
+    /**
+     * Set the status of the current spinner.
+     */
+    set status(status: string | undefined);
     /**
      * Start a spinner on the console.
      */
@@ -15,14 +23,6 @@ export declare class Spinner extends UxBase {
      * 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.
      */