@oclif/core 3.0.0-beta.2 → 3.0.0-beta.21

package/lib/cli-ux/index.js

@@ -1,44 +1,19 @@
 "use strict";
 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; } });
+exports.Config = exports.config = exports.ActionBase = exports.Table = exports.ExitError = 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;
+const tslib_1 = require("tslib");
+const Errors = tslib_1.__importStar(require("../errors"));
+const styled = tslib_1.__importStar(require("./styled"));
+const uxPrompt = tslib_1.__importStar(require("./prompt"));
 const config_1 = require("./config");
-Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });
-Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-const exit_1 = require("./exit");
-Object.defineProperty(exports, "ExitError", { enumerable: true, get: function () { return exit_1.ExitError; } });
-const styled = require("./styled");
-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 flush_1 = require("./flush");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const stream_1 = require("./stream");
+const node_util_1 = require("node:util");
+const wait_1 = tslib_1.__importDefault(require("./wait"));
 const hyperlinker = require('hyperlinker');
-function timeout(p, ms) {
-    function wait(ms, unref = false) {
-        return new Promise(resolve => {
-            const t = setTimeout(() => resolve(null), ms);
-            if (unref)
-                t.unref();
-        });
-    }
-    return Promise.race([p, wait(ms, true).then(() => Errors.error('timed out'))]);
-}
-async function _flush() {
-    const p = new Promise(resolve => {
-        stream_1.stdout.once('drain', () => resolve(null));
-    });
-    const flushed = stream_1.stdout.write('');
-    if (flushed) {
-        return Promise.resolve();
-    }
-    return p;
-}
 class ux {
+    static config = config_1.config;
     static get prompt() {
         return uxPrompt.prompt;
     }
@@ -54,15 +29,11 @@ class ux {
     static get action() {
         return config_1.config.action;
     }
-    static get prideAction() {
-        return config_1.config.prideAction;
-    }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static styledObject(obj, keys) {
         this.info(styled.styledObject(obj, keys));
     }
     static styledHeader(header) {
-        this.info(chalk.dim('=== ') + chalk.bold(header) + '\n');
+        this.info(chalk_1.default.dim('=== ') + chalk_1.default.bold(header) + '\n');
     }
     static get styledJSON() {
         return styled.styledJSON;
@@ -84,16 +55,16 @@ class ux {
     }
     static trace(format, ...args) {
         if (this.config.outputLevel === 'trace') {
-            stream_1.stdout.write(util.format(format, ...args) + '\n');
+            stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
         }
     }
     static debug(format, ...args) {
         if (['trace', 'debug'].includes(this.config.outputLevel)) {
-            stream_1.stdout.write(util.format(format, ...args) + '\n');
+            stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
         }
     }
     static info(format, ...args) {
-        stream_1.stdout.write(util.format(format, ...args) + '\n');
+        stream_1.stdout.write((0, node_util_1.format)(format, ...args) + '\n');
     }
     static log(format, ...args) {
         this.info(format || '', ...args);
@@ -118,58 +89,35 @@ class ux {
         }
     }
     static async flush(ms = 10000) {
-        await timeout(_flush(), ms);
+        await (0, flush_1.flush)(ms);
     }
 }
 exports.ux = ux;
-ux.config = config_1.config;
-const action = ux.action;
+const { action, annotation, anykey, confirm, debug, done, flush, info, log, progress, prompt, styledHeader, styledJSON, styledObject, table, trace, tree, url, wait, } = ux;
 exports.action = action;
-const annotation = ux.annotation;
 exports.annotation = annotation;
-const anykey = ux.anykey;
 exports.anykey = anykey;
-const confirm = ux.confirm;
 exports.confirm = confirm;
-const debug = ux.debug;
 exports.debug = debug;
-const done = ux.done;
 exports.done = done;
-const error = Errors.error;
-exports.error = error;
-const exit = Errors.exit;
-exports.exit = exit;
-const flush = ux.flush;
 exports.flush = flush;
-const info = ux.info;
 exports.info = info;
-const log = ux.log;
 exports.log = log;
-const prideAction = ux.prideAction;
-exports.prideAction = prideAction;
-const progress = ux.progress;
 exports.progress = progress;
-const prompt = ux.prompt;
 exports.prompt = prompt;
-const styledHeader = ux.styledHeader;
 exports.styledHeader = styledHeader;
-const styledJSON = ux.styledJSON;
 exports.styledJSON = styledJSON;
-const styledObject = ux.styledObject;
 exports.styledObject = styledObject;
-const table = ux.table;
 exports.table = table;
-const trace = ux.trace;
 exports.trace = trace;
-const tree = ux.tree;
 exports.tree = tree;
-const url = ux.url;
 exports.url = url;
-const wait = ux.wait;
 exports.wait = wait;
-const warn = Errors.warn;
+const { error, exit, warn } = Errors;
+exports.error = error;
+exports.exit = exit;
 exports.warn = warn;
-const cliuxProcessExitHandler = async () => {
+const uxProcessExitHandler = async () => {
     try {
         await ux.done();
     }
@@ -180,7 +128,16 @@ const cliuxProcessExitHandler = async () => {
 };
 // to avoid MaxListenersExceededWarning
 // only attach named listener once
-const cliuxListener = process.listeners('exit').find(fn => fn.name === cliuxProcessExitHandler.name);
-if (!cliuxListener) {
-    process.once('exit', cliuxProcessExitHandler);
+const uxListener = process.listeners('exit').find((fn) => fn.name === uxProcessExitHandler.name);
+if (!uxListener) {
+    process.once('exit', uxProcessExitHandler);
 }
+var exit_1 = require("./exit");
+Object.defineProperty(exports, "ExitError", { enumerable: true, get: function () { return exit_1.ExitError; } });
+var styled_1 = require("./styled");
+Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return styled_1.Table; } });
+var base_1 = require("./action/base");
+Object.defineProperty(exports, "ActionBase", { enumerable: true, get: function () { return base_1.ActionBase; } });
+var config_2 = require("./config");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_2.config; } });
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_2.Config; } });

