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

package/README.md

@@ -11,7 +11,11 @@ base library for oclif CLIs
 Migrating
 =====
 
-See the [migration guide](./MIGRATION.md) for an overview of breaking changes that occurred between v1 and v2.
+See the [v3 migration guide](./guides/V3_MIGRATION.md) for an overview of breaking changes that occurred between v2 and v3.
+
+See the [v2 migration guide](./guides/V2_MIGRATION.md) for an overview of breaking changes that occurred between v1 and v2.
+
+Migrating from `@oclif/config` and `@oclif/command`? See the [v1 migration guide](./guides/PRE_CORE_MIGRATION.md).
 
 CLI UX
 =====
@@ -28,7 +32,7 @@ You can, however, use `@oclif/core` in a standalone script like this:
 #!/usr/bin/env ts-node
 
 import * as fs from 'fs'
-import {Command, Flags} from '@oclif/core'
+import {Command, Flags, flush, handle} from '@oclif/core'
 
 class LS extends Command {
   static description = 'List the files in a directory.'
@@ -50,10 +54,10 @@ class LS extends Command {
   }
 }
 
-LS.run().then(() => {
-  require('@oclif/core/flush')
-}, () => {
-  require('@oclif/core/handle')
+LS.run().then(async () => {
+  await flush()
+}, async (err) => {
+  await handle(err)
 })
 ```
 

package/flush.js

@@ -1 +1 @@
-module.exports = require('./lib').flush
+module.exports = require('./lib/cli-ux/flush').flush

package/handle.js

@@ -1 +1 @@
-module.exports = error => require('./lib/errors/handle').handle(error)
+module.exports = async error => require('./lib/errors/handle').handle(error)

package/lib/args.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { URL } from 'url';
 import { Arg, ArgDefinition } from './interfaces/parser';
+import { URL } from 'node:url';
 /**
  * Create a custom arg.
  *

package/lib/args.js

@@ -1,25 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.string = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = exports.custom = void 0;
-const url_1 = require("url");
-const util_1 = require("./util");
+const fs_1 = require("./util/fs");
+const node_url_1 = require("node:url");
+const util_1 = require("./util/util");
 function custom(defaults) {
-    return (options = {}) => {
-        return {
-            parse: async (i, _context, _opts) => i,
-            ...defaults,
-            ...options,
-            input: [],
-            type: 'option',
-        };
-    };
+    return (options = {}) => ({
+        parse: async (i, _context, _opts) => i,
+        ...defaults,
+        ...options,
+        input: [],
+        type: 'option',
+    });
 }
 exports.custom = custom;
 exports.boolean = custom({
     parse: async (b) => Boolean(b) && (0, util_1.isNotFalsy)(b),
 });
 exports.integer = custom({
-    parse: async (input, _, opts) => {
+    async parse(input, _, opts) {
         if (!/^-?\d+$/.test(input))
             throw new Error(`Expected an integer but received: ${input}`);
         const num = Number.parseInt(input, 10);
@@ -31,16 +30,16 @@ exports.integer = custom({
     },
 });
 exports.directory = custom({
-    parse: async (input, _, opts) => {
+    async parse(input, _, opts) {
         if (opts.exists)
-            return (0, util_1.dirExists)(input);
+            return (0, fs_1.dirExists)(input);
         return input;
     },
 });
 exports.file = custom({
-    parse: async (input, _, opts) => {
+    async parse(input, _, opts) {
         if (opts.exists)
-            return (0, util_1.fileExists)(input);
+            return (0, fs_1.fileExists)(input);
         return input;
     },
 });
@@ -49,9 +48,9 @@ exports.file = custom({
  * if the string is not a valid URL.
  */
 exports.url = custom({
-    parse: async (input) => {
+    async parse(input) {
         try {
-            return new url_1.URL(input);
+            return new node_url_1.URL(input);
         }
         catch {
             throw new Error(`Expected a valid url but received: ${input}`);

package/lib/cli-ux/action/base.d.ts

@@ -1,12 +1,10 @@
+import { Options } from './types';
 export interface ITask {
     action: string;
     status: string | undefined;
     active: boolean;
 }
 export type ActionType = 'spinner' | 'simple' | 'debug';
-export interface Options {
-    stdout?: boolean;
-}
 export declare class ActionBase {
     type: ActionType;
     std: 'stdout' | 'stderr';
@@ -22,9 +20,9 @@ export declare class ActionBase {
     get running(): boolean;
     get status(): string | undefined;
     set status(status: string | undefined);
-    pauseAsync<T extends any>(fn: () => Promise<T>, icon?: string): Promise<T>;
+    pauseAsync<T>(fn: () => Promise<T>, icon?: string): Promise<T>;
     pause(fn: () => any, icon?: string): Promise<any>;
-    protected _start(): void;
+    protected _start(_opts: Options): void;
     protected _stop(_: string): void;
     protected _resume(): void;
     protected _pause(_?: string): void;

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

@@ -1,27 +1,27 @@
 "use strict";
 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");
+const util_1 = require("../../util/util");
+const node_util_1 = require("node:util");
 class ActionBase {
-    constructor() {
-        this.std = 'stderr';
-        this.stdmockOrigs = {
-            stdout: stream_1.stdout.write,
-            stderr: stream_1.stderr.write,
-        };
-    }
+    type;
+    std = 'stderr';
+    stdmocks;
+    stdmockOrigs = {
+        stdout: stream_1.stdout.write,
+        stderr: stream_1.stderr.write,
+    };
     start(action, status, opts = {}) {
         this.std = opts.stdout ? 'stdout' : 'stderr';
         const task = { action, status, active: Boolean(this.task && this.task.active) };
         this.task = task;
-        this._start();
+        this._start(opts);
         task.active = true;
         this._stdout(true);
     }
     stop(msg = 'done') {
-        const task = this.task;
+        const { task } = this;
         if (!task) {
             return;
         }
@@ -31,8 +31,9 @@ class ActionBase {
         this._stdout(false);
     }
     get globals() {
-        global['cli-ux'] = global['cli-ux'] || {};
-        const globals = global['cli-ux'];
+        ;
+        global.ux = global.ux || {};
+        const globals = global.ux;
         globals.action = globals.action || {};
         return globals;
     }
@@ -55,7 +56,7 @@ class ActionBase {
         return this.task ? this.task.status : undefined;
     }
     set status(status) {
-        const task = this.task;
+        const { task } = this;
         if (!task) {
             return;
         }
@@ -66,7 +67,7 @@ class ActionBase {
         task.status = status;
     }
     async pauseAsync(fn, icon) {
-        const task = this.task;
+        const { task } = this;
         const active = task && task.active;
         if (task && active) {
             this._pause(icon);
@@ -80,7 +81,7 @@ class ActionBase {
         return ret;
     }
     pause(fn, icon) {
-        const task = this.task;
+        const { task } = this;
         const active = task && task.active;
         if (task && active) {
             this._pause(icon);
@@ -93,7 +94,7 @@ class ActionBase {
         }
         return ret;
     }
-    _start() {
+    _start(_opts) {
         throw new Error('not implemented');
     }
     _stop(_) {
@@ -106,7 +107,9 @@ class ActionBase {
     _pause(_) {
         throw new Error('not implemented');
     }
-    _updateStatus(_, __) { }
+    _updateStatus(_, __) {
+        // Not implemented
+    }
     // mock out stdout/stderr so it doesn't screw up the rendering
     _stdout(toggle) {
         try {
@@ -137,7 +140,7 @@ class ActionBase {
             }
         }
         catch (error) {
-            this._write('stderr', (0, util_1.inspect)(error));
+            this._write('stderr', (0, node_util_1.inspect)(error));
         }
     }
     // flush mocked stdout/stderr
@@ -153,25 +156,28 @@ class ActionBase {
             }
             // add newline if there isn't one already
             // otherwise we'll just overwrite it when we render
-            if (output && std && output[output.length - 1] !== '\n') {
+            if (output && std && output.at(-1) !== '\n') {
                 this._write(std, '\n');
             }
         }
         catch (error) {
-            this._write('stderr', (0, util_1.inspect)(error));
+            this._write('stderr', (0, node_util_1.inspect)(error));
         }
     }
     // write to the real stdout/stderr
     _write(std, s) {
         switch (std) {
-            case 'stdout':
-                this.stdmockOrigs.stdout.apply(stream_1.stdout, (0, util_2.castArray)(s));
+            case 'stdout': {
+                this.stdmockOrigs.stdout.apply(stream_1.stdout, (0, util_1.castArray)(s));
                 break;
-            case 'stderr':
-                this.stdmockOrigs.stderr.apply(stream_1.stderr, (0, util_2.castArray)(s));
+            }
+            case 'stderr': {
+                this.stdmockOrigs.stderr.apply(stream_1.stderr, (0, util_1.castArray)(s));
                 break;
-            default:
+            }
+            default: {
                 throw new Error(`invalid std: ${std}`);
+            }
         }
     }
 }

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

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("./base");
 class SimpleAction extends base_1.ActionBase {
-    constructor() {
-        super(...arguments);
-        this.type = 'simple';
-    }
+    type = 'simple';
     _start() {
-        const task = this.task;
-        if (!task)
+        if (!this.task)
             return;
-        this._render(task.action, task.status);
+        this._render(this.task.action, this.task.status);
     }
     _pause(icon) {
         if (icon)
@@ -18,29 +14,28 @@ class SimpleAction extends base_1.ActionBase {
         else
             this._flush();
     }
-    _resume() { }
+    _resume() {
+        // Not implemented
+    }
     _updateStatus(status, prevStatus, newline = false) {
-        const task = this.task;
-        if (!task)
+        if (!this.task)
             return;
-        if (task.active && !prevStatus)
+        if (this.task.active && !prevStatus)
             this._write(this.std, ` ${status}`);
         else
-            this._write(this.std, `${task.action}... ${status}`);
+            this._write(this.std, `${this.task.action}... ${status}`);
         if (newline || !prevStatus)
             this._flush();
     }
     _stop(status) {
-        const task = this.task;
-        if (!task)
+        if (!this.task)
             return;
-        this._updateStatus(status, task.status, true);
+        this._updateStatus(status, this.task.status, true);
     }
     _render(action, status) {
-        const task = this.task;
-        if (!task)
+        if (!this.task)
             return;
-        if (task.active)
+        if (this.task.active)
             this._flush();
         this._write(this.std, status ? `${action}... ${status}` : `${action}...`);
     }

package/lib/cli-ux/action/spinner.d.ts

@@ -1,15 +1,17 @@
 /// <reference types="node" />
 import { ActionBase, ActionType } from './base';
+import { Options } from './types';
 export default class SpinnerAction extends ActionBase {
     type: ActionType;
     spinner?: NodeJS.Timeout;
-    frames: any;
+    frames: string[];
     frameIndex: number;
     constructor();
-    protected _start(): void;
+    protected _start(opts: Options): void;
     protected _stop(status: string): void;
     protected _pause(icon?: string): void;
     protected _frame(): string;
+    private getFrames;
     private _render;
     private _reset;
     private _lines;

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

@@ -1,32 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const supportsColor = require("supports-color");
-const stripAnsi = require('strip-ansi');
-const ansiStyles = require('ansi-styles');
-const ansiEscapes = require('ansi-escapes');
-const screen_1 = require("../../screen");
-const spinners_1 = require("./spinners");
+const tslib_1 = require("tslib");
+const supportsColor = tslib_1.__importStar(require("supports-color"));
 const base_1 = require("./base");
+const ansi_styles_1 = tslib_1.__importDefault(require("ansi-styles"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const screen_1 = require("../../screen");
+const spinners_1 = tslib_1.__importDefault(require("./spinners"));
+const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
+const ansiEscapes = require('ansi-escapes');
 function color(s) {
     if (!supportsColor)
         return s;
     const has256 = supportsColor.stdout ? supportsColor.stdout.has256 : (process.env.TERM || '').includes('256');
-    return has256 ? `\u001B[38;5;104m${s}${ansiStyles.reset.open}` : chalk.magenta(s);
+    return has256 ? `\u001B[38;5;104m${s}${ansi_styles_1.default.reset.open}` : chalk_1.default.magenta(s);
 }
 class SpinnerAction extends base_1.ActionBase {
+    type = 'spinner';
+    spinner;
+    frames;
+    frameIndex;
     constructor() {
         super();
-        this.type = 'spinner';
-        this.frames = spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
+        this.frames = this.getFrames();
         this.frameIndex = 0;
     }
-    _start() {
+    _start(opts) {
+        if (opts.style)
+            this.frames = this.getFrames(opts);
         this._reset();
         if (this.spinner)
             clearInterval(this.spinner);
         this._render();
-        this.spinner = setInterval(icon => this._render.bind(this)(icon), process.platform === 'win32' ? 500 : 100, 'spinner');
+        this.spinner = setInterval((icon) => this._render.bind(this)(icon), process.platform === 'win32' ? 500 : 100, 'spinner');
         const interval = this.spinner;
         interval.unref();
     }
@@ -51,15 +57,19 @@ class SpinnerAction extends base_1.ActionBase {
         this.frameIndex = ++this.frameIndex % this.frames.length;
         return color(frame);
     }
+    getFrames(opts) {
+        if (opts?.style)
+            return spinners_1.default[opts.style].frames;
+        return spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
+    }
     _render(icon) {
-        const task = this.task;
-        if (!task)
+        if (!this.task)
             return;
         this._reset();
         this._flushStdout();
         const frame = icon === 'spinner' ? ` ${this._frame()}` : icon || '';
-        const status = task.status ? ` ${task.status}` : '';
-        this.output = `${task.action}...${frame}${status}\n`;
+        const status = this.task.status ? ` ${this.task.status}` : '';
+        this.output = `${this.task.action}...${frame}${status}\n`;
         this._write(this.std, this.output);
     }
     _reset() {
@@ -70,9 +80,7 @@ class SpinnerAction extends base_1.ActionBase {
         this.output = undefined;
     }
     _lines(s) {
-        return stripAnsi(s).split('\n')
-            .map(l => Math.ceil(l.length / screen_1.errtermwidth))
-            .reduce((c, i) => c + i, 0);
+        return (0, strip_ansi_1.default)(s).split('\n').map((l) => Math.ceil(l.length / screen_1.errtermwidth)).reduce((c, i) => c + i, 0);
     }
 }
 exports.default = SpinnerAction;

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

@@ -159,7 +159,7 @@ exports.default = {
     },
     flip: {
         interval: 70,
-        frames: ['_', '_', '_', '-', '`', '`', '\'', '´', '-', '_', '_', '_'],
+        frames: ['_', '_', '_', '-', '`', '`', "'", '´', '-', '_', '_', '_'],
     },
     hamburger: {
         interval: 100,

package/lib/cli-ux/action/types.d.ts

@@ -0,0 +1,5 @@
+import spinners from './spinners';
+export type Options = {
+    stdout?: boolean;
+    style?: keyof typeof spinners;
+};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -8,7 +8,6 @@ export interface ConfigMessage {
 export declare class Config {
     outputLevel: Levels;
     action: ActionBase;
-    prideAction: ActionBase;
     errorsHandled: boolean;
     showStackTrace: boolean;
     get debug(): boolean;

package/lib/cli-ux/config.js

@@ -1,28 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = exports.Config = void 0;
-const semver = require("semver");
-const util_1 = require("../util");
-const spinner_1 = require("./action/spinner");
-const spinner_2 = require("./action/spinner");
-const pride_spinner_1 = require("./action/pride-spinner");
-const version = semver.parse((0, util_1.requireJson)(__dirname, '..', '..', 'package.json').version);
+const tslib_1 = require("tslib");
+const fs_1 = require("../util/fs");
+const simple_1 = tslib_1.__importDefault(require("./action/simple"));
+const spinner_1 = tslib_1.__importDefault(require("./action/spinner"));
 const g = global;
-const globals = g['cli-ux'] || (g['cli-ux'] = {});
+const globals = g.ux || (g.ux = {});
 const actionType = (Boolean(process.stderr.isTTY) &&
     !process.env.CI &&
     !['dumb', 'emacs-color'].includes(process.env.TERM) &&
-    'spinner') || 'simple';
-const Action = actionType === 'spinner' ? spinner_1.default : spinner_2.default;
-const PrideAction = actionType === 'spinner' ? pride_spinner_1.default : spinner_2.default;
+    'spinner') ||
+    'simple';
+const Action = actionType === 'spinner' ? spinner_1.default : simple_1.default;
 class Config {
-    constructor() {
-        this.outputLevel = 'info';
-        this.action = new Action();
-        this.prideAction = new PrideAction();
-        this.errorsHandled = false;
-        this.showStackTrace = true;
-    }
+    outputLevel = 'info';
+    action = new Action();
+    errorsHandled = false;
+    showStackTrace = true;
     get debug() {
         return globals.debug || process.env.DEBUG === '*';
     }
@@ -38,10 +33,11 @@ class Config {
 }
 exports.Config = Config;
 function fetch() {
-    if (globals[version.major])
-        return globals[version.major];
-    globals[version.major] = new Config();
-    return globals[version.major];
+    const major = (0, fs_1.requireJson)(__dirname, '..', '..', 'package.json').version.split('.')[0];
+    if (globals[major])
+        return globals[major];
+    globals[major] = new Config();
+    return globals[major];
 }
 exports.config = fetch();
 exports.default = exports.config;

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

@@ -1,5 +1,5 @@
 export declare class ExitError extends Error {
-    'cli-ux': {
+    ux: {
         exit: number;
     };
     code: 'EEXIT';

package/lib/cli-ux/exit.js

@@ -2,11 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExitError = void 0;
 class ExitError extends Error {
+    ux;
+    code;
+    error;
     constructor(status, error) {
         const code = 'EEXIT';
         super(error ? error.message : `${code}: ${status}`);
         this.error = error;
-        this['cli-ux'] = { exit: status };
+        this.ux = { exit: status };
         this.code = code;
     }
 }

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

@@ -0,0 +1 @@
+export declare function flush(ms?: number): Promise<void>;

package/lib/cli-ux/flush.js

@@ -0,0 +1,28 @@
+"use strict";
+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) => {
+            const t = setTimeout(() => resolve(null), ms);
+            if (unref)
+                t.unref();
+        });
+    }
+    return Promise.race([p, wait(ms, true).then(() => (0, errors_1.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;
+    return p;
+}
+async function flush(ms = 10000) {
+    await timeout(_flush(), ms);
+}
+exports.flush = flush;

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

@@ -1,11 +1,8 @@
 import * as Errors from '../errors';
-import { ActionBase } from './action/base';
-import { config, Config } from './config';
-import { ExitError } from './exit';
-import { IPromptOptions } from './prompt';
 import * as styled from './styled';
-import { Table } from './styled';
 import * as uxPrompt from './prompt';
+import { Config } from './config';
+import { ActionBase } from './action/base';
 import uxWait from './wait';
 export declare class ux {
     static config: Config;
@@ -16,7 +13,6 @@ export declare class ux {
     static get anykey(): typeof uxPrompt.anykey;
     static get confirm(): typeof uxPrompt.confirm;
     static get action(): ActionBase;
-    static get prideAction(): ActionBase;
     static styledObject(obj: any, keys?: string[]): void;
     static styledHeader(header: string): void;
     static get styledJSON(): typeof styled.styledJSON;
@@ -33,27 +29,11 @@ export declare class ux {
     static annotation(text: string, annotation: string): void;
     static flush(ms?: number): Promise<void>;
 }
-declare const action: ActionBase;
-declare const annotation: typeof ux.annotation;
-declare const anykey: typeof uxPrompt.anykey;
-declare const confirm: typeof uxPrompt.confirm;
-declare const debug: typeof ux.debug;
-declare const done: typeof ux.done;
-declare const error: typeof Errors.error;
-declare const exit: typeof Errors.exit;
-declare const flush: typeof ux.flush;
-declare const info: typeof ux.info;
-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 ux.styledHeader;
-declare const styledJSON: typeof styled.styledJSON;
-declare const styledObject: typeof ux.styledObject;
-declare const table: typeof styled.Table.table;
-declare const trace: typeof ux.trace;
-declare const tree: typeof styled.tree;
-declare const url: typeof ux.url;
-declare const wait: (ms?: number) => Promise<void>;
-declare const warn: typeof Errors.warn;
-export { action, ActionBase, annotation, anykey, config, Config, confirm, debug, done, error, exit, ExitError, flush, info, IPromptOptions, log, prideAction, progress, prompt, styledHeader, styledJSON, styledObject, table, Table, trace, tree, url, wait, warn, };
+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 styled.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 { ExitError } from './exit';
+export { IPromptOptions } from './prompt';
+export { Table } from './styled';
+export { ActionBase } from './action/base';
+export { config, Config } from './config';