@oclif/core 2.0.0-beta.4 → 2.0.0-beta.5

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

@@ -6,27 +6,54 @@ import { IPromptOptions } from './prompt';
 import * as styled from './styled';
 import { Table } from './styled';
 import * as uxPrompt from './prompt';
+import uxWait from './wait';
+export declare class ux {
+    static config: Config;
+    static get prompt(): typeof uxPrompt.prompt;
+    /**
+     * "press anykey to continue"
+     */
+    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 get styledHeader(): typeof styled.styledHeader;
+    static get styledJSON(): typeof styled.styledJSON;
+    static get table(): typeof styled.Table.table;
+    static get tree(): typeof styled.tree;
+    static get wait(): typeof uxWait;
+    static get progress(): typeof styled.progress;
+    static done(): Promise<void>;
+    static trace(format: string, ...args: string[]): void;
+    static debug(format: string, ...args: string[]): void;
+    static info(format: string, ...args: string[]): void;
+    static log(format?: string, ...args: string[]): void;
+    static url(text: string, uri: string, params?: {}): void;
+    static annotation(text: string, annotation: string): void;
+    static flush(ms?: number): Promise<void>;
+}
 declare const action: ActionBase;
-declare const annotation: (text: string, annotation: string) => void;
+declare const annotation: typeof ux.annotation;
 declare const anykey: typeof uxPrompt.anykey;
 declare const confirm: typeof uxPrompt.confirm;
-declare const debug: (format: string, ...args: string[]) => void;
-declare const done: () => Promise<void>;
+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: (ms?: number) => Promise<void>;
-declare const info: (format: string, ...args: string[]) => void;
-declare const log: (format?: string, ...args: string[]) => void;
+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 styled.styledHeader;
 declare const styledJSON: typeof styled.styledJSON;
-declare const styledObject: (obj: any, keys?: string[]) => void;
+declare const styledObject: typeof ux.styledObject;
 declare const table: typeof styled.Table.table;
-declare const trace: (format: string, ...args: string[]) => void;
+declare const trace: typeof ux.trace;
 declare const tree: typeof styled.tree;
-declare const url: (text: string, uri: string, params?: {}) => void;
+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, };

package/lib/cli-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 = void 0;
+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 base_1 = require("./action/base");
@@ -24,7 +24,7 @@ function timeout(p, ms) {
                 t.unref();
         });
     }
