@oclif/core 4.0.0-beta.1 → 4.0.0-beta.10

package/lib/config/plugin-loader.js

@@ -1,37 +1,13 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const minimatch_1 = require("minimatch");
 const node_path_1 = require("node:path");
 const performance_1 = require("../performance");
 const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
-const Plugin = __importStar(require("./plugin"));
+const plugin_1 = require("./plugin");
 const util_2 = require("./util");
-// eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)();
+const debug = (0, util_2.makeDebug)();
 function findMatchingDependencies(dependencies, patterns) {
     return Object.keys(dependencies).filter((p) => patterns.some((w) => (0, minimatch_1.minimatch)(p, w)));
 }
@@ -63,7 +39,7 @@ class PluginLoader {
         }
         else {
             const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, 'plugin.load#root');
-            rootPlugin = new Plugin.Plugin({ isRoot: true, pjson, root: this.options.root });
+            rootPlugin = new plugin_1.Plugin({ isRoot: true, pjson, root: this.options.root });
             await rootPlugin.load();
             marker?.addDetails({
                 commandCount: rootPlugin.commands.length,
@@ -155,7 +131,7 @@ class PluginLoader {
                 if (this.plugins.has(name))
                     return;
                 const pluginMarker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, `plugin.load#${name}`);
-                const instance = new Plugin.Plugin(opts);
+                const instance = new plugin_1.Plugin(opts);
                 await instance.load();
                 pluginMarker?.addDetails({
                     commandCount: instance.commands.length,

package/lib/config/plugin.d.ts

@@ -19,10 +19,10 @@ export declare class Plugin implements IPlugin {
     manifest: Manifest;
     moduleType: 'commonjs' | 'module';
     name: string;
-    parent: Plugin | undefined;
-    pjson: PJSON.Plugin;
+    parent?: Plugin | undefined;
+    pjson: PJSON;
     root: string;
-    tag?: string;
+    tag?: string | undefined;
     type: string;
     valid: boolean;
     version: string;

package/lib/config/plugin.js

@@ -15,6 +15,7 @@ const symbols_1 = require("../symbols");
 const cache_command_1 = require("../util/cache-command");
 const find_root_1 = require("../util/find-root");
 const fs_1 = require("../util/fs");
+const read_pjson_1 = require("../util/read-pjson");
 const util_1 = require("../util/util");
 const ts_path_1 = require("./ts-path");
 const util_2 = require("./util");
@@ -56,12 +57,9 @@ function processCommandIds(files) {
         return id === '' ? symbols_1.SINGLE_COMMAND_CLI_SYMBOL : id;
     });
 }
-function determineCommandDiscoveryOptions(commandDiscovery, defaultCmdId) {
+function determineCommandDiscoveryOptions(commandDiscovery) {
     if (!commandDiscovery)
         return;
-    if (typeof commandDiscovery === 'string' && defaultCmdId) {
-        return { strategy: 'single', target: commandDiscovery };
-    }
     if (typeof commandDiscovery === 'string') {
         return { globPatterns: GLOB_PATTERNS, strategy: 'pattern', target: commandDiscovery };
     }
@@ -104,8 +102,7 @@ class Plugin {
     valid = false;
     version;
     _base = `${_pjson.name}@${_pjson.version}`;
-    // eslint-disable-next-line new-cap
-    _debug = (0, util_2.Debug)();
+    _debug = (0, util_2.makeDebug)();
     commandCache;
     commandDiscoveryOpts;
     flexibleTaxonomy;
@@ -183,15 +180,14 @@ class Plugin {
             throw new errors_1.CLIError(`could not find package.json with ${(0, node_util_1.inspect)(this.options)}`);
         this.root = root;
         this._debug(`loading ${this.type} plugin from ${root}`);
-        this.pjson = this.options.pjson ?? (await (0, fs_1.readJson)((0, node_path_1.join)(root, 'package.json')));
+        this.pjson = this.options.pjson ?? (await (0, read_pjson_1.readPjson)(root));
         this.flexibleTaxonomy = this.options?.flexibleTaxonomy || this.pjson.oclif?.flexibleTaxonomy || false;
         this.moduleType = this.pjson.type === 'module' ? 'module' : 'commonjs';
         this.name = this.pjson.name;
         this.alias = this.options.name ?? this.pjson.name;
         if (!this.name)
             throw new errors_1.CLIError(`no name in package.json (${root})`);
-        // eslint-disable-next-line new-cap
-        this._debug = (0, util_2.Debug)(this.name);
+        this._debug = (0, util_2.makeDebug)(this.name);
         this.version = this.pjson.version;
         if (this.pjson.oclif) {
             this.valid = true;
@@ -203,7 +199,7 @@ class Plugin {
             k,
             (0, util_1.castArray)(v).map((v) => determineHookOptions(v)),
         ]));
-        this.commandDiscoveryOpts = determineCommandDiscoveryOptions(this.pjson.oclif?.commands, this.pjson.oclif?.default);
+        this.commandDiscoveryOpts = determineCommandDiscoveryOptions(this.pjson.oclif?.commands);
         this._debug('command discovery options', this.commandDiscoveryOpts);
         this.manifest = await this._manifest();
         this.commands = Object.entries(this.manifest.commands)
@@ -278,7 +274,7 @@ class Plugin {
                         throw this.addErrorScope(error, scope);
                 }
             })))
-                // eslint-disable-next-line unicorn/no-await-expression-member, unicorn/prefer-native-coercion-functions
+                // eslint-disable-next-line unicorn/prefer-native-coercion-functions
                 .filter((f) => Boolean(f))
                 .reduce((commands, [id, c]) => {
                 commands[id] = c;
@@ -298,6 +294,8 @@ class Plugin {
             scope && `task: ${scope}`,
             `plugin: ${this.name}`,
             `root: ${this.root}`,
+            ...(err.code ? [`code: ${err.code}`] : []),
+            ...(err.message ? [`message: ${err.message}`] : []),
             'See more details with DEBUG=*',
         ]).join('\n');
         return err;

package/lib/config/ts-path.d.ts

@@ -6,4 +6,4 @@ export declare const TS_CONFIGS: Record<string, TSConfig | undefined>;
  * if there is a tsconfig and the original sources exist, it attempts to require ts-node
  */
 export declare function tsPath(root: string, orig: string, plugin: Plugin): Promise<string>;
-export declare function tsPath(root: string, orig: string | undefined, plugin?: Plugin): Promise<string | undefined>;
+export declare function tsPath(root: string, orig: string | undefined, plugin?: Plugin | undefined): Promise<string | undefined>;

package/lib/config/ts-path.js

@@ -13,8 +13,7 @@ const fs_1 = require("../util/fs");
 const read_tsconfig_1 = require("../util/read-tsconfig");
 const util_1 = require("../util/util");
 const util_2 = require("./util");
-// eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)('ts-path');
+const debug = (0, util_2.makeDebug)('ts-path');
 exports.TS_CONFIGS = {};
 const REGISTERED = new Set();
 function determineRuntime() {
@@ -76,7 +75,7 @@ async function loadTSConfig(root) {
         if (isErrno(error))
             return;
         debug(`Could not parse tsconfig.json. Skipping typescript path lookup for ${root}.`);
-        (0, warn_1.warn)(`Could not parse tsconfig.json for ${root}. Falling back to compiled source.`);
+        (0, warn_1.memoizedWarn)(`Could not parse tsconfig.json for ${root}. Falling back to compiled source.`);
     }
 }
 async function registerTSNode(root, tsconfig) {
@@ -91,7 +90,7 @@ async function registerTSNode(root, tsconfig) {
     }
     catch {
         debug(`Could not find ts-node at ${tsNodePath}. Skipping ts-node registration for ${root}.`);
-        (0, warn_1.warn)(`Could not find ts-node at ${tsNodePath}. Please ensure that ts-node is a devDependency. Falling back to compiled source.`);
+        (0, warn_1.memoizedWarn)(`Could not find ts-node at ${tsNodePath}. Please ensure that ts-node is a devDependency. Falling back to compiled source.`);
         return;
     }
     const typeRoots = [(0, node_path_1.join)(root, 'node_modules', '@types')];
@@ -220,7 +219,7 @@ async function determinePath(root, orig) {
     }
     debug(`No source file found. Returning default path ${orig}`);
     if (!(0, util_1.isProd)())
-        (0, warn_1.warn)(`Could not find source for ${orig} based on tsconfig. Defaulting to compiled source.`);
+        (0, warn_1.memoizedWarn)(`Could not find source for ${orig} based on tsconfig. Defaulting to compiled source.`);
     return orig;
 }
 async function tsPath(root, orig, plugin) {
@@ -243,12 +242,12 @@ async function tsPath(root, orig, plugin) {
     if (cannotTranspileEsm(rootPlugin, plugin, isProduction)) {
         debug(`Skipping typescript path lookup for ${root} because it's an ESM module (NODE_ENV: ${process.env.NODE_ENV}, root plugin module type: ${rootPlugin?.moduleType})`);
         if (plugin?.type === 'link')
-            (0, warn_1.warn)(`${plugin?.name} is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used instead.`);
+            (0, warn_1.memoizedWarn)(`${plugin?.name} is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used instead.`);
         return orig;
     }
     if (cannotUseTsNode(root, plugin, isProduction)) {
         debug(`Skipping typescript path lookup for ${root} because ts-node is run in node version ${process.version}"`);
-        (0, warn_1.warn)(`ts-node executable cannot transpile ESM in Node 20. Existing compiled source will be used instead. See https://github.com/oclif/core/issues/817.`);
+        (0, warn_1.memoizedWarn)(`ts-node executable cannot transpile ESM in Node 20. Existing compiled source will be used instead. See https://github.com/oclif/core/issues/817.`);
         return orig;
     }
     try {

package/lib/config/util.d.ts

@@ -1,4 +1,4 @@
-export declare function Debug(...scope: string[]): (..._: any) => void;
+export declare function makeDebug(...scope: string[]): (..._: any) => void;
 export declare function getPermutations(arr: string[]): Array<string[]>;
 export declare function getCommandIdPermutations(commandId: string): string[];
 /**

package/lib/config/util.js

@@ -1,27 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.Debug = void 0;
-const debug = require('debug');
-function displayWarnings() {
-    if (process.listenerCount('warning') > 1)
-        return;
-    process.on('warning', (warning) => {
-        console.error(warning.stack);
-        if (warning.detail)
-            console.error(warning.detail);
-    });
+exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.makeDebug = void 0;
+const logger_1 = require("../logger");
+function makeDebug(...scope) {
+    return (formatter, ...args) => (0, logger_1.getLogger)(['config', ...scope].join(':')).debug(formatter, ...args);
 }
-function Debug(...scope) {
-    if (!debug)
-        return (..._) => {
-            // noop
-        };
-    const d = debug(['config', ...scope].join(':'));
-    if (d.enabled)
-        displayWarnings();
-    return (...args) => d(...args);
-}
-exports.Debug = Debug;
+exports.makeDebug = makeDebug;
 // Adapted from https://github.com/angus-c/just/blob/master/packages/array-permutations/index.js
 function getPermutations(arr) {
     if (arr.length === 0)

package/lib/errors/error.js

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.error = void 0;
+const logger_1 = require("../logger");
 const write_1 = require("../ux/write");
-const config_1 = require("./config");
 const cli_1 = require("./errors/cli");
 const pretty_print_1 = __importStar(require("./errors/pretty-print"));
 function error(input, options = {}) {
@@ -44,8 +44,8 @@ function error(input, options = {}) {
         const message = (0, pretty_print_1.default)(err);
         if (message)
             (0, write_1.stderr)(message);
-        if (config_1.config.errorLogger)
-            config_1.config.errorLogger.log(err?.stack ?? '');
+        if (err?.stack)
+            (0, logger_1.getLogger)().error(err.stack);
     }
     else
         throw err;

package/lib/errors/errors/cli.d.ts

@@ -3,15 +3,15 @@ import { OclifError, PrettyPrintableError } from '../../interfaces/errors';
  * properties specific to internal oclif error handling
  */
 export declare function addOclifExitCode(error: Record<string, any>, options?: {
-    exit?: false | number;
+    exit?: false | number | undefined;
 }): OclifError;
 export declare class CLIError extends Error implements OclifError {
-    code?: string;
+    code?: string | undefined;
     oclif: OclifError['oclif'];
-    skipOclifErrorHandling?: boolean;
-    suggestions?: string[];
+    skipOclifErrorHandling?: boolean | undefined;
+    suggestions?: string[] | undefined;
     constructor(error: Error | string, options?: {
-        exit?: false | number;
+        exit?: false | number | undefined;
     } & PrettyPrintableError);
     get bang(): string | undefined;
     get stack(): string;

package/lib/errors/errors/cli.js

@@ -10,7 +10,7 @@ const indent_string_1 = __importDefault(require("indent-string"));
 const wrap_ansi_1 = __importDefault(require("wrap-ansi"));
 const cache_1 = __importDefault(require("../../cache"));
 const screen_1 = require("../../screen");
-const config_1 = require("../config");
+const settings_1 = require("../../settings");
 /**
  * properties specific to internal oclif error handling
  */
@@ -48,7 +48,7 @@ class CLIError extends Error {
      * @return {string} returns a string representing the dispay of the error
      */
     render() {
-        if (config_1.config.debug) {
+        if (settings_1.settings.debug) {
             return this.stack;
         }
         let output = `${this.name}: ${this.message}`;

package/lib/errors/errors/pretty-print.d.ts

@@ -1,7 +1,7 @@
 import { PrettyPrintableError } from '../../interfaces/errors';
 type CLIErrorDisplayOptions = {
-    bang?: string;
-    name?: string;
+    bang?: string | undefined;
+    name?: string | undefined;
 };
 export declare function applyPrettyPrintOptions(error: Error, options: PrettyPrintableError): PrettyPrintableError;
 export default function prettyPrint(error: Error & PrettyPrintableError & CLIErrorDisplayOptions): string | undefined;

package/lib/errors/errors/pretty-print.js

@@ -7,7 +7,7 @@ exports.applyPrettyPrintOptions = void 0;
 const indent_string_1 = __importDefault(require("indent-string"));
 const wrap_ansi_1 = __importDefault(require("wrap-ansi"));
 const screen_1 = require("../../screen");
-const config_1 = require("../config");
+const settings_1 = require("../../settings");
 function applyPrettyPrintOptions(error, options) {
     const prettyErrorKeys = ['message', 'code', 'ref', 'suggestions'];
     for (const key of prettyErrorKeys) {
@@ -30,7 +30,7 @@ const formatSuggestions = (suggestions) => {
     return `${label}\n${(0, indent_string_1.default)(multiple, 2)}`;
 };
 function prettyPrint(error) {
-    if (config_1.config.debug) {
+    if (settings_1.settings.debug) {
         return error.stack;
     }
     const { bang, code, message, name: errorSuffix, ref, suggestions } = error;

package/lib/errors/handle.js

@@ -7,7 +7,7 @@ exports.handle = exports.Exit = void 0;
 const clean_stack_1 = __importDefault(require("clean-stack"));
 const cache_1 = __importDefault(require("../cache"));
 const index_1 = require("../help/index");
-const config_1 = require("./config");
+const logger_1 = require("../logger");
 const cli_1 = require("./errors/cli");
 const exit_1 = require("./errors/exit");
 const pretty_print_1 = __importDefault(require("./errors/pretty-print"));
@@ -46,17 +46,10 @@ async function handle(err) {
             }
         }
         const exitCode = err.oclif?.exit ?? 1;
-        if (config_1.config.errorLogger && err.code !== 'EEXIT') {
-            if (stack) {
-                config_1.config.errorLogger.log(stack);
-            }
-            await config_1.config.errorLogger
-                .flush()
-                .then(() => exports.Exit.exit(exitCode))
-                .catch(console.error);
+        if (err.code !== 'EEXIT' && stack) {
+            (0, logger_1.getLogger)().error(stack);
         }
-        else
-            exports.Exit.exit(exitCode);
+        exports.Exit.exit(exitCode);
     }
     catch (error) {
         console.error(err.stack);

package/lib/errors/index.d.ts

@@ -1,10 +1,8 @@
 export { PrettyPrintableError } from '../interfaces';
-export { config } from './config';
 export { error } from './error';
 export { CLIError } from './errors/cli';
 export { ExitError } from './errors/exit';
 export { ModuleLoadError } from './errors/module-load';
 export { exit } from './exit';
 export { handle } from './handle';
-export { Logger } from './logger';
 export { warn } from './warn';

package/lib/errors/index.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.warn = exports.Logger = exports.handle = exports.exit = exports.ModuleLoadError = exports.ExitError = exports.CLIError = exports.error = exports.config = void 0;
-var config_1 = require("./config");
-Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });
+exports.warn = exports.handle = exports.exit = exports.ModuleLoadError = exports.ExitError = exports.CLIError = exports.error = void 0;
 var error_1 = require("./error");
 Object.defineProperty(exports, "error", { enumerable: true, get: function () { return error_1.error; } });
 var cli_1 = require("./errors/cli");
@@ -15,7 +13,5 @@ var exit_2 = require("./exit");
 Object.defineProperty(exports, "exit", { enumerable: true, get: function () { return exit_2.exit; } });
 var handle_1 = require("./handle");
 Object.defineProperty(exports, "handle", { enumerable: true, get: function () { return handle_1.handle; } });
-var logger_1 = require("./logger");
-Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
 var warn_1 = require("./warn");
 Object.defineProperty(exports, "warn", { enumerable: true, get: function () { return warn_1.warn; } });

package/lib/errors/warn.d.ts

@@ -1,14 +1,8 @@
-type Options = {
-    /**
-     * If true, will only print the same warning once.
-     */
-    ignoreDuplicates?: boolean;
-};
 /**
  * Prints a pretty warning message to stderr.
  *
  * @param input The error or string to print.
- * @param options.ignoreDuplicates If true, will only print the same warning once.
  */
-export declare function warn(input: Error | string, options?: Options): void;
+export declare function warn(input: Error | string): void;
+export declare function memoizedWarn(input: Error | string): void;
 export default warn;

package/lib/errors/warn.js

@@ -3,23 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.warn = void 0;
+exports.memoizedWarn = exports.warn = void 0;
+const logger_1 = require("../logger");
 const write_1 = require("../ux/write");
-const config_1 = require("./config");
 const cli_1 = require("./errors/cli");
 const pretty_print_1 = __importDefault(require("./errors/pretty-print"));
-const WARNINGS = new Set();
 /**
  * Prints a pretty warning message to stderr.
  *
  * @param input The error or string to print.
- * @param options.ignoreDuplicates If true, will only print the same warning once.
  */
-function warn(input, options) {
-    const ignoreDuplicates = options?.ignoreDuplicates ?? true;
-    if (ignoreDuplicates && WARNINGS.has(input))
-        return;
-    WARNINGS.add(input);
+function warn(input) {
     let err;
     if (typeof input === 'string') {
         err = new cli_1.CLIError.Warn(input);
@@ -33,8 +27,15 @@ function warn(input, options) {
     const message = (0, pretty_print_1.default)(err);
     if (message)
         (0, write_1.stderr)(message);
-    if (config_1.config.errorLogger)
-        config_1.config.errorLogger.log(err?.stack ?? '');
+    if (err?.stack)
+        (0, logger_1.getLogger)().error(err.stack);
 }
 exports.warn = warn;
+const WARNINGS = new Set();
+function memoizedWarn(input) {
+    if (!WARNINGS.has(input))
+        warn(input);
+    WARNINGS.add(input);
+}
+exports.memoizedWarn = memoizedWarn;
 exports.default = warn;

package/lib/flags.d.ts

@@ -72,8 +72,8 @@ export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>):
  * - `max` option allows to set a maximum value.
  */
 export declare const integer: FlagDefinition<number, {
-    max?: number | undefined;
-    min?: number | undefined;
+    max?: number;
+    min?: number;
 }, {
     multiple: false;
     requiredOrDefaulted: false;
@@ -84,7 +84,7 @@ export declare const integer: FlagDefinition<number, {
  * - `exists` option allows you to throw an error if the directory does not exist.
  */
 export declare const directory: FlagDefinition<string, {
-    exists?: boolean | undefined;
+    exists?: boolean;
 }, {
     multiple: false;
     requiredOrDefaulted: false;
@@ -95,7 +95,7 @@ export declare const directory: FlagDefinition<string, {
  * - `exists` option allows you to throw an error if the file does not exist.
  */
 export declare const file: FlagDefinition<string, {
-    exists?: boolean | undefined;
+    exists?: boolean;
 }, {
     multiple: false;
     requiredOrDefaulted: false;

package/lib/flush.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flush = void 0;
-const errors_1 = require("./errors");
+const error_1 = require("./errors/error");
 function timeout(p, ms) {
     function wait(ms, unref = false) {
         return new Promise((resolve) => {
@@ -10,7 +10,7 @@ function timeout(p, ms) {
                 t.unref();
         });
     }
-    return Promise.race([p, wait(ms, true).then(() => (0, errors_1.error)('timed out'))]);
+    return Promise.race([p, wait(ms, true).then(() => (0, error_1.error)('timed out'))]);
 }
 async function _flush() {
     const p = new Promise((resolve) => {

package/lib/help/formatter.d.ts

@@ -59,9 +59,9 @@ export declare class HelpFormatter {
     indent(body: string, spacing?: number): string;
     renderList(input: (string | undefined)[][], opts: {
         indentation: number;
-        multiline?: boolean;
-        spacer?: string;
-        stripAnsi?: boolean;
+        multiline?: boolean | undefined;
+        spacer?: string | undefined;
+        stripAnsi?: boolean | undefined;
     }): string;
     section(header: string, body: [string, string | undefined][] | HelpSection | HelpSectionKeyValueTable | string): string;
     /**

package/lib/help/index.d.ts

@@ -3,6 +3,7 @@ import * as Interfaces from '../interfaces';
 import { CommandHelp } from './command';
 import { HelpFormatter } from './formatter';
 export { CommandHelp } from './command';
+export { HelpFormatter, type HelpSection, type HelpSectionKeyValueTable, type HelpSectionRenderer } from './formatter';
 export { getHelpFlagAdditions, normalizeArgv, standardizeIDFromArgv } from './util';
 export declare abstract class HelpBase extends HelpFormatter {
     constructor(config: Interfaces.Config, opts?: Partial<Interfaces.HelpOptions>);

package/lib/help/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadHelpClass = exports.Help = exports.HelpBase = exports.standardizeIDFromArgv = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.CommandHelp = void 0;
+exports.loadHelpClass = exports.Help = exports.HelpBase = exports.standardizeIDFromArgv = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.HelpFormatter = exports.CommandHelp = void 0;
 const ansis_1 = __importDefault(require("ansis"));
 const ts_path_1 = require("../config/ts-path");
 const error_1 = require("../errors/error");
@@ -12,7 +12,7 @@ const symbols_1 = require("../symbols");
 const cache_default_value_1 = require("../util/cache-default-value");
 const ids_1 = require("../util/ids");
 const util_1 = require("../util/util");
-const ux_1 = __importDefault(require("../ux"));
+const ux_1 = require("../ux");
 const theme_1 = require("../ux/theme");
 const command_1 = require("./command");
 const formatter_1 = require("./formatter");
@@ -20,6 +20,8 @@ const root_1 = __importDefault(require("./root"));
 const util_2 = require("./util");
 var command_2 = require("./command");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return command_2.CommandHelp; } });
+var formatter_2 = require("./formatter");
+Object.defineProperty(exports, "HelpFormatter", { enumerable: true, get: function () { return formatter_2.HelpFormatter; } });
 var util_3 = require("./util");
 Object.defineProperty(exports, "getHelpFlagAdditions", { enumerable: true, get: function () { return util_3.getHelpFlagAdditions; } });
 Object.defineProperty(exports, "normalizeArgv", { enumerable: true, get: function () { return util_3.normalizeArgv; } });
@@ -144,7 +146,7 @@ class Help extends HelpBase {
         return new this.CommandHelpClass(command, this.config, this.opts);
     }
     log(...args) {
-        this.opts.sendToStderr ? ux_1.default.stderr(args) : ux_1.default.stdout(args);
+        this.opts.sendToStderr ? ux_1.ux.stderr(args) : ux_1.ux.stdout(args);
     }
     async showCommandHelp(command) {
         const name = command.id;
@@ -314,17 +316,24 @@ exports.Help = Help;
 function extractClass(exported) {
     return exported && exported.default ? exported.default : exported;
 }
+function determineLocation(helpClass) {
+    if (typeof helpClass === 'string')
+        return { identifier: 'default', target: helpClass };
+    if (!helpClass.identifier)
+        return { ...helpClass, identifier: 'default' };
+    return helpClass;
+}
 async function loadHelpClass(config) {
-    const { pjson } = config;
-    const configuredClass = pjson.oclif?.helpClass;
-    if (configuredClass) {
+    if (config.pjson.oclif?.helpClass) {
+        const { identifier, target } = determineLocation(config.pjson.oclif?.helpClass);
         try {
-            const path = (await (0, ts_path_1.tsPath)(config.root, configuredClass)) ?? configuredClass;
-            const exported = await (0, module_loader_1.load)(config, path);
-            return extractClass(exported);
+            const path = (await (0, ts_path_1.tsPath)(config.root, target)) ?? target;
+            const module = await (0, module_loader_1.load)(config, path);
+            const helpClass = module[identifier] ?? (identifier === 'default' ? extractClass(module) : undefined);
+            return extractClass(helpClass);
         }
         catch (error) {
-            throw new Error(`Unable to load configured help class "${configuredClass}", failed with message:\n${error.message}`);
+            throw new Error(`Unable to load configured help class "${target}", failed with message:\n${error.message}`);
         }
     }
     return Help;

package/lib/index.d.ts

@@ -6,14 +6,14 @@ export { handle } from './errors/handle';
 export { execute } from './execute';
 export * as Flags from './flags';
 export { flush } from './flush';
-export { CommandHelp, Help, HelpBase, loadHelpClass } from './help';
-export { HelpSection, HelpSectionKeyValueTable, HelpSectionRenderer } from './help/formatter';
+export { CommandHelp, Help, HelpBase, type HelpSection, type HelpSectionKeyValueTable, type HelpSectionRenderer, loadHelpClass, } from './help';
 export * as Interfaces from './interfaces';
-export { Hook } from './interfaces/hooks';
+export { type Hook } from './interfaces/hooks';
+export { getLogger } from './logger';
 export { run } from './main';
 export * as ModuleLoader from './module-loader';
 export * as Parser from './parser';
 export { Performance } from './performance';
-export { Settings, settings } from './settings';
+export { type Settings, settings } from './settings';
 export { toConfiguredId, toStandardizedId } from './util/ids';
-export { methods as ux } from './ux';
+export { ux } from './ux';