@oclif/core 3.26.4 → 4.0.0-beta.1

package/lib/cli-ux/index.js

@@ -1,183 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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.write = exports.colorize = 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.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 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;
-    static get action() {
-        return config_1.config.action;
-    }
-    static annotation(text, annotation) {
-        const supports = require('supports-hyperlinks');
-        if (supports.stdout) {
-            // \u001b]8;;https://google.com\u0007sometext\u001b]8;;\u0007
-            this.log(`\u001B]1337;AddAnnotation=${text.length}|${annotation}\u0007${text}`);
-        }
-        else {
-            this.log(text);
-        }
-    }
-    /**
-     * "press anykey to continue"
-     */
-    static get anykey() {
-        return uxPrompt.anykey;
-    }
-    static get confirm() {
-        return uxPrompt.confirm;
-    }
-    static debug(format, ...args) {
-        if (['debug', 'trace'].includes(this.config.outputLevel)) {
-            this.info((0, node_util_1.format)(format, ...args) + '\n');
-        }
-    }
-    static async done() {
-        config_1.config.action.stop();
-    }
-    static async flush(ms = 10_000) {
-        await (0, flush_1.flush)(ms);
-    }
-    static info(format, ...args) {
-        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;
-    }
-    static get prompt() {
-        return uxPrompt.prompt;
-    }
-    static styledHeader(header) {
-        this.info(chalk_1.default.dim('=== ') + chalk_1.default.bold(header) + '\n');
-    }
-    static styledJSON(obj) {
-        const json = JSON.stringify(obj, null, 2);
-        if (!chalk_1.default.level) {
-            this.info(json);
-            return;
-        }
-        const cardinal = require('cardinal');
-        const theme = require('cardinal/themes/jq');
-        this.info(cardinal.highlight(json, { json: true, theme }));
-    }
-    static styledObject(obj, keys) {
-        this.info(styled.styledObject(obj, keys));
-    }
-    static get table() {
-        return styled.Table.table;
-    }
-    static trace(format, ...args) {
-        if (this.config.outputLevel === 'trace') {
-            this.info((0, node_util_1.format)(format, ...args) + '\n');
-        }
-    }
-    static get tree() {
-        return styled.tree;
-    }
-    static url(text, uri, params = {}) {
-        const supports = require('supports-hyperlinks');
-        if (supports.stdout) {
-            this.log(hyperlinker(text, uri, params));
-        }
-        else {
-            this.log(uri);
-        }
-    }
-    static get wait() {
-        return wait_1.default;
-    }
-}
-exports.ux = 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;
-exports.confirm = confirm;
-exports.debug = debug;
-exports.done = done;
-exports.flush = flush;
-exports.info = info;
-exports.log = log;
-exports.logToStderr = logToStderr;
-exports.progress = progress;
-exports.prompt = prompt;
-exports.styledHeader = styledHeader;
-exports.styledJSON = styledJSON;
-exports.styledObject = styledObject;
-exports.table = table;
-exports.trace = trace;
-exports.tree = tree;
-exports.url = url;
-exports.wait = wait;
-const { error, exit, warn } = Errors;
-exports.error = error;
-exports.exit = exit;
-exports.warn = warn;
-const uxProcessExitHandler = async () => {
-    try {
-        await ux.done();
-    }
-    catch (error) {
-        console.error(error);
-        process.exitCode = 1;
-    }
-};
-// to avoid MaxListenersExceededWarning
-// only attach named listener once
-const uxListener = process.listeners('exit').find((fn) => fn.name === uxProcessExitHandler.name);
-if (!uxListener) {
-    process.once('exit', uxProcessExitHandler);
-}
-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; } });
-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 theme_1 = require("./theme");
-Object.defineProperty(exports, "colorize", { enumerable: true, get: function () { return theme_1.colorize; } });
-var write_2 = require("./write");
-Object.defineProperty(exports, "write", { enumerable: true, get: function () { return __importDefault(write_2).default; } });

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

