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

package/lib/config/config.js

@@ -1,38 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toCached = exports.Config = void 0;
+exports.Config = void 0;
 const tslib_1 = require("tslib");
 const ejs = tslib_1.__importStar(require("ejs"));
 const errors_1 = require("../errors");
 const util_1 = require("./util");
 const node_url_1 = require("node:url");
 const node_os_1 = require("node:os");
-const util_2 = require("../util");
+const index_1 = require("../util/index");
 const node_path_1 = require("node:path");
 const performance_1 = require("../performance");
 const plugin_loader_1 = tslib_1.__importDefault(require("./plugin-loader"));
+const is_wsl_1 = tslib_1.__importDefault(require("is-wsl"));
 const node_util_1 = require("node:util");
-const help_1 = require("../help");
+const util_2 = require("../help/util");
 const module_loader_1 = require("../module-loader");
 const settings_1 = require("../settings");
 const stream_1 = require("../cli-ux/stream");
 // eslint-disable-next-line new-cap
 const debug = (0, util_1.Debug)();
-const _pjson = (0, util_2.requireJson)(__dirname, '..', '..', 'package.json');
+const _pjson = (0, index_1.requireJson)(__dirname, '..', '..', 'package.json');
 const BASE = `${_pjson.name}@${_pjson.version}`;
 function channelFromVersion(version) {
     const m = version.match(/[^-]+(?:-([^.]+))?/);
     return (m && m[1]) || 'stable';
 }