-    return Promise.race([p, wait(ms, true).then(() => ux.error('timed out'))]);
+    return Promise.race([p, wait(ms, true).then(() => Errors.error('timed out'))]);
 }
 async function _flush() {
     const p = new Promise(resolve => {
@@ -36,70 +36,67 @@ async function _flush() {
     }
     return p;
 }
-const ux = {
-    config: config_1.config,
-    warn: Errors.warn,
-    error: Errors.error,
-    exit: Errors.exit,
-    get prompt() {
+class ux {
+    static get prompt() {
         return uxPrompt.prompt;
-    },
+    }
     /**
      * "press anykey to continue"
      */
-    get anykey() {
+    static get anykey() {
         return uxPrompt.anykey;
-    },
-    get confirm() {
+    }
+    static get confirm() {
         return uxPrompt.confirm;
-    },
-    get action() {
+    }
+    static get action() {
         return config_1.config.action;
-    },
-    get prideAction() {
+    }
+    static get prideAction() {
         return config_1.config.prideAction;
-    },
-    styledObject(obj, keys) {
-        ux.info(styled.styledObject(obj, keys));
-    },
-    get styledHeader() {
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    static styledObject(obj, keys) {
+        this.info(styled.styledObject(obj, keys));
+    }
+    static get styledHeader() {
         return styled.styledHeader;
-    },
-    get styledJSON() {
+    }
+    static get styledJSON() {
         return styled.styledJSON;
-    },
-    get table() {
+    }
+    static get table() {
         return styled.Table.table;
-    },
-    get tree() {
+    }
+    static get tree() {
         return styled.tree;
-    },
-    get wait() {
+    }
+    static get wait() {
         return wait_1.default;
-    },
-    get progress() {
+    }
+    static get progress() {
         return styled.progress;
-    },
-    async done() {
+    }
+    static async done() {
         config_1.config.action.stop();
-    },
-    trace(format, ...args) {
+    }
+    static trace(format, ...args) {
         if (this.config.outputLevel === 'trace') {
             process.stdout.write(util.format(format, ...args) + '\n');
         }
-    },
-    debug(format, ...args) {
+    }
+    static debug(format, ...args) {
         if (['trace', 'debug'].includes(this.config.outputLevel)) {
             process.stdout.write(util.format(format, ...args) + '\n');
         }
-    },
-    info(format, ...args) {
+    }
+    static info(format, ...args) {
         process.stdout.write(util.format(format, ...args) + '\n');
-    },
-    log(format, ...args) {
+    }
+    static log(format, ...args) {
         this.info(format || '', ...args);
-    },
-    url(text, uri, params = {}) {
+    }
+    static url(text, uri, params = {}) {
         const supports = require('supports-hyperlinks');
         if (supports.stdout) {
             this.log(hyperlinker(text, uri, params));
@@ -107,8 +104,8 @@ const ux = {
         else {
             this.log(uri);
         }
-    },
-    annotation(text, annotation) {
+    }
+    static annotation(text, annotation) {
         const supports = require('supports-hyperlinks');
         if (supports.stdout) {
             // \u001b]8;;https://google.com\u0007sometext\u001b]8;;\u0007
@@ -117,56 +114,58 @@ const ux = {
         else {
             this.log(text);
         }
-    },
-    async flush(ms = 10000) {
+    }
+    static async flush(ms = 10000) {
         await timeout(_flush(), ms);
-    },
-};
+    }
+}
+exports.ux = ux;
+ux.config = config_1.config;
 const action = ux.action;
 exports.action = action;
-const annotation = ux.annotation.bind(ux);
+const annotation = ux.annotation;
 exports.annotation = annotation;
-const anykey = ux.anykey.bind(ux);
+const anykey = ux.anykey;
 exports.anykey = anykey;
-const confirm = ux.confirm.bind(ux);
+const confirm = ux.confirm;
 exports.confirm = confirm;
-const debug = ux.debug.bind(ux);
+const debug = ux.debug;
 exports.debug = debug;
-const done = ux.done.bind(ux);
+const done = ux.done;
 exports.done = done;
-const error = ux.error.bind(ux);
+const error = Errors.error;
 exports.error = error;
-const exit = ux.exit.bind(ux);
+const exit = Errors.exit;
 exports.exit = exit;
-const flush = ux.flush.bind(ux);
+const flush = ux.flush;
 exports.flush = flush;
-const info = ux.info.bind(ux);
+const info = ux.info;
 exports.info = info;
-const log = ux.log.bind(ux);
+const log = ux.log;
 exports.log = log;
 const prideAction = ux.prideAction;
 exports.prideAction = prideAction;
-const progress = ux.progress.bind(ux);
+const progress = ux.progress;
 exports.progress = progress;
-const prompt = ux.prompt.bind(ux);
+const prompt = ux.prompt;
 exports.prompt = prompt;
-const styledHeader = ux.styledHeader.bind(ux);
+const styledHeader = ux.styledHeader;
 exports.styledHeader = styledHeader;
-const styledJSON = ux.styledJSON.bind(ux);
+const styledJSON = ux.styledJSON;
 exports.styledJSON = styledJSON;
-const styledObject = ux.styledObject.bind(ux);
+const styledObject = ux.styledObject;
 exports.styledObject = styledObject;
 const table = ux.table;
 exports.table = table;
-const trace = ux.trace.bind(ux);
+const trace = ux.trace;
 exports.trace = trace;
-const tree = ux.tree.bind(ux);
+const tree = ux.tree;
 exports.tree = tree;
-const url = ux.url.bind(ux);
+const url = ux.url;
 exports.url = url;
-const wait = ux.wait.bind(ux);
+const wait = ux.wait;
 exports.wait = wait;
-const warn = ux.warn.bind(ux);
+const warn = Errors.warn;
 exports.warn = warn;
 const cliuxProcessExitHandler = async () => {
     try {

package/lib/index.d.ts

@@ -12,5 +12,5 @@ import { Hook } from './interfaces/hooks';
 import { settings, Settings } from './settings';
 import { HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable } from './help/formatter';
 import * as ux from './cli-ux';
-declare const flush: (ms?: number) => Promise<void>;
+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, };

package/package.json

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