@@ -1,32 +0,0 @@
-/**
- * @deprecated `ux` will be removed in the next major. See https://github.com/oclif/core/discussions/999
- */
-export interface IPromptOptions {
-    default?: string;
-    prompt?: string;
-    /**
-     * Requires user input if true, otherwise allows empty input
-     */
-    required?: boolean;
-    timeout?: number;
-    type?: 'hide' | 'mask' | 'normal' | 'single';
-}
-/**
- * prompt for input
- * @param name - prompt text
- * @param options - @see IPromptOptions
- * @returns Promise<string>
- */
-export declare function prompt(name: string, options?: IPromptOptions): Promise<string>;
-/**
- * confirmation prompt (yes/no)
- * @param message - confirmation text
- * @returns Promise<boolean>
- */
-export declare function confirm(message: string): Promise<boolean>;
-/**
- * "press anykey to continue"
- * @param message - optional message to display to user
- * @returns Promise<string>
- */
-export declare function anykey(message?: string): Promise<string>;

package/lib/cli-ux/prompt.js

@@ -1,185 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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.anykey = exports.confirm = exports.prompt = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const Errors = __importStar(require("../errors"));
-const config_1 = require("./config");
-function normal(options, retries = 100) {
-    if (retries < 0)
-        throw new Error('no input');
-    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();
-            if (!options.default && options.required && data === '') {
-                resolve(normal(options, retries - 1));
-            }
-            else {
-                resolve(data || options.default);
-            }
-        });
-    });
-}
-function getPrompt(name, type, defaultValue) {
-    let prompt = '> ';
-    if (defaultValue && type === 'hide') {
-        defaultValue = '*'.repeat(defaultValue.length);
-    }
-    if (name && defaultValue)
-        prompt = name + ' ' + chalk_1.default.yellow('[' + defaultValue + ']') + ': ';
-    else if (name)
-        prompt = `${name}: `;
-    return prompt;
-}
-async function single(options) {
-    const raw = process.stdin.isRaw;
-    if (process.stdin.setRawMode)
-        process.stdin.setRawMode(true);
-    options.required = options.required ?? false;
-    const response = await normal(options);
-    if (process.stdin.setRawMode)
-        process.stdin.setRawMode(Boolean(raw));
-    return response;
-}
-function replacePrompt(prompt) {
-    const ansiEscapes = require('ansi-escapes');
-    process.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);
-    const options = {
-        default: '',
-        isTTY: Boolean(process.env.TERM !== 'dumb' && process.stdin.isTTY),
-        name,
-        prompt,
-        required: true,
-        type: 'normal',
-        ...inputOptions,
-    };
-    const passwordPrompt = require('password-prompt');
-    switch (options.type) {
-        case 'normal': {
-            return normal(options);
-        }
-        case 'single': {
-            return single(options);
-        }
-        case 'mask': {
-            return passwordPrompt(options.prompt, {
-                default: options.default,
-                method: options.type,
-                required: options.required,
-            }).then((value) => {
-                replacePrompt(getPrompt(name, 'hide', inputOptions.default));
-                return value;
-            });
-        }
-        case 'hide': {
-            return passwordPrompt(options.prompt, {
-                default: options.default,
-                method: options.type,
-                required: options.required,
-            });
-        }
-        default: {
-            throw new Error(`unexpected type ${options.type}`);
-        }
-    }
-}
-/**
- * prompt for input
- * @param name - prompt text
- * @param options - @see IPromptOptions
- * @returns Promise<string>
- */
-async function prompt(name, options = {}) {
-    return config_1.config.action.pauseAsync(() => _prompt(name, options), chalk_1.default.cyan('?'));
-}
-exports.prompt = prompt;
-/**
- * confirmation prompt (yes/no)
- * @param message - confirmation text
- * @returns Promise<boolean>
- */
-function confirm(message) {
-    return config_1.config.action.pauseAsync(async () => {
-        const confirm = async () => {
-            const raw = await _prompt(message);
-            const response = raw.toLowerCase();
-            if (['n', 'no'].includes(response))
-                return false;
-            if (['y', 'yes'].includes(response))
-                return true;
-            return confirm();
-        };
-        return confirm();
-    }, chalk_1.default.cyan('?'));
-}
-exports.confirm = confirm;
-/**
- * "press anykey to continue"
- * @param message - optional message to display to user
- * @returns Promise<string>
- */
-async function anykey(message) {
-    const tty = Boolean(process.stdin.setRawMode);
-    if (!message) {
-        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, { required: false, type: 'single' });
-    if (tty)
-        process.stderr.write('\n');
-    if (char === 'q')
-        Errors.error('quit');
-    if (char === '\u0003')
-        Errors.error('ctrl-c');
-    return char;
-}
-exports.anykey = anykey;

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

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

