@oclif/core 3.3.3 → 3.4.1-dev.0

package/lib/cli-ux/action/base.js

@@ -3,14 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionBase = void 0;
 const node_util_1 = require("node:util");
 const util_1 = require("../../util/util");
-const stream_1 = require("../stream");
 class ActionBase {
     std = 'stderr';
     stdmocks;
     type;
     stdmockOrigs = {
-        stderr: stream_1.stderr.write,
-        stdout: stream_1.stdout.write,
+        stderr: process.stderr.write,
+        stdout: process.stdout.write,
     };
     get output() {
         return this.globals.output;
@@ -125,15 +124,15 @@ class ActionBase {
                 if (this.stdmocks)
                     return;
                 this.stdmockOrigs = {
-                    stderr: stream_1.stderr.write,
-                    stdout: stream_1.stdout.write,
+                    stderr: process.stderr.write,
+                    stdout: process.stdout.write,
                 };
                 this.stdmocks = [];
-                stream_1.stdout.write = (...args) => {
+                process.stdout.write = (...args) => {
                     this.stdmocks.push(['stdout', args]);
                     return true;
                 };
-                stream_1.stderr.write = (...args) => {
+                process.stderr.write = (...args) => {
                     this.stdmocks.push(['stderr', args]);
                     return true;
                 };
@@ -143,8 +142,8 @@ class ActionBase {
                     return;
                 // this._write('stderr', '\nresetstdmock\n\n\n')
                 delete this.stdmocks;
-                stream_1.stdout.write = this.stdmockOrigs.stdout;
-                stream_1.stderr.write = this.stdmockOrigs.stderr;
+                process.stdout.write = this.stdmockOrigs.stdout;
+                process.stderr.write = this.stdmockOrigs.stderr;
             }
         }
         catch (error) {
@@ -161,11 +160,11 @@ class ActionBase {
     _write(std, s) {
         switch (std) {
             case 'stdout': {
-                this.stdmockOrigs.stdout.apply(stream_1.stdout, (0, util_1.castArray)(s));
+                this.stdmockOrigs.stdout.apply(process.stdout, (0, util_1.castArray)(s));
                 break;
             }
             case 'stderr': {
-                this.stdmockOrigs.stderr.apply(stream_1.stderr, (0, util_1.castArray)(s));
+                this.stdmockOrigs.stderr.apply(process.stderr, (0, util_1.castArray)(s));
                 break;
             }
             default: {

package/lib/cli-ux/flush.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flush = void 0;
 const errors_1 = require("../errors");
-const stream_1 = require("./stream");
 function timeout(p, ms) {
     function wait(ms, unref = false) {
         return new Promise((resolve) => {
@@ -15,9 +14,9 @@ function timeout(p, ms) {
 }
 async function _flush() {
     const p = new Promise((resolve) => {
-        stream_1.stdout.once('drain', () => resolve(null));
+        process.stdout.once('drain', () => resolve(null));
     });
-    const flushed = stream_1.stdout.write('');
+    const flushed = process.stdout.write('');
     if (flushed)
         return;
     return p;

package/lib/cli-ux/index.d.ts

@@ -1,11 +1,10 @@
 import * as Errors from '../errors';
 import { ActionBase } from './action/base';
-import { Config } from './config';
 import * as uxPrompt from './prompt';
 import * as styled from './styled';
 import uxWait from './wait';
 export declare class ux {
-    static config: Config;
+    static config: import("./config").Config;
     static get action(): ActionBase;
     static annotation(text: string, annotation: string): void;
     /**
@@ -18,6 +17,7 @@ export declare class ux {
     static flush(ms?: number): Promise<void>;
     static info(format: string, ...args: string[]): void;
     static log(format?: string, ...args: string[]): void;
+    static logToStderr(format?: string, ...args: string[]): void;
     static get progress(): typeof styled.progress;
     static get prompt(): typeof uxPrompt.prompt;
     static styledHeader(header: string): void;
@@ -29,11 +29,12 @@ export declare class ux {
     static url(text: string, uri: string, params?: {}): void;
     static get wait(): typeof uxWait;
 }
-declare const action: ActionBase, annotation: typeof ux.annotation, anykey: typeof uxPrompt.anykey, confirm: typeof uxPrompt.confirm, debug: typeof ux.debug, done: typeof ux.done, flush: typeof ux.flush, info: typeof ux.info, log: typeof ux.log, progress: typeof styled.progress, prompt: typeof uxPrompt.prompt, styledHeader: typeof ux.styledHeader, styledJSON: typeof ux.styledJSON, styledObject: typeof ux.styledObject, table: typeof styled.Table.table, trace: typeof ux.trace, tree: typeof styled.tree, url: typeof ux.url, wait: (ms?: number) => Promise<void>;
+declare const action: ActionBase, annotation: typeof ux.annotation, anykey: typeof uxPrompt.anykey, confirm: typeof uxPrompt.confirm, debug: typeof ux.debug, done: typeof ux.done, flush: typeof ux.flush, info: typeof ux.info, log: typeof ux.log, logToStderr: typeof ux.logToStderr, progress: typeof styled.progress, prompt: typeof uxPrompt.prompt, styledHeader: typeof ux.styledHeader, styledJSON: typeof ux.styledJSON, styledObject: typeof ux.styledObject, table: typeof styled.Table.table, trace: typeof ux.trace, tree: typeof styled.tree, url: typeof ux.url, wait: (ms?: number) => Promise<void>;
 declare const error: typeof Errors.error, exit: typeof Errors.exit, warn: typeof Errors.warn;
-export { action, annotation, anykey, confirm, debug, done, error, exit, flush, info, log, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, warn, };
+export { action, annotation, anykey, confirm, debug, done, error, exit, flush, info, log, logToStderr, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, warn, };
 export { ActionBase } from './action/base';
 export { Config, config } from './config';
 export { ExitError } from './exit';
 export { IPromptOptions } from './prompt';
+export { makeStubs } from './stub';
 export { Table } from './styled';

package/lib/cli-ux/index.js

@@ -26,16 +26,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = exports.ExitError = exports.config = exports.Config = exports.ActionBase = exports.warn = exports.wait = exports.url = exports.tree = exports.trace = exports.table = exports.styledObject = exports.styledJSON = exports.styledHeader = exports.prompt = exports.progress = exports.log = exports.info = exports.flush = exports.exit = exports.error = exports.done = exports.debug = exports.confirm = exports.anykey = exports.annotation = exports.action = exports.ux = void 0;
+exports.Table = exports.makeStubs = exports.ExitError = exports.config = exports.Config = exports.ActionBase = exports.warn = exports.wait = exports.url = exports.tree = exports.trace = exports.table = exports.styledObject = exports.styledJSON = exports.styledHeader = exports.prompt = exports.progress = exports.logToStderr = exports.log = exports.info = exports.flush = exports.exit = exports.error = exports.done = exports.debug = exports.confirm = exports.anykey = exports.annotation = exports.action = exports.ux = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const node_util_1 = require("node:util");
 const Errors = __importStar(require("../errors"));
 const config_1 = require("./config");
 const flush_1 = require("./flush");
 const uxPrompt = __importStar(require("./prompt"));
-const stream_1 = require("./stream");
 const styled = __importStar(require("./styled"));
 const wait_1 = __importDefault(require("./wait"));
+const write_1 = __importDefault(require("./write"));
 const hyperlinker = require('hyperlinker');
 class ux {
     static config = config_1.config;
@@ -63,7 +63,7 @@ class ux {
     }
     static debug(format, ...args) {
         if (['debug', 'trace'].includes(this.config.outputLevel)) {
-            stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
+            this.info((0, node_util_1.format)(format, ...args) + '\n');
         }
     }
     static async done() {
@@ -73,11 +73,14 @@ class ux {
         await (0, flush_1.flush)(ms);
     }
     static info(format, ...args) {
-        stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
+        write_1.default.stdout((0, node_util_1.format)(format, ...args) + '\n');
     }
     static log(format, ...args) {
         this.info(format || '', ...args);
     }
+    static logToStderr(format, ...args) {
+        write_1.default.stderr((0, node_util_1.format)(format, ...args) + '\n');
+    }
     static get progress() {
         return styled.progress;
     }
@@ -90,7 +93,7 @@ class ux {
     static styledJSON(obj) {
         const json = JSON.stringify(obj, null, 2);
         if (!chalk_1.default.level) {
-            info(json);
+            this.info(json);
             return;
         }
         const cardinal = require('cardinal');
@@ -105,7 +108,7 @@ class ux {
     }
     static trace(format, ...args) {
         if (this.config.outputLevel === 'trace') {
-            stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
+            this.info((0, node_util_1.format)(format, ...args) + '\n');
         }
     }
     static get tree() {
@@ -125,7 +128,7 @@ class ux {
     }
 }
 exports.ux = ux;
-const { action, annotation, anykey, confirm, debug, done, flush, info, log, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, } = ux;
+const { action, annotation, anykey, confirm, debug, done, flush, info, log, logToStderr, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, } = ux;
 exports.action = action;
 exports.annotation = annotation;
 exports.anykey = anykey;
@@ -135,6 +138,7 @@ exports.done = done;
 exports.flush = flush;
 exports.info = info;
 exports.log = log;
+exports.logToStderr = logToStderr;
 exports.progress = progress;
 exports.prompt = prompt;
 exports.styledHeader = styledHeader;
@@ -171,5 +175,7 @@ Object.defineProperty(exports, "Config", { enumerable: true, get: function () {
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_2.config; } });
 var exit_1 = require("./exit");
 Object.defineProperty(exports, "ExitError", { enumerable: true, get: function () { return exit_1.ExitError; } });
+var stub_1 = require("./stub");
+Object.defineProperty(exports, "makeStubs", { enumerable: true, get: function () { return stub_1.makeStubs; } });
 var styled_1 = require("./styled");
 Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return styled_1.Table; } });

package/lib/cli-ux/prompt.js

@@ -30,7 +30,6 @@ exports.anykey = exports.confirm = exports.prompt = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const Errors = __importStar(require("../errors"));
 const config_1 = require("./config");
-const stream_1 = require("./stream");
 function normal(options, retries = 100) {
     if (retries < 0)
         throw new Error('no input');
@@ -44,7 +43,7 @@ function normal(options, retries = 100) {
             timer.unref();
         }
         process.stdin.setEncoding('utf8');
-        stream_1.stderr.write(options.prompt);
+        process.stderr.write(options.prompt);
         process.stdin.resume();
         process.stdin.once('data', (b) => {
             if (timer)
@@ -83,7 +82,7 @@ async function single(options) {
 }
 function replacePrompt(prompt) {
     const ansiEscapes = require('ansi-escapes');
-    stream_1.stderr.write(ansiEscapes.cursorHide +
+    process.stderr.write(ansiEscapes.cursorHide +
         ansiEscapes.cursorUp(1) +
         ansiEscapes.cursorLeft +
         prompt +
@@ -176,7 +175,7 @@ async function anykey(message) {
     }
     const char = await prompt(message, { required: false, type: 'single' });
     if (tty)
-        stream_1.stderr.write('\n');
+        process.stderr.write('\n');
     if (char === 'q')
         Errors.error('quit');
     if (char === '\u0003')

package/lib/cli-ux/stream.d.ts

@@ -12,6 +12,12 @@ declare class Stream {
     read(): boolean;
     write(data: string): boolean;
 }
+/**
+ * @deprecated Use process.stdout directly. This will be removed in the next major version
+ */
 export declare const stdout: Stream;
+/**
+ * @deprecated Use process.stderr directly. This will be removed in the next major version
+ */
 export declare const stderr: Stream;
 export {};

package/lib/cli-ux/stream.js

@@ -33,5 +33,11 @@ class Stream {
         return process[this.channel].write(data);
     }
 }
+/**
+ * @deprecated Use process.stdout directly. This will be removed in the next major version
+ */
 exports.stdout = new Stream('stdout');
+/**
+ * @deprecated Use process.stderr directly. This will be removed in the next major version
+ */
 exports.stderr = new Stream('stderr');

package/lib/cli-ux/stub.d.ts

@@ -0,0 +1,32 @@
+import type { SinonSandbox, SinonStub } from 'sinon';
+type Stubs = {
+    stderr: SinonStub;
+    stdout: SinonStub;
+};
+/**
+ * Create sinon stubs for writing to stdout and stderr.
+ *
+ * @example
+ * import {ux} from '@oclif/core'
+ *
+ * describe('example', () => {
+ *   let sandbox: SinonSandbox
+ *   let stubs: ReturnType<typeof ux.makeStubs>
+ *
+ *   beforeEach(() => {
+ *     sandbox = createSandbox()
+ *     stubs = ux.makeStubs(sandbox)
+ *   })
+ *
+ *   afterEach(() => {
+ *     sandbox.restore()
+ *   })
+ *
+ *   it('should log text to the console', () => {
+ *     ux.log('Hello, world!')
+ *     expect(stubs.stdout.firstCall.firstArg).to.equal('Hello, world!\n')
+ *   })
+ * })
+ */
+export declare function makeStubs(sandbox: SinonSandbox): Stubs;
+export {};

package/lib/cli-ux/stub.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeStubs = void 0;
+const write_1 = __importDefault(require("./write"));
+/**
+ * Create sinon stubs for writing to stdout and stderr.
+ *
+ * @example
+ * import {ux} from '@oclif/core'
+ *
+ * describe('example', () => {
+ *   let sandbox: SinonSandbox
+ *   let stubs: ReturnType<typeof ux.makeStubs>
+ *
+ *   beforeEach(() => {
+ *     sandbox = createSandbox()
+ *     stubs = ux.makeStubs(sandbox)
+ *   })
+ *
+ *   afterEach(() => {
+ *     sandbox.restore()
+ *   })
+ *
+ *   it('should log text to the console', () => {
+ *     ux.log('Hello, world!')
+ *     expect(stubs.stdout.firstCall.firstArg).to.equal('Hello, world!\n')
+ *   })
+ * })
+ */
+function makeStubs(sandbox) {
+    return {
+        stderr: sandbox.stub(write_1.default, 'stderr'),
+        stdout: sandbox.stub(write_1.default, 'stdout'),
+    };
+}
+exports.makeStubs = makeStubs;

package/lib/cli-ux/styled/table.js

@@ -36,7 +36,7 @@ const string_width_1 = __importDefault(require("string-width"));
 const F = __importStar(require("../../flags"));
 const screen_1 = require("../../screen");
 const util_1 = require("../../util/util");
-const stream_1 = require("../stream");
+const write_1 = __importDefault(require("../write"));
 class Table {
     data;
     columns;
@@ -68,7 +68,7 @@ class Table {
             'no-header': options['no-header'] ?? false,
             'no-truncate': options['no-truncate'] ?? false,
             output: csv ? 'csv' : output,
-            printLine: printLine ?? ((s) => stream_1.stdout.write(s + '\n')),
+            printLine: printLine ?? ((s) => write_1.default.stdout(s + '\n')),
             rowStart: ' ',
             sort,
             title,
@@ -116,7 +116,7 @@ class Table {
             this.columns = this.filterColumnsFromHeaders(filters);
         }
         else if (!this.options.extended) {
-            // show extented columns/properties
+            // show extended columns/properties
             this.columns = this.columns.filter((c) => !c.extended);
         }
         this.data = rows;
@@ -188,7 +188,7 @@ class Table {
         // truncation logic
         const shouldShorten = () => {
             // don't shorten if full mode
-            if (options['no-truncate'] || (!stream_1.stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK))
+            if (options['no-truncate'] || (!process.stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK))
                 return;
             // don't shorten if there is enough screen width
             const dataMaxWidth = (0, util_1.sumBy)(columns, (c) => c.width);

package/lib/cli-ux/write.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    stderr: (msg: string) => void;
+    stdout: (msg: string) => void;
+};
+export default _default;

package/lib/cli-ux/write.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stdout = (msg) => {
+    process.stdout.write(msg);
+};
+const stderr = (msg) => {
+    process.stderr.write(msg);
+};
+exports.default = {
+    stderr,
+    stdout,
+};

package/lib/command.d.ts

@@ -97,7 +97,8 @@ export declare abstract class Command {
         code?: string;
         exit?: number;
     } & PrettyPrintableError): never;
-    exit(code?: number): never;
+    exit(code: number): never;
+    exit(code: 0): void;
     protected finally(_: Error | undefined): Promise<any>;
     protected init(): Promise<any>;
     /**

package/lib/command.js

@@ -31,7 +31,6 @@ const chalk_1 = __importDefault(require("chalk"));
 const node_url_1 = require("node:url");
 const node_util_1 = require("node:util");
 const cli_ux_1 = require("./cli-ux");
-const stream_1 = require("./cli-ux/stream");
 const config_1 = require("./config");
 const Errors = __importStar(require("./errors"));
 const util_1 = require("./help/util");
@@ -44,7 +43,7 @@ const pjson = (0, fs_1.requireJson)(__dirname, '..', 'package.json');
  * swallows stdout epipe errors
  * this occurs when stdout closes such as when piping to head
  */
-stream_1.stdout.on('error', (err) => {
+process.stdout.on('error', (err) => {
     if (err && err.code === 'EPIPE')
         return;
     throw err;
@@ -223,7 +222,7 @@ class Command {
     log(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, node_util_1.inspect)(message);
-            stream_1.stdout.write((0, node_util_1.format)(message, ...args) + '\n');
+            cli_ux_1.ux.info(message, ...args);
         }
     }
     logJson(json) {
@@ -232,7 +231,7 @@ class Command {
     logToStderr(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, node_util_1.inspect)(message);
-            stream_1.stderr.write((0, node_util_1.format)(message, ...args) + '\n');
+            cli_ux_1.ux.logToStderr(message, ...args);
         }
     }
     async parse(options, argv = this.argv) {

package/lib/config/config.js

@@ -32,8 +32,7 @@ const is_wsl_1 = __importDefault(require("is-wsl"));
 const node_os_1 = require("node:os");
 const node_path_1 = require("node:path");
 const node_url_1 = require("node:url");
-const node_util_1 = require("node:util");
-const stream_1 = require("../cli-ux/stream");
+const cli_ux_1 = require("../cli-ux");
 const errors_1 = require("../errors");
 const util_1 = require("../help/util");
 const module_loader_1 = require("../module-loader");
@@ -448,7 +447,7 @@ class Config {
                     (0, errors_1.exit)(code);
                 },
                 log(message, ...args) {
-                    stream_1.stdout.write((0, node_util_1.format)(message, ...args) + '\n');
+                    cli_ux_1.ux.info(message, ...args);
                 },
                 warn(message) {
                     (0, errors_1.warn)(message);

package/lib/config/plugin.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Plugin = void 0;
-/* eslint-disable no-await-in-loop */
 const globby_1 = require("globby");
 const node_path_1 = require("node:path");
 const node_util_1 = require("node:util");
@@ -9,6 +8,7 @@ const errors_1 = require("../errors");
 const module_loader_1 = require("../module-loader");
 const performance_1 = require("../performance");
 const cache_command_1 = require("../util/cache-command");
+const find_root_1 = require("../util/find-root");
 const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
 const ts_node_1 = require("./ts-node");
@@ -26,79 +26,6 @@ function topicsToArray(input, base) {
         return [{ ...input[k], name: `${base}${k}` }, ...topicsToArray(input[k].subtopics, `${base}${input[k].name}`)];
     });
 }
-// essentially just "cd .."
-function* up(from) {
-    while ((0, node_path_1.dirname)(from) !== from) {
-        yield from;
-        from = (0, node_path_1.dirname)(from);
-    }
-    yield from;
-}
-async function findSourcesRoot(root, name) {
-    // If we know the plugin name then we just need to traverse the file
-    // system until we find the directory that matches the plugin name.
-    if (name) {
-        for (const next of up(root)) {
-            if (next.endsWith((0, node_path_1.basename)(name)))
-                return next;
-        }
-    }
-    // If there's no plugin name (typically just the root plugin), then we need
-    // to traverse the file system until we find a directory with a package.json
-    for (const next of up(root)) {
-        // Skip the bin directory
-        if ((0, node_path_1.basename)((0, node_path_1.dirname)(next)) === 'bin' &&
-            ['dev', 'dev.cmd', 'dev.js', 'run', 'run.cmd', 'run.js'].includes((0, node_path_1.basename)(next))) {
-            continue;
-        }
-        try {
-            const cur = (0, node_path_1.join)(next, 'package.json');
-            if (await (0, fs_1.safeReadJson)(cur))
-                return (0, node_path_1.dirname)(cur);
-        }
-        catch { }
-    }
-}
-/**
- * Find package root for packages installed into node_modules. This will go up directories
- * until it finds a node_modules directory with the plugin installed into it
- *
- * This is needed because some oclif plugins do not declare the `main` field in their package.json
- * https://github.com/oclif/config/pull/289#issuecomment-983904051
- *
- * @returns string
- * @param name string
- * @param root string
- */
-async function findRootLegacy(name, root) {
-    for (const next of up(root)) {
-        let cur;
-        if (name) {
-            cur = (0, node_path_1.join)(next, 'node_modules', name, 'package.json');
-            if (await (0, fs_1.safeReadJson)(cur))
-                return (0, node_path_1.dirname)(cur);
-            const pkg = await (0, fs_1.safeReadJson)((0, node_path_1.join)(next, 'package.json'));
-            if (pkg?.name === name)
-                return next;
-        }
-        else {
-            cur = (0, node_path_1.join)(next, 'package.json');
-            if (await (0, fs_1.safeReadJson)(cur))
-                return (0, node_path_1.dirname)(cur);
-        }
-    }
-}
-async function findRoot(name, root) {
-    if (name) {
-        let pkgPath;
-        try {
-            pkgPath = (0, util_2.resolvePackage)(name, { paths: [root] });
-        }
-        catch { }
-        return pkgPath ? findSourcesRoot((0, node_path_1.dirname)(pkgPath), name) : findRootLegacy(name, root);
-    }
-    return findSourcesRoot(root);
-}
 const cachedCommandCanBeUsed = (manifest, id) => Boolean(manifest?.commands[id] && 'isESM' in manifest.commands[id] && 'relativePath' in manifest.commands[id]);
 const search = (cmd) => {
     if (typeof cmd.run === 'function')
@@ -212,7 +139,7 @@ class Plugin {
         // Linked plugins already have a root so there's no need to search for it.
         // However there could be child plugins nested inside the linked plugin, in which
         // case we still need to search for the child plugin's root.
-        const root = this.type === 'link' && !this.parent ? this.options.root : await findRoot(this.options.name, this.options.root);
+        const root = this.type === 'link' && !this.parent ? this.options.root : await (0, find_root_1.findRoot)(this.options.name, this.options.root);
         if (!root)
             throw new errors_1.CLIError(`could not find package.json with ${(0, node_util_1.inspect)(this.options)}`);
         this.root = root;

package/lib/config/ts-node.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tsPath = exports.TS_CONFIGS = void 0;
-const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const errors_1 = require("../errors");
 const settings_1 = require("../settings");
@@ -26,7 +25,7 @@ function loadTSConfig(root) {
     }
     catch {
         try {
-            typescript = require((0, node_path_1.join)(root, 'node_modules', 'typescript'));
+            typescript = require(require.resolve('typescript', { paths: [root, __dirname] }));
         }
         catch {
             debug(`Could not find typescript dependency. Skipping ts-node registration for ${root}.`);
@@ -34,7 +33,7 @@ function loadTSConfig(root) {
             return;
         }
     }
-    if ((0, node_fs_1.existsSync)(tsconfigPath) && typescript) {
+    if ((0, fs_1.existsSync)(tsconfigPath) && typescript) {
         const tsconfig = typescript.parseConfigFileTextToJson(tsconfigPath, (0, fs_1.readJsonSync)(tsconfigPath, false)).config;
         if (!tsconfig || !tsconfig.compilerOptions) {
             throw new Error(`Could not read and parse tsconfig.json at ${tsconfigPath}, or it ` +
@@ -166,7 +165,7 @@ function determinePath(root, orig) {
     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')) {
+    if ((0, fs_1.existsSync)(out) || (0, fs_1.existsSync)(out + '.ts')) {
         debug(`Found source file for ${orig} at ${out}`);
         return out;
     }

package/lib/config/util.d.ts

@@ -1,6 +1,3 @@
-export declare function resolvePackage(id: string, paths: {
-    paths: string[];
-}): string;
 export declare function Debug(...scope: string[]): (..._: any) => void;
 export declare function getPermutations(arr: string[]): Array<string[]>;
 export declare function getCommandIdPermutations(commandId: string): string[];

package/lib/config/util.js

@@ -1,11 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.Debug = exports.resolvePackage = void 0;
+exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.Debug = void 0;
 const debug = require('debug');
-function resolvePackage(id, paths) {
-    return require.resolve(id, paths);
-}
-exports.resolvePackage = resolvePackage;
 function displayWarnings() {
     if (process.listenerCount('warning') > 1)
         return;

package/lib/errors/index.d.ts

@@ -5,7 +5,7 @@ export { CLIError } from './errors/cli';
 export { ExitError } from './errors/exit';
 export { ModuleLoadError } from './errors/module-load';
 export { handle } from './handle';
-export declare function exit(code?: number): never;
+export declare function exit(code?: number): void;
 export declare function error(input: Error | string, options: {
     exit: false;
 } & PrettyPrintableError): void;

package/lib/errors/index.js

@@ -39,7 +39,9 @@ Object.defineProperty(exports, "ModuleLoadError", { enumerable: true, get: funct
 var handle_1 = require("./handle");
 Object.defineProperty(exports, "handle", { enumerable: true, get: function () { return handle_1.handle; } });
 function exit(code = 0) {
-    throw new exit_1.ExitError(code);
+    if (code !== 0) {
+        throw new exit_1.ExitError(code);
+    }
 }
 exports.exit = exit;
 function error(input, options = {}) {

package/lib/help/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadHelpClass = exports.Help = exports.HelpBase = exports.standardizeIDFromArgv = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.CommandHelp = void 0;
 const node_util_1 = require("node:util");
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
-const stream_1 = require("../cli-ux/stream");
+const write_1 = __importDefault(require("../cli-ux/write"));
 const errors_1 = require("../errors");
 const module_loader_1 = require("../module-loader");
 const cache_default_value_1 = require("../util/cache-default-value");
@@ -133,7 +133,7 @@ class Help extends HelpBase {
         return new this.CommandHelpClass(command, this.config, this.opts);
     }
     log(...args) {
-        stream_1.stdout.write(node_util_1.format.apply(this, args) + '\n');
+        write_1.default.stdout(node_util_1.format.apply(this, args) + '\n');
     }
     async showCommandHelp(command) {
         const name = command.id;

package/lib/index.js

@@ -22,16 +22,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.settings = exports.Performance = exports.Parser = exports.run = exports.Interfaces = exports.toStandardizedId = exports.toConfiguredId = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.stdout = exports.stderr = exports.flush = exports.ux = exports.Args = void 0;
-const stream_1 = require("./cli-ux/stream");
+const write_1 = __importDefault(require("./cli-ux/write"));
 function checkCWD() {
     try {
         process.cwd();
     }
     catch (error) {
         if (error.code === 'ENOENT') {
-            stream_1.stderr.write('WARNING: current directory does not exist\n');
+            write_1.default.stderr('WARNING: current directory does not exist\n');
         }
     }
 }
@@ -40,9 +43,10 @@ exports.Args = __importStar(require("./args"));
 exports.ux = __importStar(require("./cli-ux"));
 var flush_1 = require("./cli-ux/flush");
 Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return flush_1.flush; } });
-var stream_2 = require("./cli-ux/stream");
-Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_2.stderr; } });
-Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_2.stdout; } });
+// Remove these in the next major version
+var 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; } });
 var command_1 = require("./command");
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
 var config_1 = require("./config");

package/lib/interfaces/pjson.d.ts

@@ -102,6 +102,7 @@ export declare namespace PJSON {
             nsisCustomization?: string;
             schema?: number;
             scope?: string;
+            pluginPrefix?: string;
             'warn-if-update-available'?: {
                 authorization: string;
                 message: string;

package/lib/interfaces/plugin.d.ts

@@ -59,6 +59,7 @@ export interface Plugin {
      */
     name: string;
     readonly options: Options;
+    parent?: Plugin;
     /**
      * full package.json
      *

package/lib/main.js

@@ -2,16 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = exports.versionAddition = exports.helpAddition = void 0;
 const node_url_1 = require("node:url");
-const node_util_1 = require("node:util");
-const stream_1 = require("./cli-ux/stream");
+const cli_ux_1 = require("./cli-ux");
 const config_1 = require("./config");
 const help_1 = require("./help");
 const performance_1 = require("./performance");
 const debug = require('debug')('oclif:main');
-const log = (message = '', ...args) => {
-    message = typeof message === 'string' ? message : (0, node_util_1.inspect)(message);
-    stream_1.stdout.write((0, node_util_1.format)(message, ...args) + '\n');
-};
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.pjson.oclif.default)
         return true;
@@ -57,7 +52,7 @@ async function run(argv, options) {
     await config.runHook('init', { argv: argvSlice, id });
     // display version if applicable
     if ((0, exports.versionAddition)(argv, config)) {
-        log(config.userAgent);
+        cli_ux_1.ux.log(config.userAgent);
         await collectPerf();
         return;
     }

package/lib/module-loader.js

@@ -6,6 +6,7 @@ const node_path_1 = require("node:path");
 const node_url_1 = require("node:url");
 const ts_node_1 = require("./config/ts-node");
 const errors_1 = require("./errors");
+const fs_1 = require("./util/fs");
 const getPackageType = require('get-package-type');
 /**
  * Defines file extension resolution when source files do not have an extension.
@@ -166,7 +167,7 @@ function resolvePath(config, modulePath) {
             (isPlugin(config) ? (0, ts_node_1.tsPath)(config.root, modulePath, config) : (0, ts_node_1.tsPath)(config.root, modulePath)) ?? modulePath;
         let fileExists = false;
         let isDirectory = false;
-        if ((0, node_fs_1.existsSync)(filePath)) {
+        if ((0, fs_1.existsSync)(filePath)) {
             fileExists = true;
             try {
                 if ((0, node_fs_1.lstatSync)(filePath)?.isDirectory?.()) {
@@ -202,7 +203,7 @@ function findFile(filePath) {
     // eslint-disable-next-line camelcase
     for (const extension of s_EXTENSIONS) {
         const testPath = `${filePath}${extension}`;
-        if ((0, node_fs_1.existsSync)(testPath)) {
+        if ((0, fs_1.existsSync)(testPath)) {
             return testPath;
         }
     }

package/lib/screen.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errtermwidth = exports.stdtermwidth = void 0;
-const stream_1 = require("./cli-ux/stream");
 const settings_1 = require("./settings");
 function termwidth(stream) {
     if (!stream.isTTY) {
@@ -17,5 +16,5 @@ function termwidth(stream) {
     return width;
 }
 const columns = Number.parseInt(process.env.OCLIF_COLUMNS, 10) || settings_1.settings.columns;
-exports.stdtermwidth = columns || termwidth(stream_1.stdout);
-exports.errtermwidth = columns || termwidth(stream_1.stderr);
+exports.stdtermwidth = columns || termwidth(process.stdout);
+exports.errtermwidth = columns || termwidth(process.stderr);

package/lib/util/find-root.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Returns the root directory of the plugin.
+ *
+ * It first attempts to use require.resolve to find the plugin root.
+ * If that returns a path, it will `cd` up the file system until if finds the package.json for the plugin
+ * Example: node_modules/@oclif/plugin-version/dist/index.js -> node_modules/@oclif/plugin-version
+ *
+ * If require.resolve throws an error, it will attempt to find the plugin root by traversing the file system.
+ * If we're in a PnP environment (determined by process.versions.pnp), it will use the pnpapi module to
+ * traverse the dependency tree. Otherwise, it will traverse the node_modules until it finds a package.json
+ * with a matching name.
+ *
+ * If no path is found, undefined is returned which will eventually result in a thrown Error from Plugin.
+ */
+export declare function findRoot(name: string | undefined, root: string): Promise<string | undefined>;

package/lib/util/find-root.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findRoot = void 0;
+const node_path_1 = require("node:path");
+const fs_1 = require("./fs");
+// essentially just "cd .."
+function* up(from) {
+    while ((0, node_path_1.dirname)(from) !== from) {
+        yield from;
+        from = (0, node_path_1.dirname)(from);
+    }
+    yield from;
+}
+/**
+ * Return the plugin root directory from a given file. This will `cd` up the file system until it finds
+ * a package.json and then return the dirname of that path.
+ *
+ * Example: node_modules/@oclif/plugin-version/dist/index.js -> node_modules/@oclif/plugin-version
+ */
+async function findPluginRoot(root, name) {
+    // If we know the plugin name then we just need to traverse the file
+    // system until we find the directory that matches the plugin name.
+    if (name) {
+        for (const next of up(root)) {
+            if (next.endsWith((0, node_path_1.basename)(name)))
+                return next;
+        }
+    }
+    // If there's no plugin name (typically just the root plugin), then we need
+    // to traverse the file system until we find a directory with a package.json
+    for (const next of up(root)) {
+        // Skip the bin directory
+        if ((0, node_path_1.basename)((0, node_path_1.dirname)(next)) === 'bin' &&
+            ['dev', 'dev.cmd', 'dev.js', 'run', 'run.cmd', 'run.js'].includes((0, node_path_1.basename)(next))) {
+            continue;
+        }
+        try {
+            const cur = (0, node_path_1.join)(next, 'package.json');
+            if (await (0, fs_1.safeReadJson)(cur))
+                return (0, node_path_1.dirname)(cur);
+        }
+        catch { }
+    }
+}
+/**
+ * Find plugin root directory for plugins installed into node_modules that don't have a `main` or `export`.
+ * This will go up directories until it finds a directory with the plugin installed into it.
+ *
+ * See https://github.com/oclif/config/pull/289#issuecomment-983904051
+ */
+async function findRootLegacy(name, root) {
+    for (const next of up(root)) {
+        let cur;
+        if (name) {
+            cur = (0, node_path_1.join)(next, 'node_modules', name, 'package.json');
+            if (await (0, fs_1.safeReadJson)(cur))
+                return (0, node_path_1.dirname)(cur);
+            const pkg = await (0, fs_1.safeReadJson)((0, node_path_1.join)(next, 'package.json'));
+            if (pkg?.name === name)
+                return next;
+        }
+        else {
+            cur = (0, node_path_1.join)(next, 'package.json');
+            if (await (0, fs_1.safeReadJson)(cur))
+                return (0, node_path_1.dirname)(cur);
+        }
+    }
+}
+let pnp;
+/**
+ * The pnpapi module is only available if running in a pnp environment. Because of that
+ * we have to require it from the plugin.
+ *
+ * Solution taken from here: https://github.com/yarnpkg/berry/issues/1467#issuecomment-642869600
+ */
+function maybeRequirePnpApi(root) {
+    if (pnp)
+        return pnp;
+    // eslint-disable-next-line node/no-missing-require
+    pnp = require(require.resolve('pnpapi', { paths: [root] }));
+    return pnp;
+}
+const getKey = (locator) => JSON.stringify(locator);
+const isPeerDependency = (pkg, parentPkg, name) => getKey(pkg?.packageDependencies.get(name)) === getKey(parentPkg?.packageDependencies.get(name));
+/**
+ * Traverse PnP dependency tree to find plugin root directory.
+ *
+ * Implementation adapted from https://yarnpkg.com/advanced/pnpapi#traversing-the-dependency-tree
+ */
+function findPnpRoot(name, root) {
+    maybeRequirePnpApi(root);
+    const seen = new Set();
+    const traverseDependencyTree = (locator, parentPkg) => {
+        // Prevent infinite recursion when A depends on B which depends on A
+        const key = getKey(locator);
+        if (seen.has(key))
+            return;
+        const pkg = pnp.getPackageInformation(locator);
+        if (locator.name === name) {
+            return pkg.packageLocation;
+        }
+        seen.add(key);
+        for (const [name, referencish] of pkg.packageDependencies) {
+            // Unmet peer dependencies
+            if (referencish === null)
+                continue;
+            // Avoid iterating on peer dependencies - very expensive
+            if (parentPkg !== null && isPeerDependency(pkg, parentPkg, name))
+                continue;
+            const childLocator = pnp.getLocator(name, referencish);
+            const foundSomething = traverseDependencyTree(childLocator, pkg);
+            if (foundSomething)
+                return foundSomething;
+        }
+        // Important: This `delete` here causes the traversal to go over nodes even
+        // if they have already been traversed in another branch. If you don't need
+        // that, remove this line for a hefty speed increase.
+        seen.delete(key);
+    };
+    // Iterate on each workspace
+    for (const locator of pnp.getDependencyTreeRoots()) {
+        const foundSomething = traverseDependencyTree(locator);
+        if (foundSomething)
+            return foundSomething;
+    }
+}
+/**
+ * Returns the root directory of the plugin.
+ *
+ * It first attempts to use require.resolve to find the plugin root.
+ * If that returns a path, it will `cd` up the file system until if finds the package.json for the plugin
+ * Example: node_modules/@oclif/plugin-version/dist/index.js -> node_modules/@oclif/plugin-version
+ *
+ * If require.resolve throws an error, it will attempt to find the plugin root by traversing the file system.
+ * If we're in a PnP environment (determined by process.versions.pnp), it will use the pnpapi module to
+ * traverse the dependency tree. Otherwise, it will traverse the node_modules until it finds a package.json
+ * with a matching name.
+ *
+ * If no path is found, undefined is returned which will eventually result in a thrown Error from Plugin.
+ */
+async function findRoot(name, root) {
+    if (name) {
+        let pkgPath;
+        try {
+            pkgPath = require.resolve(name, { paths: [root] });
+        }
+        catch { }
+        if (pkgPath)
+            return findPluginRoot((0, node_path_1.dirname)(pkgPath), name);
+        return process.versions.pnp ? findPnpRoot(name, root) : findRootLegacy(name, root);
+    }
+    return findPluginRoot(root);
+}
+exports.findRoot = findRoot;

package/lib/util/fs.d.ts

@@ -17,3 +17,4 @@ export declare function readJson<T = unknown>(path: string): Promise<T>;
 export declare function readJsonSync(path: string, parse: false): string;
 export declare function readJsonSync<T = unknown>(path: string, parse?: true): T;
 export declare function safeReadJson<T>(path: string): Promise<T | undefined>;
+export declare function existsSync(path: string): boolean;

package/lib/util/fs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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 = exports.requireJson = void 0;
 const node_fs_1 = require("node:fs");
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
@@ -67,3 +67,7 @@ async function safeReadJson(path) {
     catch { }
 }
 exports.safeReadJson = safeReadJson;
+function existsSync(path) {
+    return (0, node_fs_1.existsSync)(path);
+}
+exports.existsSync = existsSync;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.3.3",
+  "version": "3.4.1-dev.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -49,6 +49,7 @@
     "@types/mocha": "^10.0.2",
     "@types/node": "^18",
     "@types/node-notifier": "^8.0.2",
+    "@types/pnpapi": "^0.0.4",
     "@types/slice-ansi": "^4.0.0",
     "@types/strip-ansi": "^5.2.1",
     "@types/supports-color": "^8.1.1",
@@ -72,7 +73,7 @@
     "nyc": "^15.1.0",
     "prettier": "^3.0.3",
     "shx": "^0.3.4",
-    "sinon": "^11.1.2",
+    "sinon": "^16.1.0",
     "ts-node": "^10.9.1",
     "tsd": "^0.29.0",
     "typescript": "^5"