@oclif/core 3.0.0-beta.2 → 3.0.0-beta.21

package/lib/help/index.js

@@ -1,21 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Help = exports.HelpBase = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.loadHelpClass = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
-const stripAnsi = require("strip-ansi");
-const util = require("util");
-const errors_1 = require("../errors");
-const command_1 = require("./command");
-const root_1 = require("./root");
-const util_1 = require("../util");
+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/util");
 const util_2 = require("./util");
+const command_1 = require("./command");
 const formatter_1 = require("./formatter");
-const config_1 = require("../config/config");
+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 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; } });
 function getHelpSubject(args, config) {
@@ -40,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
@@ -49,31 +51,30 @@ 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 = 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);
+        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);
         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, util_1.sortBy)(topics, (t) => t.name);
+        topics = (0, util_1.uniqBy)(topics, (t) => t.name);
         return topics;
     }
     constructor(config, opts = {}) {
         super(config, opts);
-        this.CommandHelpClass = command_1.default;
     }
     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_2.getHelpFlagAdditions)(this.config).includes(arg));
         if (this.config.topicSeparator !== ':')
             argv = (0, util_2.standardizeIDFromArgv)(argv, this.config);
         const subject = getHelpSubject(argv, this.config);
@@ -91,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(), undefined, false);
-                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);
@@ -109,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)
@@ -121,14 +128,19 @@ 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 plugin = this.config.plugins.find(p => p.name === command.pluginName);
+        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)}` :
-                `This command is in ${state}.\n`);
+            this.log(state === 'deprecated'
+                ? `${(0, util_2.formatCommandDeprecationWarning)((0, util_2.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_2.formatCommandDeprecationWarning)((0, util_2.toConfiguredId)(name, this.config), opts)}\n`);
         }
         const summary = this.summary(command);
         if (summary) {
@@ -142,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);
             });
@@ -155,31 +167,29 @@ 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('');
         }
     }
     async showTopicHelp(topic) {
-        const name = topic.name;
+        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`);
@@ -199,8 +209,8 @@ class Help extends HelpBase {
     }
     formatCommand(command) {
         if (this.config.topicSeparator !== ':') {
-            command.id = command.id.replace(/:/g, this.config.topicSeparator);
-            command.aliases = command.aliases && command.aliases.map(a => a.replace(/:/g, this.config.topicSeparator));
+            command.id = command.id.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();
@@ -211,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.replace(/:/g, this.config.topicSeparator);
-            return [
-                c.id,
-                this.summary(c),
-            ];
+                c.id = c.id.replaceAll(':', this.config.topicSeparator);
+            return [c.id, this.summary(c)];
         }), {
             spacer: '\n',
             stripAnsi: this.opts.stripAnsi,
@@ -243,26 +250,23 @@ class Help extends HelpBase {
         description = description.split('\n').slice(1).join('\n');
         let topicID = `${topic.name}:COMMAND`;
         if (this.config.topicSeparator !== ':')
-            topicID = topicID.replace(/:/g, this.config.topicSeparator);
+            topicID = topicID.replaceAll(':', this.config.topicSeparator);
         let output = (0, util_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.replace(/:/g, this.config.topicSeparator);
-            return [
-                c.name,
-                c.description && this.render(c.description.split('\n')[0]),
-            ];
+                c.name = c.name.replaceAll(':', this.config.topicSeparator);
+            return [c.name, c.description && this.render(c.description.split('\n')[0])];
         }), {
             spacer: '\n',
             stripAnsi: this.opts.stripAnsi,
@@ -274,7 +278,25 @@ class Help extends HelpBase {
         return this.formatCommand(command);
     }
     log(...args) {
-        stream_1.stdout.write(util.format.apply(this, args) + '\n');
+        stream_1.stdout.write(node_util_1.format.apply(this, args) + '\n');
     }
 }
 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 stripAnsi = require("strip-ansi");
-const util_1 = require("../util");
+const tslib_1 = require("tslib");
 const formatter_1 = require("./formatter");
+const util_1 = require("../util/util");
+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, util_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 { Config as IConfig, HelpOptions, Deprecation } 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 {};

package/lib/help/util.js

@@ -1,29 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeArgv = exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.toConfiguredId = exports.toStandardizedId = exports.template = exports.loadHelpClass = void 0;
-const ejs = require("ejs");
-const _1 = require(".");
-const module_loader_1 = require("../module-loader");
+exports.normalizeArgv = exports.formatCommandDeprecationWarning = exports.formatFlagDeprecationWarning = exports.getHelpFlagAdditions = exports.standardizeIDFromArgv = exports.toConfiguredId = exports.toStandardizedId = exports.template = void 0;
+const tslib_1 = require("tslib");
+const ejs = tslib_1.__importStar(require("ejs"));
 const util_1 = require("../config/util");
-function extractClass(exported) {
-    return exported && exported.default ? exported.default : exported;
-}
-async function loadHelpClass(config) {
-    const pjson = config.pjson;
-    const configuredClass = pjson && pjson.oclif && pjson.oclif.helpClass;
-    if (configuredClass) {
-        try {
-            const exported = await module_loader_1.default.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 _1.Help;
-}
-exports.loadHelpClass = loadHelpClass;
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 function template(context) {
     function render(t) {
         return ejs.render(t, context);
@@ -31,6 +11,8 @@ function template(context) {
     return render;
 }
 exports.template = template;
+const isFlag = (s) => s.startsWith('-');
+const isArgWithValue = (s) => s.includes('=');
 function collateSpacedCmdIDFromArgs(argv, config) {
     if (argv.length === 1)
         return argv;
@@ -38,9 +20,7 @@ function collateSpacedCmdIDFromArgs(argv, config) {
         const ids = (0, util_1.collectUsableIds)(config.commandIDs);
         const final = [];
         const idPresent = (id) => ids.has(id);
-        const isFlag = (s) => s.startsWith('-');
-        const isArgWithValue = (s) => s.includes('=');
-        const finalizeId = (s) => s ? [...final, s].join(':') : final.join(':');
+        const finalizeId = (s) => (s ? [...final, s].join(':') : final.join(':'));
         const hasArgs = () => {
             const id = finalizeId();
             if (!id)
@@ -68,12 +48,12 @@ function collateSpacedCmdIDFromArgs(argv, config) {
     return argv; // ID is argv[0]
 }
 function toStandardizedId(commandID, config) {
-    return commandID.replace(new RegExp(config.topicSeparator, 'g'), ':');
+    return commandID.replaceAll(new RegExp(config.topicSeparator, 'g'), ':');
 }
 exports.toStandardizedId = toStandardizedId;
 function toConfiguredId(commandID, config) {
     const defaultTopicSeparator = ':';
-    return commandID.replace(new RegExp(defaultTopicSeparator, 'g'), config.topicSeparator || defaultTopicSeparator);
+    return commandID.replaceAll(new RegExp(defaultTopicSeparator, 'g'), config.topicSeparator || defaultTopicSeparator);
 }
 exports.toConfiguredId = toConfiguredId;
 function standardizeIDFromArgv(argv, config) {

package/lib/index.d.ts

@@ -1,18 +1,19 @@
-import { Command } from './command';
-import { run, execute } from './main';
-import { Config, Plugin, tsPath, toCached } from './config';
-import * as Interfaces from './interfaces';
-import * as Errors from './errors';
-import * as Flags from './flags';
-import * as Args from './args';
-import { CommandHelp, HelpBase, Help, loadHelpClass } from './help';
-import { toStandardizedId, toConfiguredId } from './help/util';
-import * as Parser from './parser';
-import { Hook } from './interfaces/hooks';
-import { settings, Settings } from './settings';
-import { HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable } from './help/formatter';
-import * as ux from './cli-ux';
-import { stderr, stdout } from './cli-ux/stream';
-import { Performance } from './performance';
-declare const flush: typeof ux.ux.flush;
-export { Args, Command, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, Performance, run, toCached, tsPath, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, stderr, stdout, };
+export * as Args from './args';
+export * as Errors from './errors';
+export * as Interfaces from './interfaces';
+export * as Flags from './flags';
+export * as Parser from './parser';
+export * as ux from './cli-ux';
+export { CommandHelp, HelpBase, Help, loadHelpClass } from './help';
+export { Config, Plugin } from './config';
+export { HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable } from './help/formatter';
+export { Settings, settings } from './settings';
+export { stdout, stderr } from './cli-ux/stream';
+export { toConfiguredId, toStandardizedId } from './help/util';
+export { Command } from './command';
+export { Hook } from './interfaces/hooks';
+export { Performance } from './performance';
+export { execute } from './execute';
+export { flush } from './cli-ux/flush';
+export { handle } from './errors/handle';
+export { run } from './main';

package/lib/index.js

@@ -1,47 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = exports.run = exports.Performance = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Command = exports.Args = void 0;
-const semver = require("semver");
-const command_1 = require("./command");
-Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
-const main_1 = require("./main");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return main_1.run; } });
-Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return main_1.execute; } });
-const config_1 = require("./config");
-Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return config_1.Plugin; } });
-Object.defineProperty(exports, "tsPath", { enumerable: true, get: function () { return config_1.tsPath; } });
-Object.defineProperty(exports, "toCached", { enumerable: true, get: function () { return config_1.toCached; } });
-const Interfaces = require("./interfaces");
-exports.Interfaces = Interfaces;
-const Errors = require("./errors");
-exports.Errors = Errors;
-const Flags = require("./flags");
-exports.Flags = Flags;
-const Args = require("./args");
-exports.Args = Args;
-const help_1 = require("./help");
-Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return help_1.CommandHelp; } });
-Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
-Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
-Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
-const util_1 = require("./help/util");
-Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return util_1.toStandardizedId; } });
-Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return util_1.toConfiguredId; } });
-const Parser = require("./parser");
-exports.Parser = Parser;
-const settings_1 = require("./settings");
-Object.defineProperty(exports, "settings", { enumerable: true, get: function () { return settings_1.settings; } });
-const ux = require("./cli-ux");
-exports.ux = ux;
-const util_2 = require("./util");
+exports.run = exports.handle = exports.flush = exports.execute = exports.Performance = exports.Command = exports.toStandardizedId = exports.toConfiguredId = exports.stderr = exports.stdout = exports.settings = exports.Plugin = exports.Config = exports.loadHelpClass = exports.Help = exports.HelpBase = exports.CommandHelp = exports.ux = exports.Parser = exports.Flags = exports.Interfaces = exports.Errors = exports.Args = void 0;
+const tslib_1 = require("tslib");
 const stream_1 = require("./cli-ux/stream");
-Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_1.stderr; } });
-Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_1.stdout; } });
-const performance_1 = require("./performance");
-Object.defineProperty(exports, "Performance", { enumerable: true, get: function () { return performance_1.Performance; } });
-const flush = ux.flush;
-exports.flush = flush;
 function checkCWD() {
     try {
         process.cwd();
@@ -52,11 +13,38 @@ function checkCWD() {
         }
     }
 }
-function checkNodeVersion() {
-    const pjson = (0, util_2.requireJson)(__dirname, '..', 'package.json');
-    if (!semver.satisfies(process.versions.node, pjson.engines.node)) {
-        stream_1.stderr.write(`WARNING\nWARNING Node version must be ${pjson.engines.node} to use this CLI\nWARNING Current node version: ${process.versions.node}\nWARNING\n`);
-    }
-}
 checkCWD();
-checkNodeVersion();
+exports.Args = tslib_1.__importStar(require("./args"));
+exports.Errors = tslib_1.__importStar(require("./errors"));
+exports.Interfaces = tslib_1.__importStar(require("./interfaces"));
+exports.Flags = tslib_1.__importStar(require("./flags"));
+exports.Parser = tslib_1.__importStar(require("./parser"));
+exports.ux = tslib_1.__importStar(require("./cli-ux"));
+var help_1 = require("./help");
+Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return help_1.CommandHelp; } });
+Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
+Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
+Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
+Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return config_1.Plugin; } });
+var settings_1 = require("./settings");
+Object.defineProperty(exports, "settings", { enumerable: true, get: function () { return settings_1.settings; } });
+var stream_2 = require("./cli-ux/stream");
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_2.stdout; } });
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_2.stderr; } });
+var util_1 = require("./help/util");
+Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return util_1.toConfiguredId; } });
+Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return util_1.toStandardizedId; } });
+var command_1 = require("./command");
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
+var performance_1 = require("./performance");
+Object.defineProperty(exports, "Performance", { enumerable: true, get: function () { return performance_1.Performance; } });
+var execute_1 = require("./execute");
+Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return execute_1.execute; } });
+var flush_1 = require("./cli-ux/flush");
+Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return flush_1.flush; } });
+var handle_1 = require("./errors/handle");
+Object.defineProperty(exports, "handle", { enumerable: true, get: function () { return handle_1.handle; } });
+var main_1 = require("./main");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return main_1.run; } });