package/lib/cli-ux/list.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderList = void 0;
+const util_1 = require("../util/util");
 const screen_1 = require("../screen");
-const util_1 = require("../util");
 const wordwrap = require('wordwrap');
 function linewrap(length, s) {
     return wordwrap(length, screen_1.stdtermwidth, {
@@ -13,8 +13,8 @@ function renderList(items) {
     if (items.length === 0) {
         return '';
     }
-    const maxLength = (0, util_1.maxBy)(items, item => item[0].length)?.[0].length ?? 0;
-    const lines = items.map(i => {
+    const maxLength = (0, util_1.maxBy)(items, (item) => item[0].length)?.[0].length ?? 0;
+    const lines = items.map((i) => {
         let left = i[0];
         let right = i[1];
         if (!right) {

package/lib/cli-ux/prompt.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.anykey = exports.confirm = exports.prompt = void 0;
-const Errors = require("../errors");
+const tslib_1 = require("tslib");
+const Errors = tslib_1.__importStar(require("../errors"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 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) {
     if (retries < 0)
         throw new Error('no input');
@@ -22,7 +21,7 @@ function normal(options, retries = 100) {
         process.stdin.setEncoding('utf8');
         stream_1.stderr.write(options.prompt);
         process.stdin.resume();
-        process.stdin.once('data', b => {
+        process.stdin.once('data', (b) => {
             if (timer)
                 clearTimeout(timer);
             process.stdin.pause();
@@ -42,7 +41,7 @@ function getPrompt(name, type, defaultValue) {
         defaultValue = '*'.repeat(defaultValue.length);
     }
     if (name && defaultValue)
-        prompt = name + ' ' + chalk.yellow('[' + defaultValue + ']') + ': ';
+        prompt = name + ' ' + chalk_1.default.yellow('[' + defaultValue + ']') + ': ';
     else if (name)
         prompt = `${name}: `;
     return prompt;
@@ -58,8 +57,14 @@ async function single(options) {
     return response;
 }
 function replacePrompt(prompt) {
-    stream_1.stderr.write(ansiEscapes.cursorHide + ansiEscapes.cursorUp(1) + ansiEscapes.cursorLeft + prompt +
-        ansiEscapes.cursorDown(1) + ansiEscapes.cursorLeft + ansiEscapes.cursorShow);
+    const ansiEscapes = require('ansi-escapes');
+    stream_1.stderr.write(ansiEscapes.cursorHide +
+        ansiEscapes.cursorUp(1) +
+        ansiEscapes.cursorLeft +
+        prompt +
+        ansiEscapes.cursorDown(1) +
+        ansiEscapes.cursorLeft +
+        ansiEscapes.cursorShow);
 }
 async function _prompt(name, inputOptions = {}) {
     const prompt = getPrompt(name, inputOptions.type, inputOptions.default);
@@ -72,12 +77,15 @@ async function _prompt(name, inputOptions = {}) {
         default: '',
         ...inputOptions,
     };
+    const passwordPrompt = require('password-prompt');
     switch (options.type) {
-        case 'normal':
+        case 'normal': {
             return normal(options);
-        case 'single':
+        }
+        case 'single': {
             return single(options);
-        case 'mask':
+        }
+        case 'mask': {
             return passwordPrompt(options.prompt, {
                 method: options.type,
                 required: options.required,
@@ -86,14 +94,17 @@ async function _prompt(name, inputOptions = {}) {
                 replacePrompt(getPrompt(name, 'hide', inputOptions.default));
                 return value;
             });
-        case 'hide':
+        }
+        case 'hide': {
             return passwordPrompt(options.prompt, {
                 method: options.type,
                 required: options.required,
                 default: options.default,
             });
-        default:
+        }
+        default: {
             throw new Error(`unexpected type ${options.type}`);
+        }
     }
 }
 /**
@@ -103,9 +114,7 @@ async function _prompt(name, inputOptions = {}) {
  * @returns Promise<string>
  */
 async function prompt(name, options = {}) {
-    return config_1.default.action.pauseAsync(() => {
-        return _prompt(name, options);
-    }, chalk.cyan('?'));
+    return config_1.config.action.pauseAsync(() => _prompt(name, options), chalk_1.default.cyan('?'));
 }
 exports.prompt = prompt;
 /**
@@ -114,9 +123,10 @@ exports.prompt = prompt;
  * @returns Promise<boolean>
  */
 function confirm(message) {
-    return config_1.default.action.pauseAsync(async () => {
+    return config_1.config.action.pauseAsync(async () => {
         const confirm = async () => {
-            const response = (await _prompt(message)).toLowerCase();
+            const raw = await _prompt(message);
+            const response = raw.toLowerCase();
             if (['n', 'no'].includes(response))
                 return false;
             if (['y', 'yes'].includes(response))
@@ -124,7 +134,7 @@ function confirm(message) {
             return confirm();
         };
         return confirm();
-    }, chalk.cyan('?'));
+    }, chalk_1.default.cyan('?'));
 }
 exports.confirm = confirm;
 /**
@@ -135,9 +145,9 @@ exports.confirm = confirm;
 async function anykey(message) {
     const tty = Boolean(process.stdin.setRawMode);
     if (!message) {
-        message = tty ?
-            `Press any key to continue or ${chalk.yellow('q')} to exit` :
-            `Press enter to continue or ${chalk.yellow('q')} to exit`;
+        message = tty
+            ? `Press any key to continue or ${chalk_1.default.yellow('q')} to exit`
+            : `Press enter to continue or ${chalk_1.default.yellow('q')} to exit`;
     }
     const char = await prompt(message, { type: 'single', required: false });
     if (tty)

package/lib/cli-ux/stream.js

@@ -5,6 +5,7 @@ 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 {
+    channel;
     constructor(channel) {
         this.channel = channel;
     }

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

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

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

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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");
-exports.styledObject = object_1.default;
-const Table = require("./table");
-exports.Table = Table;
-const tree_1 = require("./tree");
-exports.tree = tree_1.default;
-const progress_1 = require("./progress");
-exports.progress = progress_1.default;
+exports.tree = exports.styledObject = exports.styledJSON = exports.progress = exports.Table = void 0;
+const tslib_1 = require("tslib");
+exports.Table = tslib_1.__importStar(require("./table"));
+var progress_1 = require("./progress");
+Object.defineProperty(exports, "progress", { enumerable: true, get: function () { return tslib_1.__importDefault(progress_1).default; } });
+var json_1 = require("./json");
+Object.defineProperty(exports, "styledJSON", { enumerable: true, get: function () { return tslib_1.__importDefault(json_1).default; } });
+var object_1 = require("./object");
+Object.defineProperty(exports, "styledObject", { enumerable: true, get: function () { return tslib_1.__importDefault(object_1).default; } });
+var tree_1 = require("./tree");
+Object.defineProperty(exports, "tree", { enumerable: true, get: function () { return tslib_1.__importDefault(tree_1).default; } });

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

@@ -1,15 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const index_1 = require("../../index");
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const node_util_1 = require("node:util");
+const stream_1 = require("../stream");
+const info = (output) => stream_1.stdout.write((0, node_util_1.format)(output) + '\n');
 function styledJSON(obj) {
     const json = JSON.stringify(obj, null, 2);
-    if (!chalk.level) {
-        index_1.ux.info(json);
+    if (!chalk_1.default.level) {
+        info(json);
         return;
     }
     const cardinal = require('cardinal');
     const theme = require('cardinal/themes/jq');
-    index_1.ux.info(cardinal.highlight(json, { json: true, theme }));
+    info(cardinal.highlight(json, { json: true, theme }));
 }
 exports.default = styledJSON;

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

@@ -1,25 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const util = require("util");
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const node_util_1 = require("node:util");
 function styledObject(obj, keys) {
     const output = [];
-    const keyLengths = Object.keys(obj).map(key => key.toString().length);
+    const keyLengths = Object.keys(obj).map((key) => key.toString().length);
     const maxKeyLength = Math.max(...keyLengths) + 2;
     function pp(obj) {
         if (typeof obj === 'string' || typeof obj === 'number')
             return obj;
         if (typeof obj === 'object') {
             return Object.keys(obj)
-                .map(k => k + ': ' + util.inspect(obj[k]))
+                .map((k) => k + ': ' + (0, node_util_1.inspect)(obj[k]))
                 .join(', ');
         }
-        return util.inspect(obj);
+        return (0, node_util_1.inspect)(obj);
     }
-    const logKeyValue = (key, value) => {
-        return `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + pp(value);
-    };
+    const logKeyValue = (key, value) => `${chalk_1.default.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + pp(value);
     for (const key of keys || Object.keys(obj).sort()) {
         const value = obj[key];
         if (Array.isArray(value)) {

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

@@ -5,11 +5,11 @@ export declare namespace table {
         columns: Interfaces.OptionFlag<string | undefined>;
         sort: Interfaces.OptionFlag<string | undefined>;
         filter: Interfaces.OptionFlag<string | undefined>;
-        csv: Interfaces.Flag<boolean>;
+        csv: Interfaces.BooleanFlag<boolean>;
         output: Interfaces.OptionFlag<string | undefined>;
-        extended: Interfaces.Flag<boolean>;
-        'no-truncate': Interfaces.Flag<boolean>;
-        'no-header': Interfaces.Flag<boolean>;
+        extended: Interfaces.BooleanFlag<boolean>;
+        'no-truncate': Interfaces.BooleanFlag<boolean>;
+        'no-header': Interfaces.BooleanFlag<boolean>;
     };
     type IFlags = typeof Flags;
     type ExcludeFlags<T, Z> = Pick<T, Exclude<keyof T, Z>>;