@oclif/core 3.0.0-beta.17 → 3.0.0-beta.19

package/lib/help/command.js

@@ -11,12 +11,15 @@ const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
 // written on any platform, that may use \r\n or \n, will be
 // split on any platform, not just the os specific EOL at runtime.
 const POSSIBLE_LINE_FEED = /\r\n|\n/;
-let { dim, } = chalk_1.default;
+let { dim } = chalk_1.default;
 if (process.env.ConEmuANSI === 'ON') {
     // eslint-disable-next-line unicorn/consistent-destructuring
     dim = chalk_1.default.gray;
 }
 class CommandHelp extends formatter_1.HelpFormatter {
+    command;
+    config;
+    opts;
     constructor(command, config, opts) {
         super(config, opts);
         this.command = command;
@@ -30,13 +33,15 @@ class CommandHelp extends formatter_1.HelpFormatter {
             .map(([k, v]) => {
             v.name = k;
             return v;
-        }), f => [!f.char, f.char, f.name]);
-        const args = Object.values((0, util_1.ensureArgObject)(cmd.args)).filter(a => !a.hidden);
+        }), (f) => [!f.char, f.char, f.name]);
+        const args = Object.values((0, util_1.ensureArgObject)(cmd.args)).filter((a) => !a.hidden);
         const output = (0, util_1.compact)(this.sections().map(({ header, generate }) => {
             const body = generate({ cmd, flags, args }, header);
             // Generate can return a list of sections
             if (Array.isArray(body)) {
-                return body.map(helpSection => helpSection && helpSection.body && this.section(helpSection.header, helpSection.body)).join('\n\n');
+                return body
+                    .map((helpSection) => helpSection && helpSection.body && this.section(helpSection.header, helpSection.body))
+                    .join('\n\n');
             }
             return body && this.section(header, body);
         })).join('\n\n');
