@oclif/core 3.0.9 → 3.2.0

package/lib/command.d.ts

@@ -49,6 +49,8 @@ export declare abstract class Command {
     static help: string | undefined;
     /** Hide the command from help */
     static hidden: boolean;
+    /** An array of aliases for this command that are hidden from help. */
+    static hiddenAliases: string[];
     /** A command ID, used mostly in error or verbose reporting. */
     static id: string;
     static plugin: Plugin | undefined;
@@ -155,6 +157,7 @@ export declare namespace Command {
         };
         hasDynamicHelp?: boolean;
         hidden: boolean;
+        hiddenAliases: string[];
         id: string;
         isESM?: boolean;
         permutations?: string[];

package/lib/command.js

@@ -94,6 +94,8 @@ class Command {
     static help;
     /** Hide the command from help */
     static hidden;
+    /** An array of aliases for this command that are hidden from help. */
+    static hiddenAliases = [];
     /** A command ID, used mostly in error or verbose reporting. */
     static id;
     static plugin;

package/lib/config/cache.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from '../interfaces';
+type CacheContents = {
+    rootPlugin: Plugin;
+};
+type ValueOf<T> = T[keyof T];
+/**
+ * A simple cache for storing values that need to be accessed globally.
+ */
+export default class Cache extends Map<keyof CacheContents, ValueOf<CacheContents>> {
+    static instance: Cache;
+    static getInstance(): Cache;
+    get(key: 'rootPlugin'): Plugin | undefined;
+}
+export {};

package/lib/config/cache.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A simple cache for storing values that need to be accessed globally.
+ */
+class Cache extends Map {
+    static instance;
+    static getInstance() {
+        if (!Cache.instance) {
+            Cache.instance = new Cache();
+        }
+        return Cache.instance;
+    }
+    get(key) {
+        return super.get(key);
+    }
+}
+exports.default = Cache;

package/lib/config/config.d.ts

@@ -35,10 +35,10 @@ export declare class Config implements IConfig {
     private _base;
     private _commandIDs;
     private _commands;
-    private static _rootPlugin;
     private _topics;
     private commandPermutations;
     private pluginLoader;
+    private rootPlugin;
     private topicPermutations;
     constructor(options: Options);
     static load(opts?: LoadOptions): Promise<Config>;

package/lib/config/config.js

@@ -42,6 +42,7 @@ const settings_1 = require("../settings");
 const fs_1 = require("../util/fs");
 const os_1 = require("../util/os");
 const util_2 = require("../util/util");
+const cache_1 = __importDefault(require("./cache"));
 const plugin_loader_1 = __importDefault(require("./plugin-loader"));
 const util_3 = require("./util");
 // eslint-disable-next-line new-cap
@@ -114,10 +115,10 @@ class Config {
     _base = BASE;
     _commandIDs;
     _commands = new Map();
-    static _rootPlugin;
     _topics = new Map();
     commandPermutations = new Permutations();
     pluginLoader;
+    rootPlugin;
     topicPermutations = new Permutations();
     constructor(options) {
         this.options = options;
@@ -153,7 +154,7 @@ class Config {
         return config;
     }
     static get rootPlugin() {
-        return Config._rootPlugin;
+        return this.rootPlugin;
     }
     get commandIDs() {
         if (this._commandIDs)
@@ -259,16 +260,19 @@ class Config {
             (settings_1.settings.performanceEnabled === undefined ? this.options.enablePerf : settings_1.settings.performanceEnabled) ?? false;
         const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, 'config.load');
         this.pluginLoader = new plugin_loader_1.default({ plugins: this.options.plugins, root: this.options.root });
-        Config._rootPlugin = await this.pluginLoader.loadRoot();
-        this.root = Config._rootPlugin.root;
-        this.pjson = Config._rootPlugin.pjson;
-        this.plugins.set(Config._rootPlugin.name, Config._rootPlugin);
-        this.root = Config._rootPlugin.root;
-        this.pjson = Config._rootPlugin.pjson;
+        this.rootPlugin = await this.pluginLoader.loadRoot();
+        // Cache the root plugin so that we can reference it later when determining if
+        // we should skip ts-node registration for an ESM plugin.
+        cache_1.default.getInstance().set('rootPlugin', this.rootPlugin);
+        this.root = this.rootPlugin.root;
+        this.pjson = this.rootPlugin.pjson;
+        this.plugins.set(this.rootPlugin.name, this.rootPlugin);
+        this.root = this.rootPlugin.root;
+        this.pjson = this.rootPlugin.pjson;
         this.name = this.pjson.name;
         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.valid = this.rootPlugin.valid;
         this.arch = (0, node_os_1.arch)() === 'ia32' ? 'x86' : (0, node_os_1.arch)();
         this.platform = is_wsl_1.default ? 'wsl' : (0, os_1.getPlatform)();
         this.windows = this.platform === 'win32';
@@ -332,7 +336,7 @@ class Config {
             dataDir: this.dataDir,
             devPlugins: this.options.devPlugins,
             force: opts?.force ?? false,
-            rootPlugin: Config._rootPlugin,
+            rootPlugin: this.rootPlugin,
             userPlugins: this.options.userPlugins,
         });
         this.plugins = plugins;
@@ -704,14 +708,13 @@ class Config {
             for (const permutation of permutations) {
                 this.commandPermutations.add(permutation, command.id);
             }
-            // set command aliases
-            for (const alias of command.aliases ?? []) {
+            const handleAlias = (alias, hidden = false) => {
                 if (this._commands.has(alias)) {
                     const prioritizedCommand = this.determinePriority([this._commands.get(alias), command]);
                     this._commands.set(alias, { ...prioritizedCommand, id: alias });
                 }
                 else {
-                    this._commands.set(alias, { ...command, id: alias });
+                    this._commands.set(alias, { ...command, hidden, id: alias });
                 }
                 // set every permutation of the aliases
                 // v3 moved command alias permutations to the manifest, but some plugins may not have
@@ -723,6 +726,14 @@ class Config {
                 for (const permutation of aliasPermutations) {
                     this.commandPermutations.add(permutation, command.id);
                 }
+            };
+            // set command aliases
+            for (const alias of command.aliases ?? []) {
+                handleAlias(alias);
+            }
+            // set hidden command aliases
+            for (const alias of command.hiddenAliases ?? []) {
+                handleAlias(alias, true);
             }
         }
         marker?.addDetails({ commandCount: plugin.commands.length });

package/lib/config/plugin.js

@@ -140,7 +140,10 @@ class Plugin {
             return [];
         const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, `plugin.commandIDs#${this.name}`, { plugin: this.name });
         this._debug(`loading IDs from ${this.commandsDir}`);
-        const patterns = ['**/*.+(js|cjs|mjs|ts|tsx)', '!**/*.+(d.ts|test.ts|test.js|spec.ts|spec.js)?(x)'];
+        const patterns = [
+            '**/*.+(js|cjs|mjs|ts|tsx|mts|cts)',
+            '!**/*.+(d.ts|test.ts|test.js|spec.ts|spec.js|d.mts|d.cts)?(x)',
+        ];
         const ids = (0, globby_1.sync)(patterns, { cwd: this.commandsDir }).map((file) => {
             const p = (0, node_path_1.parse)(file);
             const topics = p.dir.split('/');

package/lib/config/ts-node.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tsPath = exports.TS_CONFIGS = void 0;
 const node_fs_1 = require("node:fs");
@@ -7,16 +10,12 @@ const errors_1 = require("../errors");
 const settings_1 = require("../settings");
 const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
+const cache_1 = __importDefault(require("./cache"));
 const util_2 = require("./util");
 // eslint-disable-next-line new-cap
 const debug = (0, util_2.Debug)('ts-node');
 exports.TS_CONFIGS = {};
 const REGISTERED = new Set();
-/**
- * Cache the root plugin so that we can reference it later when determining if
- * we should skip ts-node registration for an ESM plugin.
- */
-let ROOT_PLUGIN;
 function loadTSConfig(root) {
     if (exports.TS_CONFIGS[root])
         return exports.TS_CONFIGS[root];
@@ -101,6 +100,7 @@ function registerTSNode(root) {
     };
     tsNode.register(conf);
     REGISTERED.add(root);
+    debug('%O', tsconfig);
     return tsconfig;
 }
 /**
@@ -115,8 +115,8 @@ function registerTSNode(root) {
  * We still register ts-node for ESM plugins when NODE_ENV is "test" or "development" and root plugin is also ESM
  * since that allows plugins to be auto-transpiled when developing locally using `bin/dev.js`.
  */
-function cannotTranspileEsm(root, plugin, isProduction) {
-    return (isProduction || ROOT_PLUGIN?.moduleType === 'commonjs') && plugin?.moduleType === 'module';
+function cannotTranspileEsm(rootPlugin, plugin, isProduction) {
+    return (isProduction || rootPlugin?.moduleType === 'commonjs') && plugin?.moduleType === 'module';
 }
 /**
  * If the dev script is run with ts-node for an ESM plugin, skip ts-node registration
@@ -141,10 +141,17 @@ function determinePath(root, orig) {
     const tsconfig = registerTSNode(root);
     if (!tsconfig)
         return orig;
-    const { outDir, rootDir, rootDirs } = tsconfig.compilerOptions;
-    const rootDirPath = rootDir || (rootDirs || [])[0];
-    if (!rootDirPath || !outDir)
+    debug(`determining path for ${orig}`);
+    const { baseUrl, outDir, rootDir, rootDirs } = tsconfig.compilerOptions;
+    const rootDirPath = rootDir ?? (rootDirs ?? [])[0] ?? baseUrl;
+    if (!rootDirPath) {
+        debug(`no rootDir, rootDirs, or baseUrl specified in tsconfig.json. Returning default path ${orig}`);
+        return orig;
+    }
+    if (!outDir) {
+        debug(`no outDir specified in tsconfig.json. Returning default path ${orig}`);
         return orig;
+    }
     // rewrite path from ./lib/foo to ./src/foo
     const lib = (0, node_path_1.join)(root, outDir); // ./lib
     const src = (0, node_path_1.join)(root, rootDirPath); // ./src
@@ -156,13 +163,20 @@ function determinePath(root, orig) {
     // For hooks, it might point to a module, not a file. Something like "./hooks/myhook"
     // That file doesn't exist, and the real file is "./hooks/myhook.ts"
     // In that case we attempt to resolve to the filename. If it fails it will revert back to the lib path
-    if ((0, node_fs_1.existsSync)(out) || (0, node_fs_1.existsSync)(out + '.ts'))
+    debug(`lib dir: ${lib}`);
+    debug(`src dir: ${src}`);
+    debug(`src commands dir: ${out}`);
+    if ((0, node_fs_1.existsSync)(out) || (0, node_fs_1.existsSync)(out + '.ts')) {
+        debug(`Found source file for ${orig} at ${out}`);
         return out;
+    }
+    debug(`No source file found. Returning default path ${orig}`);
+    if (!(0, util_1.isProd)())
+        (0, errors_1.memoizedWarn)(`Could not find source for ${orig} based on tsconfig. Defaulting to compiled source.`);
     return orig;
 }
 function tsPath(root, orig, plugin) {
-    if (plugin?.isRoot)
-        ROOT_PLUGIN = plugin;
+    const rootPlugin = cache_1.default.getInstance().get('rootPlugin');
     if (!orig)
         return orig;
     orig = orig.startsWith(root) ? orig : (0, node_path_1.join)(root, orig);
@@ -172,8 +186,8 @@ function tsPath(root, orig, plugin) {
         return orig;
     }
     const isProduction = (0, util_1.isProd)();
-    if (cannotTranspileEsm(root, plugin, isProduction)) {
-        debug(`Skipping ts-node registration for ${root} because it's an ESM module (NODE_ENV: ${process.env.NODE_ENV}, root plugin module type: ${ROOT_PLUGIN?.moduleType})))`);
+    if (cannotTranspileEsm(rootPlugin, plugin, isProduction)) {
+        debug(`Skipping ts-node registration 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, errors_1.memoizedWarn)(`${plugin?.name} is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used instead.`);
         return orig;

package/lib/flags.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.option = exports.help = exports.version = exports.string = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = exports.custom = void 0;
-/* eslint-disable valid-jsdoc */
 const node_url_1 = require("node:url");
 const errors_1 = require("./errors");
 const help_1 = require("./help");
@@ -98,7 +97,7 @@ const help = (opts = {}) => boolean({
     ...opts,
     async parse(_, cmd) {
         const Help = await (0, help_1.loadHelpClass)(cmd.config);
-        await new Help(cmd.config, cmd.config.pjson.helpOptions).showHelp(cmd.id ? [cmd.id, ...cmd.argv] : cmd.argv);
+        await new Help(cmd.config, cmd.config.pjson.oclif.helpOptions ?? cmd.config.pjson.helpOptions).showHelp(cmd.id ? [cmd.id, ...cmd.argv] : cmd.argv);
         cmd.exit(0);
     },
 });

package/lib/help/index.js

@@ -82,7 +82,9 @@ class Help extends HelpBase {
     formatCommands(commands) {
         if (commands.length === 0)
             return '';
-        const body = this.renderList(commands.map((c) => {
+        const body = this.renderList(commands
+            .filter((c) => (this.opts.hideAliasesFromRoot ? !c.aliases?.includes(c.id) : true))
+            .map((c) => {
             if (this.config.topicSeparator !== ':')
                 c.id = c.id.replaceAll(':', this.config.topicSeparator);
             return [c.id, this.summary(c)];

package/lib/interfaces/help.d.ts

@@ -4,6 +4,10 @@ export interface HelpOptions {
      * Use docopts as the usage. Defaults to true.
      */
     docopts?: boolean;
+    /**
+     * If true, hide command aliases from the root help output. Defaults to false.
+     */
+    hideAliasesFromRoot?: boolean;
     /**
      * By default, the command summary is show at the top of the help and as the first line in
      * the command description. Repeating the summary in the command description improves readability

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

@@ -1,5 +1,6 @@
 export interface TSConfig {
     compilerOptions: {
+        baseUrl?: string;
         emitDecoratorMetadata?: boolean;
         esModuleInterop?: boolean;
         experimentalDecorators?: boolean;

package/lib/main.js

@@ -64,7 +64,7 @@ async function run(argv, options) {
     // display help version if applicable
     if ((0, exports.helpAddition)(argv, config)) {
         const Help = await (0, help_1.loadHelpClass)(config);
-        const help = new Help(config, config.pjson.helpOptions);
+        const help = new Help(config, config.pjson.oclif.helpOptions ?? config.pjson.helpOptions);
         await help.showHelp(argv);
         await collectPerf();
         return;

package/lib/module-loader.js

@@ -11,7 +11,7 @@ const getPackageType = require('get-package-type');
  * Defines file extension resolution when source files do not have an extension.
  */
 // eslint-disable-next-line camelcase
-const s_EXTENSIONS = ['.ts', '.js', '.mjs', '.cjs'];
+const s_EXTENSIONS = ['.ts', '.js', '.mjs', '.cjs', '.mts', '.cts'];
 const isPlugin = (config) => config.type !== undefined;
 /**
  * Loads and returns a module.

package/lib/util/cache-command.js

@@ -72,18 +72,22 @@ async function cacheCommand(uncachedCmd, plugin, respectNoCacheDefault = false)
     const uncachedFlags = cmd.flags ?? cmd._flags;
     // @ts-expect-error because v2 commands have base flags stored in _baseFlags
     const uncachedBaseFlags = cmd.baseFlags ?? cmd._baseFlags;
-    const flags = await cacheFlags((0, aggregate_flags_1.aggregateFlags)(uncachedFlags, uncachedBaseFlags, cmd.enableJsonFlag), respectNoCacheDefault);
-    const args = await cacheArgs((0, ensure_arg_object_1.ensureArgObject)(cmd.args), respectNoCacheDefault);
+    const [flags, args] = await Promise.all([
+        await cacheFlags((0, aggregate_flags_1.aggregateFlags)(uncachedFlags, uncachedBaseFlags, cmd.enableJsonFlag), respectNoCacheDefault),
+        await cacheArgs((0, ensure_arg_object_1.ensureArgObject)(cmd.args), respectNoCacheDefault),
+    ]);
     const stdProperties = {
-        aliases: cmd.aliases || [],
+        aliases: cmd.aliases ?? [],
         args,
         deprecateAliases: cmd.deprecateAliases,
         deprecationOptions: cmd.deprecationOptions,
         description: cmd.description,
-        examples: cmd.examples || cmd.example,
+        // Support both `examples` and `example` for backwards compatibility.
+        examples: cmd.examples ?? cmd.example,
         flags,
         hasDynamicHelp: Object.values(flags).some((f) => f.hasDynamicHelp),
         hidden: cmd.hidden,
+        hiddenAliases: cmd.hiddenAliases ?? [],
         id: cmd.id,
         pluginAlias: plugin && plugin.alias,
         pluginName: plugin && plugin.name,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.0.9",
+  "version": "3.2.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -12,7 +12,7 @@
     "clean-stack": "^3.0.1",
     "cli-progress": "^3.12.0",
     "debug": "^4.3.4",
-    "ejs": "^3.1.8",
+    "ejs": "^3.1.9",
     "get-package-type": "^0.1.0",
     "globby": "^11.1.0",
     "hyperlinker": "^1.0.0",
@@ -39,11 +39,11 @@
     "@oclif/test": "^3.0.1",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.2",
-    "@types/chai": "^4.3.4",
+    "@types/chai": "^4.3.8",
     "@types/chai-as-promised": "^7.1.5",
     "@types/clean-stack": "^2.1.1",
     "@types/cli-progress": "^3.11.0",
-    "@types/ejs": "^3.1.2",
+    "@types/ejs": "^3.1.3",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
     "@types/mocha": "^10.0.2",
@@ -55,7 +55,7 @@
     "@types/wordwrap": "^1.0.1",
     "@types/wrap-ansi": "^3.0.0",
     "benchmark": "^2.1.4",
-    "chai": "^4.3.7",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "commitlint": "^17.7.2",
     "cross-env": "^7.0.3",