@oclif/core 3.19.2-qa.0 → 3.19.3-dev.0

package/lib/cache.d.ts

@@ -2,15 +2,23 @@ import { PJSON, Plugin } from './interfaces';
 type CacheContents = {
     rootPlugin: Plugin;
     exitCodes: PJSON.Plugin['oclif']['exitCodes'];
+    '@oclif/core': OclifCoreInfo;
 };
 type ValueOf<T> = T[keyof T];
+type OclifCoreInfo = {
+    name: string;
+    version: string;
+};
 /**
  * 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;
+    constructor();
     static getInstance(): Cache;
+    get(key: '@oclif/core'): OclifCoreInfo;
     get(key: 'rootPlugin'): Plugin | undefined;
     get(key: 'exitCodes'): PJSON.Plugin['oclif']['exitCodes'] | undefined;
+    private getOclifCoreMeta;
 }
 export {};

package/lib/cache.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 /**
  * A simple cache for storing values that need to be accessed globally.
  */
 class Cache extends Map {
     static instance;
+    constructor() {
+        super();
+        this.set('@oclif/core', this.getOclifCoreMeta());
+    }
     static getInstance() {
         if (!Cache.instance) {
             Cache.instance = new Cache();
@@ -14,5 +20,22 @@ class Cache extends Map {
     get(key) {
         return super.get(key);
     }
+    getOclifCoreMeta() {
+        try {
+            // eslint-disable-next-line node/no-extraneous-require
+            return { name: '@oclif/core', version: require('@oclif/core/package.json').version };
+        }
+        catch {
+            try {
+                return {
+                    name: '@oclif/core',
+                    version: JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, '..', 'package.json'), 'utf8')),
+                };
+            }
+            catch {
+                return { name: '@oclif/core', version: 'unknown' };
+            }
+        }
+    }
 }
 exports.default = Cache;

package/lib/cli-ux/config.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = exports.Config = void 0;
-const fs_1 = require("../util/fs");
+const cache_1 = __importDefault(require("../cache"));
 const simple_1 = __importDefault(require("./action/simple"));
 const spinner_1 = __importDefault(require("./action/spinner"));
 const g = global;