-const WSL = require('is-wsl');
 function isConfig(o) {
     return o && Boolean(o._base);
 }
 class Permutations extends Map {
-    constructor() {
-        super(...arguments);
-        this.validPermutations = new Map();
-    }
+    validPermutations = new Map();
     add(permutation, commandId) {
         this.validPermutations.set(permutation, commandId);
         for (const id of (0, util_1.collectUsableIds)([permutation])) {
@@ -58,17 +55,45 @@ class Permutations extends Map {
     }
 }
 class Config {
+    options;
+    _base = BASE;
+    arch;
+    bin;
+    binPath;
+    cacheDir;
+    channel;
+    configDir;
+    dataDir;
+    debug = 0;
+    dirname;
+    errlog;
+    flexibleTaxonomy;
+    home;
+    name;
+    npmRegistry;
+    pjson;
+    platform;
+    plugins = new Map();
+    root;
+    shell;
+    topicSeparator = ':';
+    userAgent;
+    userPJSON;
+    valid;
+    version;
+    windows;
+    binAliases;
+    nsisCustomization;
+    warned = false;
+    commandPermutations = new Permutations();
+    topicPermutations = new Permutations();
+    _commands = new Map();
+    _topics = new Map();
+    _commandIDs;
+    pluginLoader;
+    static _rootPlugin;
     constructor(options) {
         this.options = options;
-        this._base = BASE;
-        this.debug = 0;
-        this.plugins = new Map();
-        this.topicSeparator = ':';
-        this.warned = false;
-        this.commandPermutations = new Permutations();
-        this.topicPermutations = new Permutations();
-        this._commands = new Map();
-        this._topics = new Map();
     }
     static async load(opts = module.filename || __dirname) {
         // Handle the case when a file URL string is passed in such as 'import.meta.url'; covert to file path.
@@ -105,7 +130,8 @@ class Config {
     }
     // eslint-disable-next-line complexity
     async load() {
-        settings_1.settings.performanceEnabled = (settings_1.settings.performanceEnabled === undefined ? this.options.enablePerf : settings_1.settings.performanceEnabled) ?? false;
+        settings_1.settings.performanceEnabled =
+            (settings_1.settings.performanceEnabled === undefined ? this.options.enablePerf : settings_1.settings.performanceEnabled) ?? false;
         const marker = performance_1.Performance.mark('config.load');
         this.pluginLoader = new plugin_loader_1.default({ root: this.options.root, plugins: this.options.plugins });
         Config._rootPlugin = await this.pluginLoader.loadRoot();
@@ -118,8 +144,8 @@ class Config {
         this.version = this.options.version || this.pjson.version || '0.0.0';
         this.channel = this.options.channel || channelFromVersion(this.version);
         this.valid = Config._rootPlugin.valid;
-        this.arch = ((0, node_os_1.arch)() === 'ia32' ? 'x86' : (0, node_os_1.arch)());
-        this.platform = WSL ? 'wsl' : (0, util_2.getPlatform)();
+        this.arch = (0, node_os_1.arch)() === 'ia32' ? 'x86' : (0, node_os_1.arch)();
+        this.platform = is_wsl_1.default ? 'wsl' : (0, index_1.getPlatform)();
         this.windows = this.platform === 'win32';
         this.bin = this.pjson.oclif.bin || this.name;
         this.binAliases = this.pjson.oclif.binAliases;
@@ -134,7 +160,7 @@ class Config {
         this.userAgent = `${this.name}/${this.version} ${this.platform}-${this.arch} node-${process.version}`;
         this.shell = this._shell();
         this.debug = this._debug();
-        this.home = process.env.HOME || (this.windows && this.windowsHome()) || (0, util_2.getHomeDir)() || (0, node_os_1.tmpdir)();
+        this.home = process.env.HOME || (this.windows && this.windowsHome()) || (0, index_1.getHomeDir)() || (0, node_os_1.tmpdir)();
         this.cacheDir = this.scopedEnvVar('CACHE_DIR') || this.macosCacheDir() || this.dir('cache');
         this.configDir = this.scopedEnvVar('CONFIG_DIR') || this.dir('config');
         this.dataDir = this.scopedEnvVar('DATA_DIR') || this.dir('data');
@@ -155,14 +181,14 @@ class Config {
                 unversioned: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %><%- bin %>-<%- platform %>-<%- arch %><%- ext %>",
                 versioned: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %><%- bin %>-v<%- version %>/<%- bin %>-v<%- version %>-<%- platform %>-<%- arch %><%- ext %>",
                 manifest: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %><%- platform %>-<%- arch %>",
-                ...s3.templates && s3.templates.target,
+                ...(s3.templates && s3.templates.target),
             },
             vanilla: {
                 unversioned: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %><%- bin %><%- ext %>",
                 versioned: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %><%- bin %>-v<%- version %>/<%- bin %>-v<%- version %><%- ext %>",
                 baseDir: '<%- bin %>',
                 manifest: "<%- channel === 'stable' ? '' : 'channels/' + channel + '/' %>version",
-                ...s3.templates && s3.templates.vanilla,
+                ...(s3.templates && s3.templates.vanilla),
             },
         };
         await this.loadPluginsAndCommands();
@@ -213,7 +239,7 @@ class Config {
                     reject(new Error(`Timed out after ${ms} ms.`));
                 }, ms).unref();
             });
-            return Promise.race([promise, timeout]).then(result => {
+            return Promise.race([promise, timeout]).then((result) => {
                 clearTimeout(id);
                 return result;
             });
@@ -325,10 +351,10 @@ class Config {
         return result;
     }
     scopedEnvVar(k) {
-        return process.env[this.scopedEnvVarKeys(k).find(k => process.env[k])];
+        return process.env[this.scopedEnvVarKeys(k).find((k) => process.env[k])];
     }
     scopedEnvVarTrue(k) {
-        const v = process.env[this.scopedEnvVarKeys(k).find(k => process.env[k])];
+        const v = process.env[this.scopedEnvVarKeys(k).find((k) => process.env[k])];
         return v === '1' || v === 'true';
     }
     /**
@@ -338,7 +364,7 @@ class Config {
      */
     scopedEnvVarKey(k) {
         return [this.bin, k]
-            .map(p => p.replaceAll('@', '').replaceAll(/[/-]/g, '_'))
+            .map((p) => p.replaceAll('@', '').replaceAll(/[/-]/g, '_'))
             .join('_')
             .toUpperCase();
     }
@@ -348,7 +374,9 @@ class Config {
      * @returns {string[]} e.g. ['SF_DEBUG', 'SFDX_DEBUG']
      */
     scopedEnvVarKeys(k) {
-        return [this.bin, ...this.binAliases ?? []].filter(Boolean).map(alias => [alias.replaceAll('@', '').replaceAll(/[/-]/g, '_'), k].join('_').toUpperCase());
+        return [this.bin, ...(this.binAliases ?? [])]
+            .filter(Boolean)
+            .map((alias) => [alias.replaceAll('@', '').replaceAll(/[/-]/g, '_'), k].join('_').toUpperCase());
     }
     findCommand(id, opts = {}) {
         const lookupId = this.getCmdLookupId(id);
@@ -379,12 +407,14 @@ class Config {
      * @returns string[]
      */
     findMatches(partialCmdId, argv) {
-        const flags = argv.filter(arg => !(0, help_1.getHelpFlagAdditions)(this).includes(arg) && arg.startsWith('-')).map(a => a.replaceAll('-', ''));
-        const possibleMatches = [...this.commandPermutations.get(partialCmdId)].map(k => this._commands.get(k));
-        const matches = possibleMatches.filter(command => {
+        const flags = argv
+            .filter((arg) => !(0, util_2.getHelpFlagAdditions)(this).includes(arg) && arg.startsWith('-'))
+            .map((a) => a.replaceAll('-', ''));
+        const possibleMatches = [...this.commandPermutations.get(partialCmdId)].map((k) => this._commands.get(k));
+        const matches = possibleMatches.filter((command) => {
             const cmdFlags = Object.entries(command.flags).flatMap(([flag, def]) => def.char ? [def.char, flag] : [flag]);
             // A command is a match if the provided flags belong to the full command
-            return flags.every(f => cmdFlags.includes(f));
+            return flags.every((f) => cmdFlags.includes(f));
         });
         return matches;
     }
@@ -408,7 +438,7 @@ class Config {
      * @returns string[]
      */
     getAllCommandIDs() {
-        return this.getAllCommands().map(c => c.id);
+        return this.getAllCommands().map((c) => c.id);
     }
     get commands() {
         return [...this._commands.values()];
@@ -416,7 +446,7 @@ class Config {
     get commandIDs() {
         if (this._commandIDs)
             return this._commandIDs;
-        this._commandIDs = this.commands.map(c => c.id);
+        this._commandIDs = this.commands.map((c) => c.id);
         return this._commandIDs;
     }
     get topics() {
@@ -428,7 +458,7 @@ class Config {
             cliVersion,
             architecture,
             nodeVersion,
-            pluginVersions: Object.fromEntries([...this.plugins.values()].map(p => [p.name, { version: p.version, type: p.type, root: p.root }])),
+            pluginVersions: Object.fromEntries([...this.plugins.values()].map((p) => [p.name, { version: p.version, type: p.type, root: p.root }])),
             osVersion: `${(0, node_os_1.type)()} ${(0, node_os_1.release)()}`,
             shell: this.shell,
             rootPath: this.root,
@@ -454,16 +484,16 @@ class Config {
         return [...this.plugins.values()];
     }
     dir(category) {
-        const base = process.env[`XDG_${category.toUpperCase()}_HOME`]
-            || (this.windows && process.env.LOCALAPPDATA)
-            || (0, node_path_1.join)(this.home, category === 'data' ? '.local/share' : '.' + category);
+        const base = process.env[`XDG_${category.toUpperCase()}_HOME`] ||
+            (this.windows && process.env.LOCALAPPDATA) ||
+            (0, node_path_1.join)(this.home, category === 'data' ? '.local/share' : '.' + category);
         return (0, node_path_1.join)(base, this.dirname);
     }
     windowsHome() {
         return this.windowsHomedriveHome() || this.windowsUserprofileHome();
     }
     windowsHomedriveHome() {
-        return (process.env.HOMEDRIVE && process.env.HOMEPATH && (0, node_path_1.join)(process.env.HOMEDRIVE, process.env.HOMEPATH));
+        return process.env.HOMEDRIVE && process.env.HOMEPATH && (0, node_path_1.join)(process.env.HOMEDRIVE, process.env.HOMEPATH);
     }
     windowsUserprofileHome() {
         return process.env.USERPROFILE;
@@ -507,7 +537,7 @@ class Config {
         if (err instanceof Error) {
             const modifiedErr = err;
             modifiedErr.name = `${err.name} Plugin: ${this.name}`;
-            modifiedErr.detail = (0, util_2.compact)([
+            modifiedErr.detail = (0, index_1.compact)([
                 err.detail,
                 `module: ${this._base}`,
                 scope && `task: ${scope}`,
@@ -521,7 +551,7 @@ class Config {
         // err is an object
         process.emitWarning('Config.warn expected either a string or Error, but instead received an object');
         err.name = `${err.name} Plugin: ${this.name}`;
-        err.detail = (0, util_2.compact)([
+        err.detail = (0, index_1.compact)([
             err.detail,
             `module: ${this._base}`,
             scope && `task: ${scope}`,
@@ -532,11 +562,12 @@ class Config {
         process.emitWarning(JSON.stringify(err));
     }
     get isProd() {
-        return (0, util_2.isProd)();
+        return (0, index_1.isProd)();
     }
     isJitPluginCommand(c) {
         // Return true if the command's plugin is listed under oclif.jitPlugins AND if the plugin hasn't been loaded to this.plugins
-        return Object.keys(this.pjson.oclif.jitPlugins ?? {}).includes(c.pluginName ?? '') && Boolean(c?.pluginName && !this.plugins.has(c.pluginName));
+        return (Object.keys(this.pjson.oclif.jitPlugins ?? {}).includes(c.pluginName ?? '') &&
+            Boolean(c?.pluginName && !this.plugins.has(c.pluginName)));
     }
     getCmdLookupId(id) {
         if (this._commands.has(id))
@@ -598,7 +629,7 @@ class Config {
     }
     loadTopics(plugin) {
         const marker = performance_1.Performance.mark(`config.loadTopics#${plugin.name}`, { plugin: plugin.name });
-        for (const topic of (0, util_2.compact)(plugin.topics)) {
+        for (const topic of (0, index_1.compact)(plugin.topics)) {
             const existing = this._topics.get(topic.name);
             if (existing) {
                 existing.description = topic.description || existing.description;
@@ -613,7 +644,7 @@ class Config {
             }
         }
         // Add missing topics for displaying help when partial commands are entered.
-        for (const c of plugin.commands.filter(c => !c.hidden)) {
+        for (const c of plugin.commands.filter((c) => !c.hidden)) {
             const parts = c.id.split(':');
             while (parts.length > 0) {
                 const name = parts.join(':');
@@ -678,14 +709,14 @@ class Config {
         return commandPlugins[0];
     }
     /**
-      * Insert legacy plugins
-      *
-      * Replace invalid CLI plugins (cli-engine plugins, mostly Heroku) loaded via `this.loadPlugins`
-      * with oclif-compatible ones returned by @oclif/plugin-legacy init hook.
-      *
-      * @param plugins array of oclif-compatible plugins
-      * @returns void
-      */
+     * Insert legacy plugins
+     *
+     * Replace invalid CLI plugins (cli-engine plugins, mostly Heroku) loaded via `this.loadPlugins`
+     * with oclif-compatible ones returned by @oclif/plugin-legacy init hook.
+     *
+     * @param plugins array of oclif-compatible plugins
+     * @returns void
+     */
     insertLegacyPlugins(plugins) {
         for (const plugin of plugins) {
             this.plugins.set(plugin.name, plugin);
@@ -694,148 +725,3 @@ class Config {
     }
 }
 exports.Config = Config;
-// when no manifest exists, the default is calculated.  This may throw, so we need to catch it
-const defaultFlagToCached = async (flag, respectNoCacheDefault) => {
-    if (respectNoCacheDefault && flag.noCacheDefault)
-        return;
-    // Prefer the defaultHelp function (returns a friendly string for complex types)
-    if (typeof flag.defaultHelp === 'function') {
-        try {
-            return await flag.defaultHelp({ options: flag, flags: {} });
-        }
-        catch {
-            return;
-        }
-    }
-    // if not specified, try the default function
-    if (typeof flag.default === 'function') {
-        try {
-            return await flag.default({ options: flag, flags: {} });
-        }
-        catch { }
-    }
-    else {
-        return flag.default;
-    }
-};
-const defaultArgToCached = async (arg, respectNoCacheDefault) => {
-    if (respectNoCacheDefault && arg.noCacheDefault)
-        return;
-    // Prefer the defaultHelp function (returns a friendly string for complex types)
-    if (typeof arg.defaultHelp === 'function') {
-        try {
-            return await arg.defaultHelp({ options: arg, flags: {} });
-        }
-        catch {
-            return;
-        }
-    }
-    // if not specified, try the default function
-    if (typeof arg.default === 'function') {
-        try {
-            return await arg.default({ options: arg, flags: {} });
-        }
-        catch { }
-    }
-    else {
-        return arg.default;
-    }
-};
-async function toCached(c, plugin, respectNoCacheDefault = false) {
-    const flags = {};
-    for (const [name, flag] of Object.entries(c.flags || {})) {
-        if (flag.type === 'boolean') {
-            flags[name] = {
-                name,
-                type: flag.type,
-                char: flag.char,
-                summary: flag.summary,
-                description: flag.description,
-                hidden: flag.hidden,
-                required: flag.required,
-                helpLabel: flag.helpLabel,
-                helpGroup: flag.helpGroup,
-                allowNo: flag.allowNo,
-                dependsOn: flag.dependsOn,
-                relationships: flag.relationships,
-                exclusive: flag.exclusive,
-                deprecated: flag.deprecated,
-                deprecateAliases: c.deprecateAliases,
-                aliases: flag.aliases,
-                charAliases: flag.charAliases,
-                delimiter: flag.delimiter,
-                noCacheDefault: flag.noCacheDefault,
-            };
-        }
-        else {
-            flags[name] = {
-                name,
-                type: flag.type,
-                char: flag.char,
-                summary: flag.summary,
-                description: flag.description,
-                hidden: flag.hidden,
-                required: flag.required,
-                helpLabel: flag.helpLabel,
-                helpValue: flag.helpValue,
-                helpGroup: flag.helpGroup,
-                multiple: flag.multiple,
-                options: flag.options,
-                dependsOn: flag.dependsOn,
-                relationships: flag.relationships,
-                exclusive: flag.exclusive,
-                default: await defaultFlagToCached(flag, respectNoCacheDefault),
-                deprecated: flag.deprecated,
-                deprecateAliases: c.deprecateAliases,
-                aliases: flag.aliases,
-                charAliases: flag.charAliases,
-                delimiter: flag.delimiter,
-                noCacheDefault: flag.noCacheDefault,
-            };
-            // a command-level placeholder in the manifest so that oclif knows it should regenerate the command during help-time
-            if (typeof flag.defaultHelp === 'function') {
-                c.hasDynamicHelp = true;
-            }
-        }
-    }
-    const args = {};
-    for (const [name, arg] of Object.entries((0, util_2.ensureArgObject)(c.args))) {
-        args[name] = {
-            name,
-            description: arg.description,
-            required: arg.required,
-            options: arg.options,
-            default: await defaultArgToCached(arg, respectNoCacheDefault),
-            hidden: arg.hidden,
-            noCacheDefault: arg.noCacheDefault,
-        };
-    }
-    const stdProperties = {
-        id: c.id,
-        summary: c.summary,
-        description: c.description,
-        strict: c.strict,
-        usage: c.usage,
-        pluginName: plugin && plugin.name,
-        pluginAlias: plugin && plugin.alias,
-        pluginType: plugin && plugin.type,
-        hidden: c.hidden,
-        state: c.state,
-        aliases: c.aliases || [],
-        examples: c.examples || c.example,
-        deprecationOptions: c.deprecationOptions,
-        deprecateAliases: c.deprecateAliases,
-        flags,
-        args,
-    };
-    // do not include these properties in manifest
-    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags', '_baseFlags'];
-    const stdKeys = Object.keys(stdProperties);
-    const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property));
-    const additionalProperties = {};
-    for (const key of keysToAdd) {
-        additionalProperties[key] = c[key];
-    }
-    return { ...stdProperties, ...additionalProperties };
-}
-exports.toCached = toCached;

package/lib/config/index.d.ts

@@ -1,4 +1,3 @@
 export { Config } from './config';
-export { toCached } from './config';
 export { Plugin } from './plugin';
 export { tsPath } from './ts-node';

package/lib/config/index.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tsPath = exports.Plugin = exports.toCached = exports.Config = void 0;
+exports.tsPath = exports.Plugin = exports.Config = void 0;
 var config_1 = require("./config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-var config_2 = require("./config");
-Object.defineProperty(exports, "toCached", { enumerable: true, get: function () { return config_2.toCached; } });
 var plugin_1 = require("./plugin");
 Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return plugin_1.Plugin; } });
 var ts_node_1 = require("./ts-node");

package/lib/config/plugin-loader.js

@@ -2,32 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const Plugin = tslib_1.__importStar(require("./plugin"));
-const util_1 = require("../util");
-const util_2 = require("./util");
+const index_1 = require("../util/index");
+const util_1 = require("./util");
 const performance_1 = require("../performance");
 const node_path_1 = require("node:path");
 // eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)();
+const debug = (0, util_1.Debug)();
 class PluginLoader {
+    options;
+    plugins = new Map();
+    errors = [];
+    pluginsProvided = false;
     constructor(options) {
         this.options = options;
-        this.plugins = new Map();
-        this.errors = [];
-        this.pluginsProvided = false;
         if (options.plugins) {
             this.pluginsProvided = true;
-            this.plugins = Array.isArray(options.plugins) ? new Map(options.plugins.map(p => [p.name, p])) : options.plugins;
+            this.plugins = Array.isArray(options.plugins) ? new Map(options.plugins.map((p) => [p.name, p])) : options.plugins;
         }
     }
     async loadRoot() {
         let rootPlugin;
         if (this.pluginsProvided) {
             const plugins = [...this.plugins.values()];
-            rootPlugin = plugins.find(p => p.root === this.options.root) ?? plugins[0];
+            rootPlugin = plugins.find((p) => p.root === this.options.root) ?? plugins[0];
         }
         else {
             const marker = performance_1.Performance.mark('plugin.load#root');
-            rootPlugin = new Plugin.Plugin({ root: this.options.root });
+            rootPlugin = new Plugin.Plugin({ root: this.options.root, isRoot: true });
             await rootPlugin.load();
             marker?.addDetails({
                 hasManifest: rootPlugin.hasManifest ?? false,
@@ -58,7 +59,7 @@ class PluginLoader {
     async loadDevPlugins(opts) {
         if (opts.devPlugins !== false) {
             // do not load oclif.devPlugins in production
-            if ((0, util_1.isProd)())
+            if ((0, index_1.isProd)())
                 return;
             try {
                 const { devPlugins } = opts.rootPlugin.pjson.oclif;
@@ -75,7 +76,7 @@ class PluginLoader {
             try {
                 const userPJSONPath = (0, node_path_1.join)(opts.dataDir, 'package.json');
                 debug('reading user plugins pjson %s', userPJSONPath);
-                const pjson = await (0, util_1.readJson)(userPJSONPath);
+                const pjson = await (0, index_1.readJson)(userPJSONPath);
                 if (!pjson.oclif)
                     pjson.oclif = { schema: 1 };
                 if (!pjson.oclif.plugins)

package/lib/config/plugin.d.ts

@@ -24,6 +24,7 @@ export declare class Plugin implements IPlugin {
     parent: Plugin | undefined;
     children: Plugin[];
     hasManifest: boolean;
+    isRoot: boolean;
     private _commandsDir;
     private flexibleTaxonomy;
     protected _debug: (..._: any) => void;