@oclif/core 2.14.0 → 3.0.0-beta.10

package/README.md

@@ -11,7 +11,9 @@ 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 [v2 migration guide](./guides/V2_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.
 
 CLI UX
 =====
@@ -28,7 +30,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 +52,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/cli-ux/action/base.js

@@ -31,8 +31,8 @@ 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;
     }

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

@@ -4,20 +4,17 @@ exports.config = exports.Config = void 0;
 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 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;
 class Config {
     constructor() {
         this.outputLevel = 'info';
         this.action = new Action();
-        this.prideAction = new PrideAction();
         this.errorsHandled = false;
         this.showStackTrace = true;
     }

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

@@ -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/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 __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.flush = flush;

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

@@ -16,7 +16,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;
@@ -44,7 +43,6 @@ 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;
@@ -56,4 +54,4 @@ 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 { action, ActionBase, annotation, anykey, config, Config, confirm, debug, done, error, exit, ExitError, flush, info, IPromptOptions, log, 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 = exports.ux = 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.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");
@@ -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,9 +35,6 @@ 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));
@@ -118,7 +96,7 @@ class ux {
         }
     }
     static async flush(ms = 10000) {
-        await timeout(_flush(), ms);
+        await (0, flush_1.flush)(ms);
     }
 }
 exports.ux = ux;
@@ -145,8 +123,6 @@ 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;
@@ -169,7 +145,7 @@ 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 +156,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/styled/json.js

@@ -1,7 +1,7 @@
 "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) {

package/lib/command.d.ts

@@ -157,6 +157,8 @@ export declare namespace Command {
             [name: string]: Arg.Cached;
         };
         hasDynamicHelp?: boolean;
+        permutations?: string[];
+        aliasPermutations?: string[];
     };
     type Flag = CompletableFlag<any>;
     namespace Flag {

package/lib/config/config.d.ts

@@ -1,7 +1,6 @@
 import { Options, Plugin as IPlugin } from '../interfaces/plugin';
 import { Config as IConfig, ArchTypes, PlatformTypes, LoadOptions, VersionDetails } from '../interfaces/config';
 import { Hook, Hooks, PJSON, Topic } from '../interfaces';
-import * as Plugin from './plugin';
 import { Command } from '../command';
 export declare class Config implements IConfig {
     options: Options;
@@ -22,7 +21,7 @@ export declare class Config implements IConfig {
     npmRegistry?: string;
     pjson: PJSON.CLI;
     platform: PlatformTypes;
-    plugins: IPlugin[];
+    plugins: Map<string, IPlugin>;
     root: string;
     shell: string;
     topicSeparator: ':' | ' ';
@@ -39,13 +38,15 @@ export declare class Config implements IConfig {
     private _commands;
     private _topics;
     private _commandIDs;
+    private pluginLoader;
+    private static _rootPlugin;
     constructor(options: Options);
     static load(opts?: LoadOptions): Promise<Config>;
+    static get rootPlugin(): IPlugin | undefined;
     load(): Promise<void>;
-    loadPluginsAndCommands(): Promise<void>;
-    loadCorePlugins(): Promise<void>;
-    loadDevPlugins(): Promise<void>;
-    loadUserPlugins(): Promise<void>;
+    loadPluginsAndCommands(opts?: {
+        force: boolean;
+    }): Promise<void>;
     runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number, captureErrors?: boolean): Promise<Hook.Result<Hooks[T]['return']>>;
     runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable | null): Promise<T>;
     scopedEnvVar(k: string): string | undefined;
@@ -112,11 +113,6 @@ export declare class Config implements IConfig {
     protected macosCacheDir(): string | undefined;
     protected _shell(): string;
     protected _debug(): number;
-    protected loadPlugins(root: string, type: string, plugins: (string | {
-        root?: string;
-        name?: string;
-        tag?: string;
-    })[], parent?: Plugin.Plugin): Promise<void>;
     protected warn(err: string | Error | {
         name: string;
         detail: string;
@@ -158,4 +154,4 @@ export declare class Config implements IConfig {
       */
     private insertLegacyPlugins;
 }
-export declare function toCached(c: Command.Class, plugin?: IPlugin | undefined, isWritingManifest?: boolean): Promise<Command.Cached>;
+export declare function toCached(c: Command.Class, plugin?: IPlugin, respectNoCacheDefault?: boolean): Promise<Command.Cached>;