@oclif/core 3.26.9 → 3.27.0

package/lib/help/command.js

@@ -154,12 +154,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
             label = labels.join(flag.char ? (0, theme_1.colorize)(this.config?.theme?.flagSeparator, ', ') : '  ');
         }
         if (flag.type === 'option') {
-            let value = flag.helpValue || (this.opts.showFlagNameInTitle ? flag.name : '<value>');
-            if (!flag.helpValue && flag.options) {
-                value = showOptions || this.opts.showFlagOptionsInTitle ? `${flag.options.join('|')}` : '<option>';
-            }
-            if (flag.multiple)
-                value += '...';
+            let value = docopts_1.DocOpts.formatUsageType(flag, this.opts.showFlagNameInTitle ?? false, this.opts.showFlagOptionsInTitle ?? showOptions);
             if (!value.includes('|'))
                 value = chalk_1.default.underline(value);
             label += `=${value}`;

package/lib/help/docopts.d.ts

@@ -60,6 +60,7 @@ export declare class DocOpts {
     private flagList;
     private flagMap;
     constructor(cmd: Command.Loadable);
+    static formatUsageType(flag: Command.Flag.Any, showFlagName: boolean, showOptions: boolean): string;
     static generate(cmd: Command.Loadable): string;
     toString(): string;
     private combineElementsToFlag;

package/lib/help/docopts.js

@@ -73,6 +73,27 @@ class DocOpts {
             return flag;
         });
     }
+    static formatUsageType(flag, showFlagName, showOptions) {
+        if (flag.type !== 'option')
+            return '';
+        let helpValues;
+        if (flag.helpValue) {
+            // if there is a given helpValue, use it
+            helpValues = typeof flag.helpValue === 'string' ? [flag.helpValue] : flag.helpValue;
+        }
+        else if (flag.options) {
+            // if there are options, show them if wanted
+            helpValues = [showOptions ? flag.options.join('|') : '<option>'];
+        }
+        else if (showFlagName) {
+            helpValues = [flag.name];
+        }
+        else {
+            // default to <value>
+            helpValues = ['<value>'];
+        }
+        return helpValues.map((v) => `${v}${flag.multiple ? '...' : ''}`).join(' ');
+    }
     static generate(cmd) {
         return new DocOpts(cmd).toString();
     }
@@ -93,7 +114,7 @@ class DocOpts {
                 const name = flag.char ? `-${flag.char}` : `--${flag.name}`;
                 if (flag.type === 'boolean')
                     return name;
-                return `${name}=<value>`;
+                return `${name}=${DocOpts.formatUsageType(flag, false, true)}`;
             }));
         }
         return opts.join(' ');
@@ -123,7 +144,7 @@ class DocOpts {
             // not all flags have short names
             const flagName = flag.char ? `-${flag.char}` : `--${flag.name}`;
             if (flag.type === 'option') {
-                type = flag.options ? ` ${flag.options.join('|')}` : ' <value>';
+                type = ` ${DocOpts.formatUsageType(flag, false, true)}`;
             }
             const element = `${flagName}${type}`;
             elementMap[flag.name] = element;

package/lib/interfaces/parser.d.ts

@@ -198,7 +198,7 @@ export type BooleanFlagProps = FlagProps & {
 };
 export type OptionFlagProps = FlagProps & {
     type: 'option';
-    helpValue?: string;
+    helpValue?: string | string[];
     options?: readonly string[];
     multiple?: boolean;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.26.9",
+  "version": "3.27.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {