@oclif/core 2.1.7 → 2.2.1

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

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionBase = void 0;
 const util_1 = require("util");
 const util_2 = require("../../util");
+const stream_1 = require("../stream");
 class ActionBase {
     constructor() {
         this.std = 'stderr';
         this.stdmockOrigs = {
-            stdout: process.stdout.write,
-            stderr: process.stderr.write,
+            stdout: stream_1.stdout.write,
+            stderr: stream_1.stderr.write,
         };
     }
     start(action, status, opts = {}) {
@@ -109,28 +110,30 @@ class ActionBase {
     // mock out stdout/stderr so it doesn't screw up the rendering
     _stdout(toggle) {
         try {
-            const outputs = ['stdout', 'stderr'];
             if (toggle) {
                 if (this.stdmocks)
                     return;
                 this.stdmockOrigs = {
-                    stdout: process.stdout.write,
-                    stderr: process.stderr.write,
+                    stdout: stream_1.stdout.write,
+                    stderr: stream_1.stderr.write,
                 };
                 this.stdmocks = [];
-                for (const std of outputs) {
-                    process[std].write = (...args) => {
-                        this.stdmocks.push([std, args]);
-                    };
-                }
+                stream_1.stdout.write = (...args) => {
+                    this.stdmocks.push(['stdout', args]);
+                    return true;
+                };
+                stream_1.stderr.write = (...args) => {
+                    this.stdmocks.push(['stderr', args]);
+                    return true;
+                };
             }
             else {
                 if (!this.stdmocks)
                     return;
                 // this._write('stderr', '\nresetstdmock\n\n\n')
                 delete this.stdmocks;
-                for (const std of outputs)
-                    process[std].write = this.stdmockOrigs[std];
+                stream_1.stdout.write = this.stdmockOrigs.stdout;
+                stream_1.stderr.write = this.stdmockOrigs.stderr;
             }
         }
         catch (error) {
@@ -160,7 +163,16 @@ class ActionBase {
     }
     // write to the real stdout/stderr
     _write(std, s) {
-        this.stdmockOrigs[std].apply(process[std], (0, util_2.castArray)(s));
+        switch (std) {
+            case 'stdout':
+                this.stdmockOrigs.stdout.apply(stream_1.stdout, (0, util_2.castArray)(s));
+                break;
+            case 'stderr':
+                this.stdmockOrigs.stderr.apply(stream_1.stderr, (0, util_2.castArray)(s));
+                break;
+            default:
+                throw new Error(`invalid std: ${std}`);
+        }
     }
 }
 exports.ActionBase = ActionBase;

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

@@ -18,7 +18,7 @@ export declare class ux {
     static get action(): ActionBase;
     static get prideAction(): ActionBase;
     static styledObject(obj: any, keys?: string[]): void;
-    static get styledHeader(): typeof styled.styledHeader;
+    static styledHeader(header: string): void;
     static get styledJSON(): typeof styled.styledJSON;
     static get table(): typeof styled.Table.table;
     static get tree(): typeof styled.tree;
@@ -47,7 +47,7 @@ declare const log: typeof ux.log;
 declare const prideAction: ActionBase;
 declare const progress: typeof styled.progress;
 declare const prompt: typeof uxPrompt.prompt;
-declare const styledHeader: typeof styled.styledHeader;
+declare const styledHeader: typeof ux.styledHeader;
 declare const styledJSON: typeof styled.styledJSON;
 declare const styledObject: typeof ux.styledObject;
 declare const table: typeof styled.Table.table;

package/lib/cli-ux/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.warn = exports.wait = exports.url = exports.tree = exports.trace = exports.Table = exports.table = exports.styledObject = exports.styledJSON = exports.styledHeader = exports.prompt = exports.progress = exports.prideAction = exports.log = exports.info = exports.flush = exports.ExitError = exports.exit = exports.error = exports.done = exports.debug = exports.confirm = exports.Config = exports.config = exports.anykey = exports.annotation = exports.ActionBase = exports.action = exports.ux = void 0;
 const Errors = require("../errors");
 const util = require("util");
+const chalk = require("chalk");
 const base_1 = require("./action/base");
 Object.defineProperty(exports, "ActionBase", { enumerable: true, get: function () { return base_1.ActionBase; } });
 const config_1 = require("./config");
@@ -15,6 +16,7 @@ const styled_1 = require("./styled");
 Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return styled_1.Table; } });
 const uxPrompt = require("./prompt");
 const wait_1 = require("./wait");
+const stream_1 = require("./stream");
 const hyperlinker = require('hyperlinker');
 function timeout(p, ms) {
     function wait(ms, unref = false) {
@@ -28,9 +30,9 @@ function timeout(p, ms) {
 }
 async function _flush() {
     const p = new Promise(resolve => {
-        process.stdout.once('drain', () => resolve(null));
+        stream_1.stdout.once('drain', () => resolve(null));
     });
-    const flushed = process.stdout.write('');
+    const flushed = stream_1.stdout.write('');
     if (flushed) {
         return Promise.resolve();
     }
@@ -59,8 +61,8 @@ class ux {
     static styledObject(obj, keys) {
         this.info(styled.styledObject(obj, keys));
     }
-    static get styledHeader() {
-        return styled.styledHeader;
+    static styledHeader(header) {
+        this.info(chalk.dim('=== ') + chalk.bold(header) + '\n');
     }
     static get styledJSON() {
         return styled.styledJSON;
@@ -82,16 +84,16 @@ class ux {
     }
     static trace(format, ...args) {
         if (this.config.outputLevel === 'trace') {
-            process.stdout.write(util.format(format, ...args) + '\n');
+            stream_1.stdout.write(util.format(format, ...args) + '\n');
         }
     }
     static debug(format, ...args) {
         if (['trace', 'debug'].includes(this.config.outputLevel)) {
-            process.stdout.write(util.format(format, ...args) + '\n');
+            stream_1.stdout.write(util.format(format, ...args) + '\n');
         }
     }
     static info(format, ...args) {
-        process.stdout.write(util.format(format, ...args) + '\n');
+        stream_1.stdout.write(util.format(format, ...args) + '\n');
     }
     static log(format, ...args) {
         this.info(format || '', ...args);

package/lib/cli-ux/prompt.js

@@ -4,6 +4,7 @@ exports.anykey = exports.confirm = exports.prompt = void 0;
 const Errors = require("../errors");
 const config_1 = require("./config");
 const chalk = require("chalk");
+const stream_1 = require("./stream");
 const ansiEscapes = require('ansi-escapes');
 const passwordPrompt = require('password-prompt');
 function normal(options, retries = 100) {
@@ -19,7 +20,7 @@ function normal(options, retries = 100) {
             timer.unref();
         }
         process.stdin.setEncoding('utf8');
-        process.stderr.write(options.prompt);
+        stream_1.stderr.write(options.prompt);
         process.stdin.resume();
         process.stdin.once('data', b => {
             if (timer)
@@ -57,7 +58,7 @@ async function single(options) {
     return response;
 }
 function replacePrompt(prompt) {
-    process.stderr.write(ansiEscapes.cursorHide + ansiEscapes.cursorUp(1) + ansiEscapes.cursorLeft + prompt +
+    stream_1.stderr.write(ansiEscapes.cursorHide + ansiEscapes.cursorUp(1) + ansiEscapes.cursorLeft + prompt +
         ansiEscapes.cursorDown(1) + ansiEscapes.cursorLeft + ansiEscapes.cursorShow);
 }
 async function _prompt(name, inputOptions = {}) {
@@ -140,7 +141,7 @@ async function anykey(message) {
     }
     const char = await prompt(message, { type: 'single', required: false });
     if (tty)
-        process.stderr.write('\n');
+        stream_1.stderr.write('\n');
     if (char === 'q')
         Errors.error('quit');
     if (char === '\u0003')

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

@@ -0,0 +1,17 @@
+/**
+ * A wrapper around process.stdout and process.stderr that allows us to mock out the streams for testing.
+ */
+declare class Stream {
+    channel: 'stdout' | 'stderr';
+    constructor(channel: 'stdout' | 'stderr');
+    get isTTY(): boolean;
+    getWindowSize(): number[];
+    write(data: string): boolean;
+    read(): boolean;
+    on(event: string, listener: (...args: any[]) => void): Stream;
+    once(event: string, listener: (...args: any[]) => void): Stream;
+    emit(event: string, ...args: any[]): boolean;
+}
+export declare const stdout: Stream;
+export declare const stderr: Stream;
+export {};

package/lib/cli-ux/stream.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stderr = exports.stdout = void 0;
+/**
+ * A wrapper around process.stdout and process.stderr that allows us to mock out the streams for testing.
+ */
+class Stream {
+    constructor(channel) {
+        this.channel = channel;
+    }
+    get isTTY() {
+        return process[this.channel].isTTY;
+    }
+    getWindowSize() {
+        return process[this.channel].getWindowSize();
+    }
+    write(data) {
+        return process[this.channel].write(data);
+    }
+    read() {
+        return process[this.channel].read();
+    }
+    on(event, listener) {
+        process[this.channel].on(event, listener);
+        return this;
+    }
+    once(event, listener) {
+        process[this.channel].once(event, listener);
+        return this;
+    }
+    emit(event, ...args) {
+        return process[this.channel].emit(event, ...args);
+    }
+}
+exports.stdout = new Stream('stdout');
+exports.stderr = new Stream('stderr');

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

@@ -1,7 +1,6 @@
-import styledHeader from './header';
 import styledJSON from './json';
 import styledObject from './object';
 import * as Table from './table';
 import tree from './tree';
 import progress from './progress';
-export { styledHeader, styledJSON, styledObject, Table, tree, progress, };
+export { styledJSON, styledObject, Table, tree, progress, };

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

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.progress = exports.tree = exports.Table = exports.styledObject = exports.styledJSON = exports.styledHeader = void 0;
-const header_1 = require("./header");
-exports.styledHeader = header_1.default;
+exports.progress = exports.tree = exports.Table = exports.styledObject = exports.styledJSON = void 0;
 const json_1 = require("./json");
 exports.styledJSON = json_1.default;
 const object_1 = require("./object");

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

@@ -7,6 +7,7 @@ const chalk = require("chalk");
 const util_1 = require("../../util");
 const js_yaml_1 = require("js-yaml");
 const util_2 = require("util");
+const stream_1 = require("../stream");
 const sw = require('string-width');
 const { orderBy } = require('natural-orderby');
 class Table {
@@ -37,7 +38,7 @@ class Table {
             filter,
             'no-header': options['no-header'] ?? false,
             'no-truncate': options['no-truncate'] ?? false,
-            printLine: printLine ?? ((s) => process.stdout.write(s + '\n')),
+            printLine: printLine ?? ((s) => stream_1.stdout.write(s + '\n')),
             rowStart: ' ',
             sort,
             title,
@@ -171,7 +172,7 @@ class Table {
         // truncation logic
         const shouldShorten = () => {
             // don't shorten if full mode
-            if (options['no-truncate'] || (!process.stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK))
+            if (options['no-truncate'] || (!stream_1.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/command.d.ts

@@ -76,7 +76,7 @@ export declare abstract class Command {
      * @param {LoadOptions} opts options
      * @returns {Promise<unknown>} result
      */
-    static run<T extends Command>(this: new (argv: string[], config: Config) => T, argv?: string[], opts?: LoadOptions): Promise<unknown>;
+    static run<T extends Command>(this: new (argv: string[], config: Config) => T, argv?: string[], opts?: LoadOptions): Promise<ReturnType<T['run']>>;
     protected static _baseFlags: FlagInput;
     static get baseFlags(): FlagInput;
     static set baseFlags(flags: FlagInput);
@@ -88,7 +88,7 @@ export declare abstract class Command {
     protected debug: (...args: any[]) => void;
     constructor(argv: string[], config: Config);
     protected get ctor(): typeof Command;
-    protected _run<T>(): Promise<T | undefined>;
+    protected _run<T>(): Promise<T>;
     exit(code?: number): void;
     warn(input: string | Error): string | Error;
     error(input: string | Error, options: {
@@ -114,6 +114,7 @@ export declare abstract class Command {
     protected finally(_: Error | undefined): Promise<any>;
     protected toSuccessJson(result: unknown): any;
     protected toErrorJson(err: unknown): any;
+    protected logJson(json: unknown): void;
 }
 export declare namespace Command {
     type Class = typeof Command & {

package/lib/command.js

@@ -4,19 +4,20 @@ exports.Command = void 0;
 const url_1 = require("url");
 const chalk = require("chalk");
 const util_1 = require("util");
-const ux = require("./cli-ux");
+const cli_ux_1 = require("./cli-ux");
 const config_1 = require("./config");
 const Errors = require("./errors");
 const Parser = require("./parser");
 const util_2 = require("./help/util");
 const flags_1 = require("./flags");
 const util_3 = require("./util");
+const stream_1 = require("./cli-ux/stream");
 const pjson = (0, util_3.requireJson)(__dirname, '..', 'package.json');
 /**
  * swallows stdout epipe errors
  * this occurs when stdout closes such as when piping to head
  */
-process.stdout.on('error', (err) => {
+stream_1.stdout.on('error', (err) => {
     if (err && err.code === 'EPIPE')
         return;
     throw err;
@@ -113,9 +114,8 @@ class Command {
         finally {
             await this.finally(err);
         }
-        if (result && this.jsonEnabled()) {
-            ux.styledJSON(this.toSuccessJson(result));
-        }
+        if (result && this.jsonEnabled())
+            this.logJson(this.toSuccessJson(result));
         return result;
     }
     exit(code = 0) {
@@ -132,13 +132,13 @@ class Command {
     log(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, util_1.inspect)(message);
-            process.stdout.write((0, util_1.format)(message, ...args) + '\n');
+            stream_1.stdout.write((0, util_1.format)(message, ...args) + '\n');
         }
     }
     logToStderr(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, util_1.inspect)(message);
-            process.stderr.write((0, util_1.format)(message, ...args) + '\n');
+            stream_1.stderr.write((0, util_1.format)(message, ...args) + '\n');
         }
     }
     jsonEnabled() {
@@ -197,13 +197,13 @@ class Command {
     async catch(err) {
         process.exitCode = process.exitCode ?? err.exitCode ?? 1;
         if (this.jsonEnabled()) {
-            ux.styledJSON(this.toErrorJson(err));
+            this.logJson(this.toErrorJson(err));
         }
         else {
             if (!err.message)
                 throw err;
             try {
-                ux.action.stop(chalk.bold.red('!'));
+                cli_ux_1.ux.action.stop(chalk.bold.red('!'));
             }
             catch { }
             throw err;
@@ -225,6 +225,9 @@ class Command {
     toErrorJson(err) {
         return { error: err };
     }
+    logJson(json) {
+        cli_ux_1.ux.styledJSON(json);
+    }
 }
 exports.Command = Command;
 Command._base = `${pjson.name}@${pjson.version}`;

package/lib/config/config.js

@@ -12,6 +12,7 @@ const util_2 = require("./util");
 const util_3 = require("../util");
 const module_loader_1 = require("../module-loader");
 const util_4 = require("../help/util");
+const stream_1 = require("../cli-ux/stream");
 // eslint-disable-next-line new-cap
 const debug = (0, util_2.Debug)();
 const _pjson = (0, util_3.requireJson)(__dirname, '..', '..', 'package.json');
@@ -220,7 +221,7 @@ class Config {
                     (0, errors_1.exit)(code);
                 },
                 log(message, ...args) {
-                    process.stdout.write((0, util_1.format)(message, ...args) + '\n');
+                    stream_1.stdout.write((0, util_1.format)(message, ...args) + '\n');
                 },
                 error(message, options = {}) {
                     (0, errors_1.error)(message, options);

package/lib/help/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Help = exports.HelpBase = exports.normalizeArgv = exports.getHelpFlagAdditions = exports.loadHelpClass = exports.standardizeIDFromArgv = exports.CommandHelp = void 0;
 const stripAnsi = require("strip-ansi");
+const util = require("util");
 const errors_1 = require("../errors");
 const command_1 = require("./command");
 const root_1 = require("./root");
@@ -9,6 +10,7 @@ const util_1 = require("../util");
 const util_2 = require("./util");
 const formatter_1 = require("./formatter");
 const config_1 = require("../config/config");
+const stream_1 = require("../cli-ux/stream");
 var command_2 = require("./command");
 Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return command_2.CommandHelp; } });
 var util_3 = require("./util");
@@ -268,7 +270,7 @@ class Help extends HelpBase {
         return this.formatCommand(command);
     }
     log(...args) {
-        console.log(...args);
+        stream_1.stdout.write(util.format.apply(this, args) + '\n');
     }
 }
 exports.Help = Help;

package/lib/index.d.ts

@@ -12,5 +12,6 @@ import { Hook } from './interfaces/hooks';
 import { settings, Settings } from './settings';
 import { HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable } from './help/formatter';
 import * as ux from './cli-ux';
+import { stderr, stdout } from './cli-ux/stream';
 declare const flush: typeof ux.ux.flush;
-export { Args, Command, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toCached, tsPath, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, };
+export { Args, Command, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toCached, tsPath, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, stderr, stdout, };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Command = exports.Args = void 0;
+exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Command = exports.Args = void 0;
 const semver = require("semver");
 const command_1 = require("./command");
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
@@ -35,6 +35,9 @@ Object.defineProperty(exports, "settings", { enumerable: true, get: function ()
 const ux = require("./cli-ux");
 exports.ux = ux;
 const util_2 = require("./util");
+const stream_1 = require("./cli-ux/stream");
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_1.stderr; } });
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_1.stdout; } });
 const flush = ux.flush;
 exports.flush = flush;
 function checkCWD() {
@@ -43,14 +46,14 @@ function checkCWD() {
     }
     catch (error) {
         if (error.code === 'ENOENT') {
-            process.stderr.write('WARNING: current directory does not exist\n');
+            stream_1.stderr.write('WARNING: current directory does not exist\n');
         }
     }
 }
 function checkNodeVersion() {
     const pjson = (0, util_2.requireJson)(__dirname, '..', 'package.json');
     if (!semver.satisfies(process.versions.node, pjson.engines.node)) {
-        process.stderr.write(`WARNING\nWARNING Node version must be ${pjson.engines.node} to use this CLI\nWARNING Current node version: ${process.versions.node}\nWARNING\n`);
+        stream_1.stderr.write(`WARNING\nWARNING Node version must be ${pjson.engines.node} to use this CLI\nWARNING Current node version: ${process.versions.node}\nWARNING\n`);
     }
 }
 checkCWD();

package/lib/main.js

@@ -9,9 +9,10 @@ const help_1 = require("./help");
 const settings_1 = require("./settings");
 const _1 = require(".");
 const path_1 = require("path");
+const stream_1 = require("./cli-ux/stream");
 const log = (message = '', ...args) => {
     message = typeof message === 'string' ? message : (0, util_1.inspect)(message);
-    process.stdout.write((0, util_1.format)(message, ...args) + '\n');
+    stream_1.stdout.write((0, util_1.format)(message, ...args) + '\n');
 };
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.pjson.oclif.default)

package/lib/screen.js

@@ -1,6 +1,7 @@
 "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) {
@@ -16,5 +17,5 @@ function termwidth(stream) {
     return width;
 }
 const columns = Number.parseInt(process.env.OCLIF_COLUMNS, 10) || settings_1.settings.columns;
-exports.stdtermwidth = columns || termwidth(process.stdout);
-exports.errtermwidth = columns || termwidth(process.stderr);
+exports.stdtermwidth = columns || termwidth(stream_1.stdout);
+exports.errtermwidth = columns || termwidth(stream_1.stderr);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.1.7",
+  "version": "2.2.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {

package/lib/cli-ux/styled/header.d.ts

@@ -1 +0,0 @@
-export default function styledHeader(header: string): void;

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

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const index_1 = require("../../index");
-function styledHeader(header) {
-    index_1.ux.info(chalk.dim('=== ') + chalk.bold(header) + '\n');
-}
-exports.default = styledHeader;