@oclif/core 1.5.0 → 1.5.1

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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/oclif/core/compare/v1.5.0...v1.5.1) (2022-03-03)
+
 ## [1.5.0](https://github.com/oclif/core/compare/v1.4.0...v1.5.0) (2022-03-02)
 
 

package/lib/config/config.js

@@ -473,6 +473,28 @@ class Config {
     }
 }
 exports.Config = Config;
+// when no manifest exists, the default is calculated.  This may throw, so we need to catch it
+const defaultToCached = async (flag) => {
+    // Prefer the helpDefaultValue function (returns a friendly string for complex types)
+    if (typeof flag.defaultHelp === 'function') {
+        try {
+            return await flag.defaultHelp();
+        }
+        catch {
+            return;
+        }
+    }
+    // if not specified, try the default function
+    if (typeof flag.default === 'function') {
+        try {
+            return await flag.default({ options: {}, flags: {} });
+        }
+        catch { }
+    }
+    else {
+        return flag.default;
+    }
+};
 async function toCached(c, plugin) {
     const flags = {};
     for (const [name, flag] of Object.entries(c.flags || {})) {
@@ -508,8 +530,12 @@ async function toCached(c, plugin) {
                 options: flag.options,
                 dependsOn: flag.dependsOn,
                 exclusive: flag.exclusive,
-                default: typeof flag.default === 'function' ? await flag.default({ options: {}, flags: {} }) : flag.default,
+                default: await defaultToCached(flag),
             };
+            // a command-level placeholder in the manifest so that oclif knows it should regenerate the command during help-time
+            if (typeof flag.defaultHelp === 'function') {
+                c.hasDynamicHelp = true;
+            }
         }
     }
     const argsPromise = (c.args || []).map(async (a) => ({

package/lib/help/index.d.ts

@@ -25,6 +25,7 @@ export declare class Help extends HelpBase {
     protected get sortedTopics(): Interfaces.Topic[];
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);
     showHelp(argv: string[]): Promise<void>;
+    private getDynamicCommand;
     showCommandHelp(command: Interfaces.Command): Promise<void>;
     protected showRootHelp(): Promise<void>;
     protected showTopicHelp(topic: Interfaces.Topic): Promise<void>;

package/lib/help/index.js

@@ -8,6 +8,8 @@ const root_1 = require("./root");
 const util_1 = require("../util");
 const util_2 = require("./util");
 const formatter_1 = require("./formatter");
+const plugin_1 = require("../config/plugin");
+const config_1 = require("../config/config");
 var command_2 = require("./command");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return command_2.CommandHelp; } });
 var util_3 = require("./util");
@@ -89,7 +91,13 @@ class Help extends HelpBase {
         }
         const command = this.config.findCommand(subject);
         if (command) {
-            await this.showCommandHelp(command);
+            if (command.hasDynamicHelp) {
+                const dynamicCommand = await (0, config_1.toCached)(await this.getDynamicCommand(command.id));
+                await this.showCommandHelp(dynamicCommand);
+            }
+            else {
+                await this.showCommandHelp(command);
+            }
             return;
         }
         const topic = this.config.findTopic(subject);
@@ -99,6 +107,15 @@ class Help extends HelpBase {
         }
         (0, errors_1.error)(`Command ${subject} not found.`);
     }
+    async getDynamicCommand(cmdName) {
+        const plugin = new plugin_1.Plugin({ ignoreManifest: true, root: this.config.root });
+        await plugin.load();
+        const cmd = await plugin.findCommand(cmdName);
+        if (!cmd) {
+            throw new Error(`Command ${cmdName} not found.`);
+        }
+        return cmd;
+    }
     async showCommandHelp(command) {
         var _a, _b, _c, _d;
         const name = command.id;
@@ -110,8 +127,9 @@ class Help extends HelpBase {
         if (state)
             console.log(`This command is in ${state}.\n`);
         const summary = this.summary(command);
-        if (summary)
+        if (summary) {
             console.log(summary + '\n');
+        }
         console.log(this.formatCommand(command));
         console.log('');
         if (subTopics.length > 0) {

package/lib/interfaces/command.d.ts

@@ -54,6 +54,7 @@ export interface Command extends CommandProps {
     };
     args: Command.Arg[];
     strict: boolean;
+    hasDynamicHelp?: boolean;
 }
 export declare namespace Command {
     interface Arg {
@@ -70,6 +71,7 @@ export declare namespace Command {
         }
         interface Option extends OptionFlagProps {
             default?: string;
+            defaultHelp?: () => Promise<string>;
         }
     }
     interface Base extends CommandProps {
@@ -80,6 +82,7 @@ export declare namespace Command {
         flags?: FlagInput<any>;
         args?: ArgInput;
         strict: boolean;
+        hasDynamicHelp?: boolean;
         new (argv: string[], config: Config): Instance;
         run(argv?: string[], config?: LoadOptions): PromiseLike<any>;
     }

package/lib/interfaces/parser.d.ts

@@ -85,6 +85,7 @@ export declare type DefaultContext<T> = {
     };
 };
 export declare type Default<T> = T | ((context: DefaultContext<T>) => Promise<T>);
+export declare type DefaultHelp<T> = T | ((context: DefaultContext<T>) => Promise<string | undefined>);
 export declare type FlagProps = {
     name: string;
     char?: AlphabetLowercase | AlphabetUppercase;
@@ -139,6 +140,7 @@ export declare type BooleanFlag<T> = FlagBase<T, boolean> & BooleanFlagProps & {
 };
 export declare type OptionFlag<T> = FlagBase<T, string> & OptionFlagProps & {
     default?: Default<T | undefined>;
+    defaultHelp?: DefaultHelp<T>;
     input: string[];
 };
 export declare type Definition<T> = {

package/package.json

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