@@ -1,43 +0,0 @@
-"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 {
-    channel;
-    constructor(channel) {
-        this.channel = channel;
-    }
-    get isTTY() {
-        return process[this.channel].isTTY;
-    }
-    emit(event, ...args) {
-        return process[this.channel].emit(event, ...args);
-    }
-    getWindowSize() {
-        return process[this.channel].getWindowSize();
-    }
-    on(event, listener) {
-        process[this.channel].on(event, listener);
-        return this;
-    }
-    once(event, listener) {
-        process[this.channel].once(event, listener);
-        return this;
-    }
-    read() {
-        return process[this.channel].read();
-    }
-    write(data) {
-        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/styled/index.d.ts

@@ -1,4 +0,0 @@
-export { default as styledObject } from './object';
-export { default as progress } from './progress';
-export * as Table from './table';
-export { default as tree } from './tree';

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

@@ -1,36 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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.tree = exports.Table = exports.progress = exports.styledObject = void 0;
-var object_1 = require("./object");
-Object.defineProperty(exports, "styledObject", { enumerable: true, get: function () { return __importDefault(object_1).default; } });
-var progress_1 = require("./progress");
-Object.defineProperty(exports, "progress", { enumerable: true, get: function () { return __importDefault(progress_1).default; } });
-exports.Table = __importStar(require("./table"));
-var tree_1 = require("./tree");
-Object.defineProperty(exports, "tree", { enumerable: true, get: function () { return __importDefault(tree_1).default; } });

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

@@ -1 +0,0 @@
-export default function styledObject(obj: any, keys?: string[]): string;

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

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_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 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 + ': ' + (0, node_util_1.inspect)(obj[k]))
-                .join(', ');
-        }
-        return (0, node_util_1.inspect)(obj);
-    }
-    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)) {
-            if (value.length > 0) {
-                output.push(logKeyValue(key, value[0]));
-                for (const e of value.slice(1)) {
-                    output.push(' '.repeat(maxKeyLength) + pp(e));
-                }
-            }
-        }
-        else if (value !== null && value !== undefined) {
-            output.push(logKeyValue(key, value));
-        }
-    }
-    return output.join('\n');
-}
-exports.default = styledObject;

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

@@ -1,2 +0,0 @@
-import { Options, SingleBar } from 'cli-progress';
-export default function progress(options?: Options): SingleBar;

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

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// 3pp
-const cli_progress_1 = require("cli-progress");
-function progress(options = {}) {
-    return new cli_progress_1.SingleBar({ noTTYOutput: Boolean(process.env.TERM === 'dumb' || !process.stdin.isTTY), ...options });
-}
-exports.default = progress;

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

@@ -1,45 +0,0 @@
-import * as Interfaces from '../../interfaces';
-export declare function table<T extends Record<string, unknown>>(data: T[], columns: table.Columns<T>, options?: table.Options): void;
-export declare namespace table {
-    export const Flags: {
-        columns: Interfaces.OptionFlag<string | undefined>;
-        csv: Interfaces.BooleanFlag<boolean>;
-        extended: Interfaces.BooleanFlag<boolean>;
-        filter: Interfaces.OptionFlag<string | undefined>;
-        'no-header': Interfaces.BooleanFlag<boolean>;
-        'no-truncate': Interfaces.BooleanFlag<boolean>;
-        output: Interfaces.OptionFlag<string | undefined>;
-        sort: Interfaces.OptionFlag<string | undefined>;
-    };
-    type IFlags = typeof Flags;
-    type ExcludeFlags<T, Z> = Pick<T, Exclude<keyof T, Z>>;
-    type IncludeFlags<T, K extends keyof T> = Pick<T, K>;
-    export function flags(): IFlags;
-    export function flags<Z extends keyof IFlags = keyof IFlags>(opts: {
-        except: Z | Z[];
-    }): ExcludeFlags<IFlags, Z>;
-    export function flags<K extends keyof IFlags = keyof IFlags>(opts: {
-        only: K | K[];
-    }): IncludeFlags<IFlags, K>;
-    export interface Column<T extends Record<string, unknown>> {
-        extended: boolean;
-        get(row: T): any;
-        header: string;
-        minWidth: number;
-    }
-    export type Columns<T extends Record<string, unknown>> = {
-        [key: string]: Partial<Column<T>>;
-    };
-    export interface Options {
-        [key: string]: any;
-        columns?: string;
-        extended?: boolean;
-        filter?: string;
-        'no-header'?: boolean;
-        'no-truncate'?: boolean;
-        output?: string;
-        printLine?(s: any): any;
-        sort?: string;
-    }
-    export {};
-}