@@ -108,13 +113,14 @@ class CommandHelp extends formatter_1.HelpFormatter {
     usage() {
         const { usage } = this.command;
         const body = (usage ? (0, util_1.castArray)(usage) : [this.defaultUsage()])
-            .map(u => {
+            .map((u) => {
             const allowedSpacing = this.opts.maxWidth - this.indentSpacing;
             const line = `$ ${this.config.bin} ${u}`.trim();
             if (line.length > allowedSpacing) {
                 const splitIndex = line.slice(0, Math.max(0, allowedSpacing)).lastIndexOf(' ');
-                return line.slice(0, Math.max(0, splitIndex)) + '\n'
-                    + this.indent(this.wrap(line.slice(Math.max(0, splitIndex)), this.indentSpacing * 2));
+                return (line.slice(0, Math.max(0, splitIndex)) +
+                    '\n' +
+                    this.indent(this.wrap(line.slice(Math.max(0, splitIndex)), this.indentSpacing * 2)));
             }
             return this.wrap(line);
         })
@@ -128,7 +134,10 @@ class CommandHelp extends formatter_1.HelpFormatter {
         }
         return (0, util_1.compact)([
             this.command.id,
-            Object.values(this.command.args ?? {})?.filter(a => !a.hidden).map(a => this.arg(a)).join(' '),
+            Object.values(this.command.args ?? {})
+                ?.filter((a) => !a.hidden)
+                .map((a) => this.arg(a))
+                .join(' '),
         ]).join(' ');
     }
     description() {
@@ -139,10 +148,9 @@ class CommandHelp extends formatter_1.HelpFormatter {
         }
         else if (cmd.description) {
             const summary = cmd.summary ? `${cmd.summary}\n` : null;
-            description = summary ? [
-                ...summary.split(POSSIBLE_LINE_FEED),
-                ...(cmd.description || '').split(POSSIBLE_LINE_FEED),
-            ] : (cmd.description || '').split(POSSIBLE_LINE_FEED);
+            description = summary
+                ? [...summary.split(POSSIBLE_LINE_FEED), ...(cmd.description || '').split(POSSIBLE_LINE_FEED)]
+                : (cmd.description || '').split(POSSIBLE_LINE_FEED);
         }
         if (description) {
             return this.wrap(description.join('\n'));
@@ -151,50 +159,51 @@ class CommandHelp extends formatter_1.HelpFormatter {
     aliases(aliases) {
         if (!aliases || aliases.length === 0)
             return;
-        const body = aliases.map(a => ['$', this.config.bin, a].join(' ')).join('\n');
+        const body = aliases.map((a) => ['$', this.config.bin, a].join(' ')).join('\n');
         return body;
     }
     examples(examples) {
         if (!examples || examples.length === 0)
             return;
-        const body = (0, util_1.castArray)(examples).map(a => {
+        const body = (0, util_1.castArray)(examples)
+            .map((a) => {
             let description;
             let commands;
             if (typeof a === 'string') {
-                const lines = a
-                    .split(POSSIBLE_LINE_FEED)
-                    .filter(Boolean);
+                const lines = a.split(POSSIBLE_LINE_FEED).filter(Boolean);
                 // If the example is <description>\n<command> then format correctly
-                if (lines.length >= 2 && !this.isCommand(lines[0]) && lines.slice(1).every(i => this.isCommand(i))) {
+                if (lines.length >= 2 && !this.isCommand(lines[0]) && lines.slice(1).every((i) => this.isCommand(i))) {
                     description = lines[0];
                     commands = lines.slice(1);
                 }
                 else {
-                    return lines.map(line => this.formatIfCommand(line)).join('\n');
+                    return lines.map((line) => this.formatIfCommand(line)).join('\n');
                 }
             }
             else {
                 description = a.description;
                 commands = [a.command];
             }
-            const multilineSeparator = this.config.platform === 'win32'
-                ? (this.config.shell.includes('powershell') ? '`' : '^')
-                : '\\';
+            const multilineSeparator = this.config.platform === 'win32' ? (this.config.shell.includes('powershell') ? '`' : '^') : '\\';
             // The command will be indented in the section, which is also indented
             const finalIndentedSpacing = this.indentSpacing * 2;
-            const multilineCommands = commands.map(c => 
+            const multilineCommands = commands
+                .map((c) => 
             // First indent keeping room for escaped newlines
             this.indent(this.wrap(this.formatIfCommand(c), finalIndentedSpacing + 4))
                 // Then add the escaped newline
-                .split(POSSIBLE_LINE_FEED).join(` ${multilineSeparator}\n  `)).join('\n');
+                .split(POSSIBLE_LINE_FEED)
+                .join(` ${multilineSeparator}\n  `))
+                .join('\n');
             return `${this.wrap(description, finalIndentedSpacing)}\n\n${multilineCommands}`;
-        }).join('\n\n');
+        })
+            .join('\n\n');
         return body;
     }
     args(args) {
-        if (args.filter(a => a.description).length === 0)
+        if (args.filter((a) => a.description).length === 0)
             return;
-        return args.map(a => {
+        return args.map((a) => {
             const name = a.name.toUpperCase();
             let description = a.description || '';
             if (a.default)
@@ -242,7 +251,7 @@ class CommandHelp extends formatter_1.HelpFormatter {
     flags(flags) {
         if (flags.length === 0)
             return;
-        return flags.map(flag => {
+        return flags.map((flag) => {
             const left = this.flagHelpLabel(flag);
             let right = flag.summary || flag.description || '';
             if (flag.type === 'option' && flag.default) {
@@ -257,16 +266,21 @@ class CommandHelp extends formatter_1.HelpFormatter {
         });
     }
     flagsDescriptions(flags) {
-        const flagsWithExtendedDescriptions = flags.filter(flag => flag.summary && flag.description);
+        const flagsWithExtendedDescriptions = flags.filter((flag) => flag.summary && flag.description);
         if (flagsWithExtendedDescriptions.length === 0)
             return;
-        const body = flagsWithExtendedDescriptions.map(flag => {
+        const body = flagsWithExtendedDescriptions
+            .map((flag) => {
             // Guaranteed to be set because of the filter above, but make ts happy
             const summary = flag.summary || '';
             let flagHelp = this.flagHelpLabel(flag, true);
-            flagHelp += flagHelp.length + summary.length + 2 < this.opts.maxWidth ? '  ' + summary : '\n\n' + this.indent(this.wrap(summary, this.indentSpacing * 2));
+            flagHelp +=
+                flagHelp.length + summary.length + 2 < this.opts.maxWidth
+                    ? '  ' + summary
+                    : '\n\n' + this.indent(this.wrap(summary, this.indentSpacing * 2));
             return `${flagHelp}\n\n${this.indent(this.wrap(flag.description || '', this.indentSpacing * 2))}`;
-        }).join('\n\n');
+        })
+            .join('\n\n');
         return body;
     }
     formatIfCommand(example) {

package/lib/help/docopts.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocOpts = void 0;
-const util_1 = require("../util");
+const index_1 = require("../util/index");
 /**
  * DocOpts - See http://docopt.org/.
  *
@@ -59,6 +59,9 @@ const util_1 = require("../util");
  *
  */
 class DocOpts {
+    cmd;
+    flagMap;
+    flagList;
     constructor(cmd) {
         this.cmd = cmd;
         // Create a new map with references to the flags that we can manipulate.
@@ -76,7 +79,7 @@ class DocOpts {
     toString() {
         const opts = this.cmd.id === '.' || this.cmd.id === '' ? [] : ['<%= command.id %>'];
         if (this.cmd.args) {
-            const a = Object.values((0, util_1.ensureArgObject)(this.cmd.args)).map(arg => arg.required ? arg.name.toUpperCase() : `[${arg.name.toUpperCase()}]`) || [];
+            const a = Object.values((0, index_1.ensureArgObject)(this.cmd.args)).map((arg) => arg.required ? arg.name.toUpperCase() : `[${arg.name.toUpperCase()}]`) || [];
             opts.push(...a);
         }
         try {
@@ -84,7 +87,7 @@ class DocOpts {
         }
         catch {
             // If there is an error, just return no usage so we don't fail command help.
-            opts.push(...this.flagList.map(flag => {
+            opts.push(...this.flagList.map((flag) => {
                 const name = flag.char ? `-${flag.char}` : `--${flag.name}`;
                 if (flag.type === 'boolean')
                     return name;
@@ -97,9 +100,9 @@ class DocOpts {
         const elementMap = {};
         // Generate all doc opt elements for combining
         // Show required flags first
-        this.generateElements(elementMap, this.flagList.filter(flag => flag.required));
+        this.generateElements(elementMap, this.flagList.filter((flag) => flag.required));
         // Then show optional flags
-        this.generateElements(elementMap, this.flagList.filter(flag => !flag.required));
+        this.generateElements(elementMap, this.flagList.filter((flag) => !flag.required));
         for (const flag of this.flagList) {
             if (Array.isArray(flag.dependsOn)) {
                 this.combineElementsToFlag(elementMap, flag.name, flag.dependsOn, ' ');

package/lib/help/formatter.js

@@ -11,12 +11,23 @@ const widest_line_1 = tslib_1.__importDefault(require("widest-line"));
 const string_width_1 = tslib_1.__importDefault(require("string-width"));
 const wrap_ansi_1 = tslib_1.__importDefault(require("wrap-ansi"));
 class HelpFormatter {
+    indentSpacing = 2;
+    /**
+     * Takes a string and replaces `<%= prop =>` with the value of prop, where prop is anything on
+     * `config=Interfaces.Config` or `opts=Interface.HelpOptions`.
+     *
+     * ```javascript
+     * `<%= config.bin =>` // will resolve to the bin defined in `pjson.oclif`.
+     * ```
+     */
+    render;
     constructor(config, opts = {}) {
-        this.indentSpacing = 2;
         this.config = config;
         this.opts = { maxWidth: screen_1.stdtermwidth, ...opts };
         this.render = (0, util_1.template)(this);
     }
+    config;
+    opts;
     /**
      * Wrap text according to `opts.maxWidth` which is typically set to the terminal width. All text
      * will be rendered before bring wrapped, otherwise it could mess up the lengths.
@@ -106,7 +117,7 @@ class HelpFormatter {
         };
         if (opts.multiline)
             return renderMultiline();
-        const maxLength = (0, widest_line_1.default)(input.map(i => i[0]).join('\n'));
+        const maxLength = (0, widest_line_1.default)(input.map((i) => i[0]).join('\n'));
         let output = '';
         let spacer = opts.spacer || '\n';
         let cur = '';
@@ -126,7 +137,7 @@ class HelpFormatter {
             if (opts.stripAnsi)
                 right = (0, strip_ansi_1.default)(right);
             right = this.wrap(right.trim(), opts.indentation + maxLength + 2);
-            const [first, ...lines] = right.split('\n').map(s => s.trim());
+            const [first, ...lines] = right.split('\n').map((s) => s.trim());
             cur += ' '.repeat(maxLength - (0, string_width_1.default)(cur) + 2);
             cur += first;
             if (lines.length === 0) {
@@ -154,13 +165,13 @@ class HelpFormatter {
             newBody = this.render(body);
         }
         else if (Array.isArray(body)) {
-            newBody = body.map(entry => {
+            newBody = body.map((entry) => {
                 if ('name' in entry) {
                     const tableEntry = entry;
-                    return ([this.render(tableEntry.name), this.render(tableEntry.description)]);
+                    return [this.render(tableEntry.name), this.render(tableEntry.description)];
                 }
                 const [left, right] = entry;
-                return ([this.render(left), right && this.render(right)]);
+                return [this.render(left), right && this.render(right)];
             });
         }
         else if ('header' in body) {
@@ -168,8 +179,8 @@ class HelpFormatter {
         }
         else {
             newBody = body
-                .map((entry) => ([entry.name, entry.description]))
-                .map(([left, right]) => ([this.render(left), right && this.render(right)]));
+                .map((entry) => [entry.name, entry.description])
+                .map(([left, right]) => [this.render(left), right && this.render(right)]);
         }
         const output = [
             chalk_1.default.bold(header),

package/lib/help/index.d.ts

@@ -3,7 +3,7 @@ import { Command } from '../command';
 import { CommandHelp } from './command';
 import { HelpFormatter } from './formatter';
 export { CommandHelp } from './command';
-export { standardizeIDFromArgv, loadHelpClass, getHelpFlagAdditions, normalizeArgv } from './util';
+export { standardizeIDFromArgv, getHelpFlagAdditions, normalizeArgv } from './util';
 export declare abstract class HelpBase extends HelpFormatter {
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);
     /**
@@ -39,3 +39,7 @@ export declare class Help extends HelpBase {
     protected command(command: Command.Class): string;
     protected log(...args: string[]): void;
 }
+interface HelpBaseDerived {
+    new (config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>): HelpBase;
+}
+export declare function loadHelpClass(config: Interfaces.Config): Promise<HelpBaseDerived>;

package/lib/help/index.js

@@ -1,27 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Help = exports.HelpBase = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.loadHelpClass = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
+exports.loadHelpClass = exports.Help = exports.HelpBase = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
 const tslib_1 = require("tslib");
-const util_1 = require("../util");
-const util_2 = require("./util");
+const index_1 = require("../util/index");
+const util_1 = require("./util");
 const command_1 = require("./command");
 const formatter_1 = require("./formatter");
 const root_1 = tslib_1.__importDefault(require("./root"));
+const cache_default_value_1 = require("../util/cache-default-value");
 const errors_1 = require("../errors");
 const node_util_1 = require("node:util");
+const module_loader_1 = require("../module-loader");
 const stream_1 = require("../cli-ux/stream");
-const config_1 = require("../config/config");
-const stripAnsi = require("strip-ansi");
+const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
 var command_2 = require("./command");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return command_2.CommandHelp; } });
-var util_3 = require("./util");
-Object.defineProperty(exports, "standardizeIDFromArgv", { enumerable: true, get: function () { return util_3.standardizeIDFromArgv; } });
-Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return util_3.loadHelpClass; } });
-Object.defineProperty(exports, "getHelpFlagAdditions", { enumerable: true, get: function () { return util_3.getHelpFlagAdditions; } });
-Object.defineProperty(exports, "normalizeArgv", { enumerable: true, get: function () { return util_3.normalizeArgv; } });
+var util_2 = require("./util");
+Object.defineProperty(exports, "standardizeIDFromArgv", { enumerable: true, get: function () { return util_2.standardizeIDFromArgv; } });
+Object.defineProperty(exports, "getHelpFlagAdditions", { enumerable: true, get: function () { return util_2.getHelpFlagAdditions; } });
+Object.defineProperty(exports, "normalizeArgv", { enumerable: true, get: function () { return util_2.normalizeArgv; } });
 function getHelpSubject(args, config) {
     // for each help flag that starts with '--' create a new flag with same name sans '--'
-    const mergedHelpFlags = (0, util_2.getHelpFlagAdditions)(config);
+    const mergedHelpFlags = (0, util_1.getHelpFlagAdditions)(config);
     for (const arg of args) {
         if (arg === '--')
             return;
@@ -41,6 +41,7 @@ class HelpBase extends formatter_1.HelpFormatter {
 }
 exports.HelpBase = HelpBase;
 class Help extends HelpBase {
+    CommandHelpClass = command_1.CommandHelp;
     /*
      * _topics is to work around Interfaces.topics mistakenly including commands that do
      * not have children, as well as topics. A topic has children, either commands or other topics. When
@@ -50,33 +51,32 @@ class Help extends HelpBase {
     get _topics() {
         return this.config.topics.filter((topic) => {
             // it is assumed a topic has a child if it has children
-            const hasChild = this.config.topics.some(subTopic => subTopic.name.includes(`${topic.name}:`));
+            const hasChild = this.config.topics.some((subTopic) => subTopic.name.includes(`${topic.name}:`));
             return hasChild;
         });
     }
     get sortedCommands() {
         let { commands } = this.config;
-        commands = commands.filter(c => this.opts.all || !c.hidden);
-        commands = (0, util_1.sortBy)(commands, c => c.id);
-        commands = (0, util_1.uniqBy)(commands, c => c.id);
+        commands = commands.filter((c) => this.opts.all || !c.hidden);
+        commands = (0, index_1.sortBy)(commands, (c) => c.id);
+        commands = (0, index_1.uniqBy)(commands, (c) => c.id);
         return commands;
     }
     get sortedTopics() {
         let topics = this._topics;
-        topics = topics.filter(t => this.opts.all || !t.hidden);
-        topics = (0, util_1.sortBy)(topics, t => t.name);
-        topics = (0, util_1.uniqBy)(topics, t => t.name);
+        topics = topics.filter((t) => this.opts.all || !t.hidden);
+        topics = (0, index_1.sortBy)(topics, (t) => t.name);
+        topics = (0, index_1.uniqBy)(topics, (t) => t.name);
         return topics;
     }
     constructor(config, opts = {}) {
         super(config, opts);
-        this.CommandHelpClass = command_1.CommandHelp;
     }
     async showHelp(argv) {
         const originalArgv = argv.slice(1);
-        argv = argv.filter(arg => !(0, util_2.getHelpFlagAdditions)(this.config).includes(arg));
+        argv = argv.filter((arg) => !(0, util_1.getHelpFlagAdditions)(this.config).includes(arg));
         if (this.config.topicSeparator !== ':')
-            argv = (0, util_2.standardizeIDFromArgv)(argv, this.config);
+            argv = (0, util_1.standardizeIDFromArgv)(argv, this.config);
         const subject = getHelpSubject(argv, this.config);
         if (!subject) {
             if (this.config.pjson.oclif.default) {
@@ -92,8 +92,14 @@ class Help extends HelpBase {
         const command = this.config.findCommand(subject);
         if (command) {
             if (command.hasDynamicHelp && command.pluginType !== 'jit') {
-                const dynamicCommand = await (0, config_1.toCached)(await command.load());
-                await this.showCommandHelp(dynamicCommand);
+                const loaded = await command.load();
+                for (const [name, flag] of Object.entries(loaded.flags)) {
+                    if (flag.type === 'boolean' || !command.flags[name].hasDynamicHelp)
+                        continue;
+                    // eslint-disable-next-line no-await-in-loop
+                    command.flags[name].default = await (0, cache_default_value_1.cacheDefaultValue)(flag, false);
+                }
+                await this.showCommandHelp(command);
             }
             else {
                 await this.showCommandHelp(command);
@@ -110,7 +116,7 @@ class Help extends HelpBase {
             if (matches.length > 0) {
                 const result = await this.config.runHook('command_incomplete', {
                     id: subject,
-                    argv: originalArgv.filter(o => !subject.split(':').includes(o)),
+                    argv: originalArgv.filter((o) => !subject.split(':').includes(o)),
                     matches,
                 });
                 if (result.successes.length > 0)
@@ -122,15 +128,20 @@ class Help extends HelpBase {
     async showCommandHelp(command) {
         const name = command.id;
         const depth = name.split(':').length;
-        const subTopics = this.sortedTopics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
-        const subCommands = this.sortedCommands.filter(c => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
+        const subTopics = this.sortedTopics.filter((t) => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
+        const subCommands = this.sortedCommands.filter((c) => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
         const plugin = this.config.plugins.get(command.pluginName);
         const state = this.config.pjson?.oclif?.state || plugin?.pjson?.oclif?.state || command.state;
         if (state) {
             this.log(state === 'deprecated'
-                ? `${(0, util_2.formatCommandDeprecationWarning)((0, util_2.toConfiguredId)(name, this.config), command.deprecationOptions)}`
+                ? `${(0, util_1.formatCommandDeprecationWarning)((0, util_1.toConfiguredId)(name, this.config), command.deprecationOptions)}\n`
                 : `This command is in ${state}.\n`);
         }
+        if (command.deprecateAliases && command.aliases.includes(name)) {
+            const actualCmd = this.config.commands.find((c) => c.aliases.includes(name));
+            const opts = { ...command.deprecationOptions, ...(actualCmd ? { to: actualCmd.id } : {}) };
+            this.log(`${(0, util_1.formatCommandDeprecationWarning)((0, util_1.toConfiguredId)(name, this.config), opts)}\n`);
+        }
         const summary = this.summary(command);
         if (summary) {
             this.log(summary + '\n');
@@ -143,7 +154,7 @@ class Help extends HelpBase {
         }
         if (subCommands.length > 0) {
             const aliases = [];
-            const uniqueSubCommands = subCommands.filter(p => {
+            const uniqueSubCommands = subCommands.filter((p) => {
                 aliases.push(...p.aliases);
                 return !aliases.includes(p.id);
             });
@@ -156,22 +167,20 @@ class Help extends HelpBase {
         let rootCommands = this.sortedCommands;
         const state = this.config.pjson?.oclif?.state;
         if (state) {
-            this.log(state === 'deprecated'
-                ? `${this.config.bin} is deprecated`
-                : `${this.config.bin} is in ${state}.\n`);
+            this.log(state === 'deprecated' ? `${this.config.bin} is deprecated` : `${this.config.bin} is in ${state}.\n`);
         }
         this.log(this.formatRoot());
         this.log('');
         if (!this.opts.all) {
-            rootTopics = rootTopics.filter(t => !t.name.includes(':'));
-            rootCommands = rootCommands.filter(c => !c.id.includes(':'));
+            rootTopics = rootTopics.filter((t) => !t.name.includes(':'));
+            rootCommands = rootCommands.filter((c) => !c.id.includes(':'));
         }
         if (rootTopics.length > 0) {
             this.log(this.formatTopics(rootTopics));
             this.log('');
         }
         if (rootCommands.length > 0) {
-            rootCommands = rootCommands.filter(c => c.id);
+            rootCommands = rootCommands.filter((c) => c.id);
             this.log(this.formatCommands(rootCommands));
             this.log('');
         }
@@ -179,8 +188,8 @@ class Help extends HelpBase {
     async showTopicHelp(topic) {
         const { name } = topic;
         const depth = name.split(':').length;
-        const subTopics = this.sortedTopics.filter(t => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
-        const commands = this.sortedCommands.filter(c => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
+        const subTopics = this.sortedTopics.filter((t) => t.name.startsWith(name + ':') && t.name.split(':').length === depth + 1);
+        const commands = this.sortedCommands.filter((c) => c.id.startsWith(name + ':') && c.id.split(':').length === depth + 1);
         const state = this.config.pjson?.oclif?.state;
         if (state)
             this.log(`This topic is in ${state}.\n`);
@@ -201,7 +210,7 @@ class Help extends HelpBase {
     formatCommand(command) {
         if (this.config.topicSeparator !== ':') {
             command.id = command.id.replaceAll(':', this.config.topicSeparator);
-            command.aliases = command.aliases && command.aliases.map(a => a.replaceAll(':', this.config.topicSeparator));
+            command.aliases = command.aliases && command.aliases.map((a) => a.replaceAll(':', this.config.topicSeparator));
         }
         const help = this.getCommandHelpClass(command);
         return help.generate();
@@ -212,13 +221,10 @@ class Help extends HelpBase {
     formatCommands(commands) {
         if (commands.length === 0)
             return '';
-        const body = this.renderList(commands.map(c => {
+        const body = this.renderList(commands.map((c) => {
             if (this.config.topicSeparator !== ':')
                 c.id = c.id.replaceAll(':', this.config.topicSeparator);
-            return [
-                c.id,
-                this.summary(c),
-            ];
+            return [c.id, this.summary(c)];
         }), {
             spacer: '\n',
             stripAnsi: this.opts.stripAnsi,
@@ -245,25 +251,22 @@ class Help extends HelpBase {
         let topicID = `${topic.name}:COMMAND`;
         if (this.config.topicSeparator !== ':')
             topicID = topicID.replaceAll(':', this.config.topicSeparator);
-        let output = (0, util_1.compact)([
+        let output = (0, index_1.compact)([
             summary,
             this.section(this.opts.usageHeader || 'USAGE', `$ ${this.config.bin} ${topicID}`),
             description && this.section('DESCRIPTION', this.wrap(description)),
         ]).join('\n\n');
         if (this.opts.stripAnsi)
-            output = stripAnsi(output);
+            output = (0, strip_ansi_1.default)(output);
         return output + '\n';
     }
     formatTopics(topics) {
         if (topics.length === 0)
             return '';
-        const body = this.renderList(topics.map(c => {
+        const body = this.renderList(topics.map((c) => {
             if (this.config.topicSeparator !== ':')
                 c.name = c.name.replaceAll(':', this.config.topicSeparator);
-            return [
-                c.name,
-                c.description && this.render(c.description.split('\n')[0]),
-            ];
+            return [c.name, c.description && this.render(c.description.split('\n')[0])];
         }), {
             spacer: '\n',
             stripAnsi: this.opts.stripAnsi,
@@ -279,3 +282,21 @@ class Help extends HelpBase {
     }
 }
 exports.Help = Help;
+function extractClass(exported) {
+    return exported && exported.default ? exported.default : exported;
+}
+async function loadHelpClass(config) {
+    const { pjson } = config;
+    const configuredClass = pjson.oclif?.helpClass;
+    if (configuredClass) {
+        try {
+            const exported = (await (0, module_loader_1.load)(config, configuredClass));
+            return extractClass(exported);
+        }
+        catch (error) {
+            throw new Error(`Unable to load configured help class "${configuredClass}", failed with message:\n${error.message}`);
+        }
+    }
+    return Help;
+}
+exports.loadHelpClass = loadHelpClass;

package/lib/help/root.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const formatter_1 = require("./formatter");
-const util_1 = require("../util");
-const stripAnsi = require("strip-ansi");
+const index_1 = require("../util/index");
+const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
 class RootHelp extends formatter_1.HelpFormatter {
+    config;
+    opts;
     constructor(config, opts) {
         super(config, opts);
         this.config = config;
@@ -13,14 +16,9 @@ class RootHelp extends formatter_1.HelpFormatter {
         let description = this.config.pjson.oclif.description || this.config.pjson.description || '';
         description = this.render(description);
         description = description.split('\n')[0];
-        let output = (0, util_1.compact)([
-            description,
-            this.version(),
-            this.usage(),
-            this.description(),
-        ]).join('\n\n');
+        let output = (0, index_1.compact)([description, this.version(), this.usage(), this.description()]).join('\n\n');
         if (this.opts.stripAnsi)
-            output = stripAnsi(output);
+            output = (0, strip_ansi_1.default)(output);
         return output;
     }
     usage() {

package/lib/help/util.d.ts

@@ -1,9 +1,4 @@
-import { Deprecation, HelpOptions, Config as IConfig } from '../interfaces';
-import { HelpBase } from '.';
-interface HelpBaseDerived {
-    new (config: IConfig, opts?: Partial<HelpOptions>): HelpBase;
-}
-export declare function loadHelpClass(config: IConfig): Promise<HelpBaseDerived>;
+import { Deprecation, Config as IConfig } from '../interfaces';
 export declare function template(context: any): (t: string) => string;
 export declare function toStandardizedId(commandID: string, config: IConfig): string;
 export declare function toConfiguredId(commandID: string, config: IConfig): string;
@@ -12,4 +7,3 @@ export declare function getHelpFlagAdditions(config: IConfig): string[];
 export declare function formatFlagDeprecationWarning(flag: string, opts: true | Deprecation): string;
 export declare function formatCommandDeprecationWarning(command: string, opts?: Deprecation): string;
 export declare function normalizeArgv(config: IConfig, argv?: string[]): string[];
-export {};