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

package/lib/{cli-ux → 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 → ux}/exit.js

@@ -6,7 +6,7 @@ class ExitError extends 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/ux/flush.d.ts

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

package/lib/ux/flush.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+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(() => __1.Errors.error('timed out'))]);
+}
+async function _flush() {
+    const p = new Promise(resolve => {
+        __1.stdout.once('drain', () => resolve(null));
+    });
+    const flushed = __1.stdout.write('');
+    if (flushed) {
+        return Promise.resolve();
+    }
+    return p;
+}
+async function flush(ms = 10000) {
+    await timeout(_flush(), ms);
+}
+exports.default = flush;

package/lib/{cli-ux → ux}/index.d.ts

@@ -1,4 +1,3 @@
-import * as Errors from '../errors';
 import { ActionBase } from './action/base';
 import { config, Config } from './config';
 import { ExitError } from './exit';
@@ -7,7 +6,7 @@ import * as styled from './styled';
 import { Table } from './styled';
 import * as uxPrompt from './prompt';
 import uxWait from './wait';
-export declare class ux {
+export default class ux {
     static config: Config;
     static get prompt(): typeof uxPrompt.prompt;
     /**
@@ -16,7 +15,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;
@@ -32,28 +30,11 @@ export declare class ux {
     static url(text: string, uri: string, params?: {}): void;
     static annotation(text: string, annotation: string): void;
     static flush(ms?: number): Promise<void>;
+    static error(err: Error | string, options?: {
+        code?: string;
+        exit?: number;
+    }): never;
+    static exit(code?: number): never;
+    static warn(err: Error | string): 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, };
+export { ActionBase, config, Config, ExitError, IPromptOptions, Table, };

package/lib/{cli-ux → ux}/index.js

@@ -1,6 +1,6 @@
 "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;
+exports.Table = exports.ExitError = exports.Config = exports.config = exports.ActionBase = void 0;
 const Errors = require("../errors");
 const util = require("util");
 const chalk = require("chalk");
@@ -17,27 +17,8 @@ Object.defineProperty(exports, "Table", { enumerable: true, get: function () { r
 const uxPrompt = require("./prompt");
 const wait_1 = require("./wait");
 const stream_1 = require("./stream");
+const flush_1 = require("./flush");
 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 get prompt() {
         return uxPrompt.prompt;
@@ -54,15 +35,12 @@ 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));
+        this.log(styled.styledObject(obj, keys));
     }
     static styledHeader(header) {
-        this.info(chalk.dim('=== ') + chalk.bold(header) + '\n');
+        this.log(chalk.dim('=== ') + chalk.bold(header) + '\n');
     }
     static get styledJSON() {
         return styled.styledJSON;
@@ -83,12 +61,12 @@ class ux {
         config_1.config.action.stop();
     }
     static trace(format, ...args) {
-        if (this.config.outputLevel === 'trace') {
+        if (ux.config.outputLevel === 'trace') {
             stream_1.stdout.write(util.format(format, ...args) + '\n');
         }
     }
     static debug(format, ...args) {
-        if (['trace', 'debug'].includes(this.config.outputLevel)) {
+        if (['trace', 'debug'].includes(ux.config.outputLevel)) {
             stream_1.stdout.write(util.format(format, ...args) + '\n');
         }
     }
@@ -118,58 +96,21 @@ class ux {
         }
     }
     static async flush(ms = 10000) {
-        await timeout(_flush(), ms);
+        await (0, flush_1.default)(ms);
+    }
+    static error(err, options = {}) {
+        throw Errors.error(err, options);
+    }
+    static exit(code = 0) {
+        throw Errors.exit(code);
+    }
+    static warn(err) {
+        Errors.warn(err);
     }
 }
-exports.ux = ux;
+exports.default = ux;
 ux.config = config_1.config;
-const action = ux.action;
-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;
-exports.warn = warn;
-const cliuxProcessExitHandler = async () => {
+const uxProcessExitHandler = async () => {
     try {
         await ux.done();
     }
@@ -180,7 +121,7 @@ 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);
 }

package/lib/{cli-ux → ux}/prompt.js

@@ -5,8 +5,6 @@ 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) {
     if (retries < 0)
         throw new Error('no input');
@@ -58,6 +56,7 @@ async function single(options) {
     return response;
 }
 function replacePrompt(prompt) {
+    const ansiEscapes = require('ansi-escapes');
     stream_1.stderr.write(ansiEscapes.cursorHide + ansiEscapes.cursorUp(1) + ansiEscapes.cursorLeft + prompt +
         ansiEscapes.cursorDown(1) + ansiEscapes.cursorLeft + ansiEscapes.cursorShow);
 }
@@ -72,6 +71,7 @@ async function _prompt(name, inputOptions = {}) {
         default: '',
         ...inputOptions,
     };
+    const passwordPrompt = require('password-prompt');
     switch (options.type) {
         case 'normal':
             return normal(options);

package/lib/{cli-ux → ux}/styled/json.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk = require("chalk");
-const index_1 = require("../../index");
+const index_1 = require("../index");
 function styledJSON(obj) {
     const json = JSON.stringify(obj, null, 2);
     if (!chalk.level) {
-        index_1.ux.info(json);
+        index_1.default.info(json);
         return;
     }
     const cardinal = require('cardinal');
     const theme = require('cardinal/themes/jq');
-    index_1.ux.info(cardinal.highlight(json, { json: true, theme }));
+    index_1.default.info(cardinal.highlight(json, { json: true, theme }));
 }
 exports.default = styledJSON;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -14,7 +14,6 @@
     "cli-progress": "^3.12.0",
     "debug": "^4.3.4",
     "ejs": "^3.1.8",
-    "fs-extra": "^9.1.0",
     "get-package-type": "^0.1.0",
     "globby": "^11.1.0",
     "hyperlinker": "^1.0.0",
@@ -24,7 +23,6 @@
     "natural-orderby": "^2.0.3",
     "object-treeify": "^1.1.33",
     "password-prompt": "^1.1.2",
-    "semver": "^7.5.3",
     "slice-ansi": "^4.0.0",
     "string-width": "^4.2.3",
     "strip-ansi": "^6.0.1",
@@ -39,15 +37,15 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^12.1.4",
     "@oclif/plugin-help": "^5.2.8",
-    "@oclif/plugin-plugins": "^2.4.7",
-    "@oclif/test": "^2.3.15",
+    "@oclif/plugin-plugins": "^3.3.0",
+    "@oclif/test": "^2.4.7",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.2",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/clean-stack": "^2.1.1",
     "@types/ejs": "^3.1.2",
-    "@types/fs-extra": "^9.0.13",
+    "@types/glob": "^8.1.0",
     "@types/indent-string": "^4.0.1",
     "@types/js-yaml": "^3.12.7",
     "@types/mocha": "^8.2.3",
@@ -55,8 +53,7 @@
     "@types/node": "^16",
     "@types/node-notifier": "^8.0.2",
     "@types/proxyquire": "^1.3.28",
-    "@types/semver": "^7.5.0",
-    "@types/shelljs": "^0.8.11",
+    "@types/shelljs": "^0.8.12",
     "@types/slice-ansi": "^4.0.0",
     "@types/strip-ansi": "^5.2.1",
     "@types/supports-color": "^8.1.1",
@@ -83,20 +80,26 @@
     "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "files": [
-    "/lib",
-    "/flush.js",
-    "/flush.d.ts",
-    "/handle.js"
+    "/lib"
   ],
   "homepage": "https://github.com/oclif/core",
   "keywords": [
     "oclif"
   ],
   "license": "MIT",
-  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./execute": "./lib/execute.js",
+    "./flush": "./lib/ux/flush.js",
+    "./handle": "./lib/errors/handle.js",
+    "./interfaces": "./lib/interfaces/index.js",
+    "./run": "./lib/main.js",
+    "./settings": "./lib/settings.js",
+    "./ux": "./lib/ux/index.js"
+  },
   "repository": "oclif/core",
   "oclif": {
     "bin": "oclif",

package/flush.d.ts

@@ -1,3 +0,0 @@
-declare const flush: () => Promise<void>
-
-export = flush

package/flush.js

@@ -1 +0,0 @@
-module.exports = require('./lib').flush

package/handle.js

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

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

@@ -1,4 +0,0 @@
-import SpinnerAction from './spinner';
-export default class PrideSpinnerAction extends SpinnerAction {
-    protected _frame(): string;
-}

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

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
-const supportsColor = require("supports-color");
-const spinner_1 = require("./spinner");
-function color(s, frameIndex) {
-    const prideColors = [
-        chalk.keyword('pink'),
-        chalk.red,
-        chalk.keyword('orange'),
-        chalk.yellow,
-        chalk.green,
-        chalk.cyan,
-        chalk.blue,
-        chalk.magenta,
-    ];
-    if (!supportsColor)
-        return s;
-    const has256 = supportsColor.stdout ? supportsColor.stdout.has256 : (process.env.TERM || '').includes('256');
-    const prideColor = prideColors[frameIndex] || prideColors[0];
-    return has256 ? prideColor(s) : chalk.magenta(s);
-}
-class PrideSpinnerAction extends spinner_1.default {
-    _frame() {
-        const frame = this.frames[this.frameIndex];
-        this.frameIndex = ++this.frameIndex % this.frames.length;
-        return color(frame, this.frameIndex);
-    }
-}
-exports.default = PrideSpinnerAction;