package/lib/interfaces/config.d.ts

@@ -1,10 +1,11 @@
+/// <reference types="node" />
+import { Hook, Hooks } from './hooks';
+import { Options, Plugin } from './plugin';
+import { Command } from '../command';
 import { PJSON } from './pjson';
-import { Hooks, Hook } from './hooks';
-import { Plugin, Options } from './plugin';
 import { Topic } from './topic';
-import { Command } from '../command';
 export type LoadOptions = Options | string | Config | undefined;
-export type PlatformTypes = 'darwin' | 'linux' | 'win32' | 'aix' | 'freebsd' | 'openbsd' | 'sunos' | 'wsl';
+export type PlatformTypes = NodeJS.Platform | 'wsl';
 export type ArchTypes = 'arm' | 'arm64' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64' | 'x86';
 export type PluginVersionDetail = {
     version: string;
@@ -21,91 +22,90 @@ export type VersionDetails = {
     rootPath?: string;
 };
 export interface Config {
-    name: string;
-    version: string;
-    channel: string;
-    pjson: PJSON.CLI;
-    root: string;
+    readonly name: string;
+    readonly version: string;
+    readonly channel: string;
+    readonly pjson: PJSON.CLI;
+    readonly root: string;
     /**
      * process.arch
      */
-    arch: ArchTypes;
+    readonly arch: ArchTypes;
     /**
      * bin name of CLI command
      */
-    bin: string;
+    readonly bin: string;
     /**
      * cache directory to use for CLI
      *
      * example ~/Library/Caches/mycli or ~/.cache/mycli
      */
-    cacheDir: string;
+    readonly cacheDir: string;
     /**
      * config directory to use for CLI
      *
      * example: ~/.config/mycli
      */
-    configDir: string;
+    readonly configDir: string;
     /**
      * data directory to use for CLI
      *
      * example: ~/.local/share/mycli
      */
-    dataDir: string;
+    readonly dataDir: string;
     /**
      * base dirname to use in cacheDir/configDir/dataDir
      */
-    dirname: string;
+    readonly dirname: string;
     /**
      * points to a file that should be appended to for error logs
      *
      * example: ~/Library/Caches/mycli/error.log
      */
-    errlog: string;
+    readonly errlog: string;
     /**
      * path to home directory
      *
      * example: /home/myuser
      */
-    home: string;
+    readonly home: string;
     /**
      * process.platform
      */
-    platform: PlatformTypes;
+    readonly platform: PlatformTypes;
     /**
      * active shell
      */
-    shell: string;
+    readonly shell: string;
     /**
      * user agent to use for http calls
      *
      * example: mycli/1.2.3 (darwin-x64) node-9.0.0
      */
-    userAgent: string;
+    readonly userAgent: string;
     /**
      * if windows
      */
-    windows: boolean;
+    readonly windows: boolean;
     /**
      * debugging level
      *
      * set by ${BIN}_DEBUG or DEBUG=$BIN
      */
-    debug: number;
+    readonly debug: number;
     /**
      * npm registry to use for installing plugins
      */
-    npmRegistry?: string;
-    userPJSON?: PJSON.User;
-    plugins: Plugin[];
-    binPath?: string;
+    readonly npmRegistry?: string;
+    readonly plugins: Map<string, Plugin>;
+    readonly binPath?: string;
     /**
      * name of any bin aliases that will execute the cli
      */
-    binAliases?: string[];
-    nsisCustomization?: string;
-    valid: boolean;
-    flexibleTaxonomy?: boolean;
+    readonly binAliases?: string[];
+    readonly nsisCustomization?: string;
+    readonly valid: boolean;
+    readonly flexibleTaxonomy?: boolean;
     topicSeparator: ':' | ' ';
     readonly commands: Command.Loadable[];
     readonly topics: Topic[];