@@ -35,7 +35,8 @@ class Config {
 }
 exports.Config = Config;
 function fetch() {
-    const major = (0, fs_1.requireJson)(__dirname, '..', '..', 'package.json').version.split('.')[0];
+    const core = cache_1.default.getInstance().get('@oclif/core');
+    const major = core?.version.split('.')[0] || 'unknown';
     if (globals[major])
         return globals[major];
     globals[major] = new Config();

package/lib/cli-ux/prompt.js

@@ -28,28 +28,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.anykey = exports.confirm = exports.prompt = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const node_readline_1 = __importDefault(require("node:readline"));
 const Errors = __importStar(require("../errors"));
 const config_1 = require("./config");
 function normal(options, retries = 100) {
     if (retries < 0)
         throw new Error('no input');
+    const ac = new AbortController();
+    const { signal } = ac;
     return new Promise((resolve, reject) => {
-        let timer;
-        if (options.timeout) {
-            timer = setTimeout(() => {
-                process.stdin.pause();
-                reject(new Error('Prompt timeout'));
-            }, options.timeout);
-            timer.unref();
-        }
-        process.stdin.setEncoding('utf8');
-        process.stderr.write(options.prompt);
-        process.stdin.resume();
-        process.stdin.once('data', (b) => {
-            if (timer)
-                clearTimeout(timer);
-            process.stdin.pause();
-            const data = (typeof b === 'string' ? b : b.toString()).trim();
+        const rl = node_readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        rl.question(options.prompt, { signal }, (answer) => {
+            rl.close();
+            const data = answer.trim();
             if (!options.default && options.required && data === '') {
                 resolve(normal(options, retries - 1));
             }
@@ -57,6 +51,12 @@ function normal(options, retries = 100) {
                 resolve(data || options.default);
             }
         });
+        if (options.timeout) {
+            signal.addEventListener('abort', () => {
+                reject(new Error('Prompt timeout'));
+            }, { once: true });
+            setTimeout(() => ac.abort(), options.timeout);
+        }
     });
 }
 function getPrompt(name, type, defaultValue) {

package/lib/command.js

@@ -30,16 +30,16 @@ exports.Command = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const node_url_1 = require("node:url");
 const node_util_1 = require("node:util");
+const cache_1 = __importDefault(require("./cache"));
 const cli_ux_1 = require("./cli-ux");
 const config_1 = require("./config");
 const Errors = __importStar(require("./errors"));
 const util_1 = require("./help/util");
 const Parser = __importStar(require("./parser"));
 const aggregate_flags_1 = require("./util/aggregate-flags");
-const fs_1 = require("./util/fs");
 const ids_1 = require("./util/ids");
 const util_2 = require("./util/util");
-const pjson = (0, fs_1.requireJson)(__dirname, '..', 'package.json');
+const pjson = cache_1.default.getInstance().get('@oclif/core');
 /**
  * swallows stdout epipe errors
  * this occurs when stdout closes such as when piping to head

package/lib/config/config.js

@@ -48,7 +48,7 @@ const ts_node_1 = require("./ts-node");
 const util_3 = require("./util");
 // eslint-disable-next-line new-cap
 const debug = (0, util_3.Debug)();
-const _pjson = (0, fs_1.requireJson)(__dirname, '..', '..', 'package.json');
+const _pjson = cache_1.default.getInstance().get('@oclif/core');
 const BASE = `${_pjson.name}@${_pjson.version}`;
 function channelFromVersion(version) {
     const m = version.match(/[^-]+(?:-([^.]+))?/);
@@ -487,14 +487,15 @@ class Config {
             };
             const hooks = p.hooks[event] || [];
             for (const hook of hooks) {
-                const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, `config.runHook#${p.name}(${hook})`);
+                const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, `config.runHook#${p.name}(${hook.target})`);
                 try {
                     /* eslint-disable no-await-in-loop */
-                    const { filePath, isESM, module } = await (0, module_loader_1.loadWithData)(p, await (0, ts_node_1.tsPath)(p.root, hook, p));
+                    const { filePath, isESM, module } = await (0, module_loader_1.loadWithData)(p, await (0, ts_node_1.tsPath)(p.root, hook.target, p));
                     debug('start', isESM ? '(import)' : '(require)', filePath);
+                    const hookFn = module[hook.identifier] ?? search(module);
                     const result = timeout
-                        ? await withTimeout(timeout, search(module).call(context, { ...opts, config: this, context }))
-                        : await search(module).call(context, { ...opts, config: this, context });
+                        ? await withTimeout(timeout, hookFn.call(context, { ...opts, config: this, context }))
+                        : await hookFn.call(context, { ...opts, config: this, context });
                     final.successes.push({ plugin: p, result });
                     if (p.name === '@oclif/plugin-legacy' && event === 'init') {
                         this.insertLegacyPlugins(result);
@@ -516,7 +517,7 @@ class Config {
                 }
                 marker?.addDetails({
                     event,
-                    hook,
+                    hook: hook.target,
                     plugin: p.name,
                 });
                 marker?.stop();

package/lib/config/plugin.d.ts

@@ -1,6 +1,6 @@
 import { Command } from '../command';
 import { Manifest } from '../interfaces/manifest';
-import { PJSON } from '../interfaces/pjson';
+import { HookOptions, PJSON } from '../interfaces/pjson';
 import { Plugin as IPlugin, PluginOptions } from '../interfaces/plugin';
 import { Topic } from '../interfaces/topic';
 export declare class Plugin implements IPlugin {
@@ -13,7 +13,7 @@ export declare class Plugin implements IPlugin {
     commandsDir: string | undefined;
     hasManifest: boolean;
     hooks: {
-        [k: string]: string[];
+        [key: string]: HookOptions[];
     };
     isRoot: boolean;
     manifest: Manifest;

package/lib/config/plugin.js

@@ -7,6 +7,7 @@ exports.Plugin = void 0;
 const globby_1 = __importDefault(require("globby"));
 const node_path_1 = require("node:path");
 const node_util_1 = require("node:util");
+const cache_1 = __importDefault(require("../cache"));
 const errors_1 = require("../errors");
 const module_loader_1 = require("../module-loader");
 const performance_1 = require("../performance");
@@ -17,7 +18,7 @@ const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
 const ts_node_1 = require("./ts-node");
 const util_2 = require("./util");
-const _pjson = (0, fs_1.requireJson)(__dirname, '..', '..', 'package.json');
+const _pjson = cache_1.default.getInstance().get('@oclif/core');
 function topicsToArray(input, base) {
     if (!input)
         return [];
@@ -64,8 +65,18 @@ function determineCommandDiscoveryOptions(commandDiscovery, defaultCmdId) {
         throw new errors_1.CLIError('`oclif.commandDiscovery.target` is required.');
     if (!commandDiscovery.strategy)
         throw new errors_1.CLIError('`oclif.commandDiscovery.strategy` is required.');
+    if (commandDiscovery.strategy === 'explicit' && !commandDiscovery.identifier) {
+        commandDiscovery.identifier = 'default';
+    }
     return commandDiscovery;
 }
+function determineHookOptions(hook) {
+    if (typeof hook === 'string')
+        return { identifier: 'default', target: hook };
+    if (!hook.identifier)
+        return { ...hook, identifier: 'default' };
+    return hook;
+}
 class Plugin {
     options;
     alias;
@@ -182,7 +193,10 @@ class Plugin {
         else {
             this.pjson.oclif = this.pjson['cli-engine'] || {};
         }
-        this.hooks = Object.fromEntries(Object.entries(this.pjson.oclif.hooks ?? {}).map(([k, v]) => [k, (0, util_1.castArray)(v)]));
+        this.hooks = Object.fromEntries(Object.entries(this.pjson.oclif.hooks ?? {}).map(([k, v]) => [
+            k,
+            (0, util_1.castArray)(v).map((v) => determineHookOptions(v)),
+        ]));
         this.commandDiscoveryOpts = determineCommandDiscoveryOptions(this.pjson.oclif?.commands, this.pjson.oclif?.default);
         this._debug('command discovery options', this.commandDiscoveryOpts);
         this.manifest = await this._manifest();
@@ -333,7 +347,7 @@ class Plugin {
         if (this.commandDiscoveryOpts?.strategy === 'explicit' && this.commandDiscoveryOpts.target) {
             const filePath = await (0, ts_node_1.tsPath)(this.root, this.commandDiscoveryOpts.target, this);
             const module = await (0, module_loader_1.load)(this, filePath);
-            this.commandCache = module.default ?? {};
+            this.commandCache = module[this.commandDiscoveryOpts?.identifier ?? 'default'] ?? {};
             return this.commandCache;
         }
         if (this.commandDiscoveryOpts?.strategy === 'single' && this.commandDiscoveryOpts.target) {

package/lib/execute.d.ts

@@ -8,23 +8,17 @@ import { LoadOptions } from './interfaces';
  * @example For ESM dev.js
  * ```
  * #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({development: true, dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({development: true, dir: import.meta.url})
  * ```
  *
  * @example For ESM run.js
  * ```
  * #!/usr/bin/env node
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({dir: import.meta.url})
  * ```
  *
  * @example For CJS dev.js

package/lib/execute.js

@@ -14,23 +14,17 @@ const settings_1 = require("./settings");
  * @example For ESM dev.js
  * ```
  * #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({development: true, dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({development: true, dir: import.meta.url})
  * ```
  *
  * @example For ESM run.js
  * ```
  * #!/usr/bin/env node
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({dir: import.meta.url})
  * ```
  *
  * @example For CJS dev.js

package/lib/interfaces/pjson.d.ts

@@ -20,9 +20,9 @@ export type CommandDiscovery = {
     /**
      * The strategy to use for loading commands.
      *
-     * - `pattern` will use glob patterns to find command files in the specified `directory`.
+     * - `pattern` will use glob patterns to find command files in the specified `target`.
      * - `explicit` will use `import` (or `require` for CJS) to load the commands from the
-     *    specified `file`.
+     *    specified `target`.
      * - `single` will use the `target` which should export a command class. This is for CLIs that
      *    only have a single command.
      *
@@ -32,9 +32,9 @@ export type CommandDiscovery = {
     /**
      * If the `strategy` is `pattern`, this is the **directory** to use to find command files.
      *
-     * If the `strategy` is `explicit`, this is the **file** that default exports the commands.
-     *   - This export must be the default export and an object with keys that are the command names
-     *     and values that are the command classes.
+     * If the `strategy` is `explicit`, this is the **file** that exports the commands.
+     *   - This export must be an object with keys that are the command names and values that are the command classes.
+     *   - Unless `identifier` is specified, the default export will be used.
      *
      * @example
      * ```typescript
@@ -54,6 +54,45 @@ export type CommandDiscovery = {
      * This is only used when `strategy` is `pattern`.
      */
     globPatterns?: string[];
+    /**
+     * The name of the export to used when loading the command object from the `target` file. Only
+     * used when `strategy` is `explicit`. Defaults to `default`.
+     *
+     * @example
+     * ```typescript
+     * // in src/commands.ts
+     * import Hello from './commands/hello/index.js'
+     * import HelloWorld from './commands/hello/world.js'
+     *
+     * export const MY_COMMANDS = {
+     *  hello: Hello,
+     * 'hello:world': HelloWorld,
+     * }
+     * ```
+     *
+     * In the package.json:
+     * ```json
+     * {
+     *  "oclif": {
+     *   "commands": {
+     *     "strategy": "explicit",
+     *     "target": "./dist/index.js",
+     *     "identifier": "MY_COMMANDS"
+     *    }
+     * }
+     * ```
+     */
+    identifier?: string;
+};
+export type HookOptions = {
+    /**
+     * The file path containing hook.
+     */
+    target: string;
+    /**
+     * The name of the export to use when loading the hook function from the `target` file. Defaults to `default`.
+     */
+    identifier: string;
 };
 export declare namespace PJSON {
     interface Plugin extends PJSON {
@@ -87,7 +126,7 @@ export declare namespace PJSON {
             helpClass?: string;
             helpOptions?: HelpOptions;
             hooks?: {
-                [name: string]: string | string[];
+                [name: string]: string | string[] | HookOptions | HookOptions[];
             };
             jitPlugins?: Record<string, string>;
             macos?: {

package/lib/interfaces/plugin.d.ts

@@ -1,5 +1,5 @@
 import { Command } from '../command';
-import { PJSON } from './pjson';
+import { HookOptions, PJSON } from './pjson';
 import { Topic } from './topic';
 export interface PluginOptions {
     children?: Plugin[];
@@ -44,7 +44,7 @@ export interface Plugin {
     }): Promise<Command.Class> | undefined;
     readonly hasManifest: boolean;
     hooks: {
-        [k: string]: string[];
+        [key: string]: HookOptions[];
     };
     /**
      * True if the plugin is the root plugin.

package/lib/util/fs.d.ts

@@ -1,4 +1,3 @@
-export declare function requireJson<T>(...pathParts: string[]): T;
 /**
  * Parser for Args.directory and Flags.directory. Checks that the provided path
  * exists and is a directory.

package/lib/util/fs.js

@@ -1,13 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.existsSync = exports.safeReadJson = exports.readJsonSync = exports.readJson = exports.fileExists = exports.dirExists = exports.requireJson = void 0;
+exports.existsSync = exports.safeReadJson = exports.readJsonSync = exports.readJson = exports.fileExists = exports.dirExists = void 0;
 const node_fs_1 = require("node:fs");
 const promises_1 = require("node:fs/promises");
-const node_path_1 = require("node:path");
-function requireJson(...pathParts) {
-    return JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(...pathParts), 'utf8'));
-}
-exports.requireJson = requireJson;
 /**
  * Parser for Args.directory and Flags.directory. Checks that the provided path
  * exists and is a directory.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.19.2-qa.0",
+  "version": "3.19.3-dev.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -38,7 +38,7 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^4",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.1.12",
+    "@oclif/test": "^3.1.14",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.11",
@@ -72,9 +72,9 @@
     "husky": "^8",
     "lint-staged": "^14.0.1",
     "madge": "^6.1.0",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.2",