@oclif/core 3.0.0-beta.9 → 3.0.0

package/lib/index.js

@@ -1,48 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ux = exports.tsPath = exports.toStandardizedId = exports.toConfiguredId = exports.toCached = exports.stdout = exports.stderr = exports.settings = exports.run = exports.Plugin = exports.Performance = exports.Parser = exports.loadHelpClass = exports.Interfaces = exports.HelpBase = exports.Help = exports.handle = exports.flush = exports.Flags = exports.execute = exports.Errors = exports.Config = exports.CommandHelp = exports.Command = exports.Args = void 0;
-const command_1 = require("./command");
-Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
-const main_1 = require("./main");
-exports.run = main_1.default;
-const execute_1 = require("./execute");
-exports.execute = execute_1.default;
-const handle_1 = require("./errors/handle");
-exports.handle = handle_1.default;
-const config_1 = require("./config");
-Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return config_1.Plugin; } });
-Object.defineProperty(exports, "tsPath", { enumerable: true, get: function () { return config_1.tsPath; } });
-Object.defineProperty(exports, "toCached", { enumerable: true, get: function () { return config_1.toCached; } });
-const Interfaces = require("./interfaces");
-exports.Interfaces = Interfaces;
-const Errors = require("./errors");
-exports.Errors = Errors;
-const Flags = require("./flags");
-exports.Flags = Flags;
-const Args = require("./args");
-exports.Args = Args;
-const help_1 = require("./help");
-Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return help_1.CommandHelp; } });
-Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
-Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
-Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
-const util_1 = require("./help/util");
-Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return util_1.toStandardizedId; } });
-Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return util_1.toConfiguredId; } });
-const Parser = require("./parser");
-exports.Parser = Parser;
-const settings_1 = require("./settings");
-exports.settings = settings_1.default;
-const ux = require("./ux");
-exports.ux = ux;
-const stream_1 = require("./ux/stream");
-Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_1.stderr; } });
-Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_1.stdout; } });
-const performance_1 = require("./performance");
-exports.Performance = performance_1.default;
-const flush_1 = require("./ux/flush");
-exports.flush = flush_1.default;
+exports.settings = exports.Performance = exports.Parser = exports.run = exports.Interfaces = exports.toStandardizedId = exports.toConfiguredId = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.stdout = exports.stderr = exports.flush = exports.ux = exports.Args = void 0;
+const tslib_1 = require("tslib");
+const stream_1 = require("./cli-ux/stream");
 function checkCWD() {
     try {
         process.cwd();
@@ -54,3 +14,37 @@ function checkCWD() {
     }
 }
 checkCWD();
+exports.Args = tslib_1.__importStar(require("./args"));
+exports.ux = tslib_1.__importStar(require("./cli-ux"));
+var flush_1 = require("./cli-ux/flush");
+Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return flush_1.flush; } });
+var stream_2 = require("./cli-ux/stream");
+Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return stream_2.stderr; } });
+Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return stream_2.stdout; } });
+var command_1 = require("./command");
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
+Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return config_1.Plugin; } });
+exports.Errors = tslib_1.__importStar(require("./errors"));
+var handle_1 = require("./errors/handle");
+Object.defineProperty(exports, "handle", { enumerable: true, get: function () { return handle_1.handle; } });
+var execute_1 = require("./execute");
+Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return execute_1.execute; } });
+exports.Flags = tslib_1.__importStar(require("./flags"));
+var help_1 = require("./help");
+Object.defineProperty(exports, "CommandHelp", { enumerable: true, get: function () { return help_1.CommandHelp; } });
+Object.defineProperty(exports, "Help", { enumerable: true, get: function () { return help_1.Help; } });
+Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
+Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
+var util_1 = require("./help/util");
+Object.defineProperty(exports, "toConfiguredId", { enumerable: true, get: function () { return util_1.toConfiguredId; } });
+Object.defineProperty(exports, "toStandardizedId", { enumerable: true, get: function () { return util_1.toStandardizedId; } });
+exports.Interfaces = tslib_1.__importStar(require("./interfaces"));
+var main_1 = require("./main");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return main_1.run; } });
+exports.Parser = tslib_1.__importStar(require("./parser"));
+var performance_1 = require("./performance");
+Object.defineProperty(exports, "Performance", { enumerable: true, get: function () { return performance_1.Performance; } });
+var settings_1 = require("./settings");
+Object.defineProperty(exports, "settings", { enumerable: true, get: function () { return settings_1.settings; } });

package/lib/interfaces/config.d.ts

@@ -1,31 +1,27 @@
+/// <reference types="node" />
+import { Command } from '../command';
+import { Hook, Hooks } from './hooks';
 import { PJSON } from './pjson';
-import { Hooks, Hook } from './hooks';
-import { Plugin, Options } from './plugin';
+import { Options, Plugin } from './plugin';
 import { Topic } from './topic';
-import { Command } from '../command';
-export type LoadOptions = Options | string | Config | undefined;
-export type PlatformTypes = 'darwin' | 'linux' | 'win32' | 'aix' | 'freebsd' | 'openbsd' | 'sunos' | 'wsl';
+export type LoadOptions = Config | Options | string | undefined;
+export type PlatformTypes = 'wsl' | NodeJS.Platform;
 export type ArchTypes = 'arm' | 'arm64' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64' | 'x86';
 export type PluginVersionDetail = {
-    version: string;
-    type: string;
     root: string;
+    type: string;
+    version: string;
 };
 export type VersionDetails = {
-    cliVersion: string;
     architecture: string;
+    cliVersion: string;
     nodeVersion: string;
-    pluginVersions?: Record<string, PluginVersionDetail>;
     osVersion?: string;
-    shell?: string;
+    pluginVersions?: Record<string, PluginVersionDetail>;
     rootPath?: string;
+    shell?: string;
 };
 export interface Config {
-    readonly name: string;
-    readonly version: string;
-    readonly channel: string;
-    readonly pjson: PJSON.CLI;
-    readonly root: string;
     /**
      * process.arch
      */
@@ -34,12 +30,20 @@ export interface Config {
      * bin name of CLI command
      */
     readonly bin: string;
+    /**
+     * name of any bin aliases that will execute the cli
+     */
+    readonly binAliases?: string[];
+    readonly binPath?: string;
     /**
      * cache directory to use for CLI
      *
      * example ~/Library/Caches/mycli or ~/.cache/mycli
      */
     readonly cacheDir: string;
+    readonly channel: string;
+    readonly commandIDs: string[];
+    readonly commands: Command.Loadable[];
     /**
      * config directory to use for CLI
      *
@@ -52,6 +56,12 @@ export interface Config {
      * example: ~/.local/share/mycli
      */
     readonly dataDir: string;
+    /**
+     * debugging level
+     *
+     * set by ${BIN}_DEBUG or DEBUG=$BIN
+     */
+    readonly debug: number;
     /**
      * base dirname to use in cacheDir/configDir/dataDir
      */
@@ -62,86 +72,77 @@ export interface Config {
      * example: ~/Library/Caches/mycli/error.log
      */
     readonly errlog: string;
+    findCommand(id: string, opts: {
+        must: true;
+    }): Command.Loadable;
+    findCommand(id: string, opts?: {
+        must: boolean;
+    }): Command.Loadable | undefined;
+    findMatches(id: string, argv: string[]): Command.Loadable[];
+    findTopic(id: string, opts: {
+        must: true;
+    }): Topic;
+    findTopic(id: string, opts?: {
+        must: boolean;
+    }): Topic | undefined;
+    readonly flexibleTaxonomy?: boolean;
+    getAllCommandIDs(): string[];
+    getAllCommands(): Command.Loadable[];
+    getPluginsList(): Plugin[];
     /**
      * path to home directory
      *
      * example: /home/myuser
      */
     readonly home: string;
+    readonly name: string;
+    /**
+     * npm registry to use for installing plugins
+     */
+    readonly npmRegistry?: string;
+    readonly nsisCustomization?: string;
+    readonly pjson: PJSON.CLI;
     /**
      * process.platform
      */
     readonly platform: PlatformTypes;
+    readonly plugins: Map<string, Plugin>;
+    readonly root: string;
+    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable): Promise<T>;
+    runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number, captureErrors?: boolean): Promise<Hook.Result<Hooks[T]['return']>>;
+    s3Key(type: 'unversioned' | 'versioned', ext: '.tar.gz' | '.tar.xz', options?: Config.s3Key.Options): string;
+    s3Key(type: keyof PJSON.S3.Templates, options?: Config.s3Key.Options): string;
+    s3Url(key: string): string;
+    scopedEnvVar(key: string): string | undefined;
+    scopedEnvVarKey(key: string): string;
+    scopedEnvVarKeys(key: string): string[];
+    scopedEnvVarTrue(key: string): boolean;
     /**
      * active shell
      */
     readonly shell: string;
+    topicSeparator: ' ' | ':';
+    readonly topics: Topic[];
     /**
      * user agent to use for http calls
      *
      * example: mycli/1.2.3 (darwin-x64) node-9.0.0
      */
     readonly userAgent: string;
+    readonly valid: boolean;
+    readonly version: string;
+    readonly versionDetails: VersionDetails;
     /**
      * if windows
      */
     readonly windows: boolean;
-    /**
-     * debugging level
-     *
-     * set by ${BIN}_DEBUG or DEBUG=$BIN
-     */
-    readonly debug: number;
-    /**
-     * npm registry to use for installing plugins
-     */
-    readonly npmRegistry?: string;
-    readonly plugins: Map<string, Plugin>;
-    readonly binPath?: string;
-    /**
-     * name of any bin aliases that will execute the cli
-     */
-    readonly binAliases?: string[];
-    readonly nsisCustomization?: string;
-    readonly valid: boolean;
-    readonly flexibleTaxonomy?: boolean;
-    topicSeparator: ':' | ' ';
-    readonly commands: Command.Loadable[];
-    readonly topics: Topic[];
-    readonly commandIDs: string[];
-    readonly versionDetails: VersionDetails;
-    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable): Promise<T>;
-    runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number, captureErrors?: boolean): Promise<Hook.Result<Hooks[T]['return']>>;
-    getAllCommandIDs(): string[];
-    getAllCommands(): Command.Loadable[];
-    findCommand(id: string, opts: {
-        must: true;
-    }): Command.Loadable;
-    findCommand(id: string, opts?: {
-        must: boolean;
-    }): Command.Loadable | undefined;
-    findTopic(id: string, opts: {
-        must: true;
-    }): Topic;
-    findTopic(id: string, opts?: {
-        must: boolean;
-    }): Topic | undefined;
-    findMatches(id: string, argv: string[]): Command.Loadable[];
-    scopedEnvVar(key: string): string | undefined;
-    scopedEnvVarKey(key: string): string;
-    scopedEnvVarKeys(key: string): string[];
-    scopedEnvVarTrue(key: string): boolean;
-    s3Url(key: string): string;
-    s3Key(type: 'versioned' | 'unversioned', ext: '.tar.gz' | '.tar.xz', options?: Config.s3Key.Options): string;
-    s3Key(type: keyof PJSON.S3.Templates, options?: Config.s3Key.Options): string;
-    getPluginsList(): Plugin[];
 }
 export declare namespace Config {
     namespace s3Key {
         interface Options {
-            platform?: PlatformTypes;
-            arch?: ArchTypes;
             [key: string]: any;
+            arch?: ArchTypes;
+            platform?: PlatformTypes;
         }
     }
 }

package/lib/interfaces/errors.d.ts

@@ -3,18 +3,18 @@ export type CommandError = Error & {
 };
 export interface OclifError {
     oclif: {
-        exit?: number | false;
+        exit?: number;
     };
 }
 export interface PrettyPrintableError {
-    /**
-     * message to display related to the error
-     */
-    message?: string;
     /**
      * a unique error code for this error class
      */
     code?: string;
+    /**
+     * message to display related to the error
+     */
+    message?: string;
     /**
      * a url to find out more information related to this error
      * or fixing the error

package/lib/interfaces/help.d.ts

@@ -1,20 +1,9 @@
 export interface HelpOptions {
     all?: boolean;
-    maxWidth: number;
-    stripAnsi?: boolean;
-    /**
-     * By default, option values on flags are shown in the flag's description. This is because
-     * long options list ruin the formatting of help. If a CLI knows all commands will not
-     * do this, it can be turned off at a help level using this property. An individual flag
-     * can set this using `flag.helpValue=options.join('|')`.
-     */
-    showFlagOptionsInTitle?: boolean;
     /**
-     * By default, titles show flag values as `<value>`. Some CLI developers may prefer titles
-     * to show the flag name as the value. i.e. `--myflag=myflag` instead of `--myflag=<value>`.
-     * An individual flag can set this using `flag.helpValue=flag.name`.
+     * Use docopts as the usage. Defaults to true.
      */
-    showFlagNameInTitle?: boolean;
+    docopts?: boolean;
     /**
      * By default, the command summary is show at the top of the help and as the first line in
      * the command description. Repeating the summary in the command description improves readability
@@ -23,13 +12,24 @@ export interface HelpOptions {
      * not want the duplication.
      */
     hideCommandSummaryInDescription?: boolean;
+    maxWidth: number;
+    /**
+     * By default, titles show flag values as `<value>`. Some CLI developers may prefer titles
+     * to show the flag name as the value. i.e. `--myflag=myflag` instead of `--myflag=<value>`.
+     * An individual flag can set this using `flag.helpValue=flag.name`.
+     */
+    showFlagNameInTitle?: boolean;
+    /**
+     * By default, option values on flags are shown in the flag's description. This is because
+     * long options list ruin the formatting of help. If a CLI knows all commands will not
+     * do this, it can be turned off at a help level using this property. An individual flag
+     * can set this using `flag.helpValue=options.join('|')`.
+     */
+    showFlagOptionsInTitle?: boolean;
+    stripAnsi?: boolean;
     /**
      * Use USAGE, but some may want to use USAGE as used in gnu man pages. See help recommendations at
      * http://www.gnu.org/software/help2man/#--help-recommendations
      */
     usageHeader?: string;
-    /**
-     * Use docopts as the usage. Defaults to true.
-     */
-    docopts?: boolean;
 }

package/lib/interfaces/hooks.d.ts

@@ -7,62 +7,33 @@ interface HookMeta {
 }
 export interface Hooks {
     [event: string]: HookMeta;
-    init: {
-        options: {
-            id: string | undefined;
-            argv: string[];
-        };
-        return: void;
-    };
-    prerun: {
+    command_incomplete: {
         options: {
-            Command: Command.Class;
             argv: string[];
+            id: string;
+            matches: Command.Loadable[];
         };
-        return: void;
-    };
-    postrun: {
-        options: {
-            Command: Command.Class;
-            result?: any;
-            argv: string[];
-        };
-        return: void;
-    };
-    preupdate: {
-        options: {
-            channel: string;
-            version: string;
-        };
-        return: void;
-    };
-    update: {
-        options: {
-            channel: string;
-            version: string;
-        };
-        return: void;
+        return: unknown;
     };
-    'command_not_found': {
+    command_not_found: {
         options: {
-            id: string;
             argv?: string[];
+            id: string;
         };
         return: unknown;
     };
-    'command_incomplete': {
+    init: {
         options: {
-            id: string;
             argv: string[];
-            matches: Command.Loadable[];
+            id: string | undefined;
         };
-        return: unknown;
+        return: void;
     };
-    'jit_plugin_not_installed': {
+    jit_plugin_not_installed: {
         options: {
-            id: string;
             argv: string[];
             command: Command.Loadable;
+            id: string;
             pluginName: string;
             pluginVersion: string;
         };
@@ -75,12 +46,41 @@ export interface Hooks {
                 tag: string;
                 type: 'npm';
             } | {
-                url: string;
                 type: 'repo';
+                url: string;
             };
         };
         return: void;
     };
+    postrun: {
+        options: {
+            Command: Command.Class;
+            argv: string[];
+            result?: any;
+        };
+        return: void;
+    };
+    prerun: {
+        options: {
+            Command: Command.Class;
+            argv: string[];
+        };
+        return: void;
+    };
+    preupdate: {
+        options: {
+            channel: string;
+            version: string;
+        };
+        return: void;
+    };
+    update: {
+        options: {
+            channel: string;
+            version: string;
+        };
+        return: void;
+    };
 }
 export type Hook<T extends keyof P, P extends Hooks = Hooks> = (this: Hook.Context, options: P[T]['options'] & {
     config: Config;
@@ -97,24 +97,24 @@ export declare namespace Hook {
     type JitPluginNotInstalled = Hook<'jit_plugin_not_installed'>;
     interface Context {
         config: Config;
-        exit(code?: number): void;
-        error(message: string | Error, options?: {
+        debug(...args: any[]): void;
+        error(message: Error | string, options?: {
             code?: string;
             exit?: number;
         }): void;
-        warn(message: string): void;
+        exit(code?: number): void;
         log(message?: any, ...args: any[]): void;
-        debug(...args: any[]): void;
+        warn(message: string): void;
     }
     interface Result<T> {
-        successes: Array<{
-            result: T;
-            plugin: Plugin;
-        }>;
         failures: Array<{
             error: Error;
             plugin: Plugin;
         }>;
+        successes: Array<{
+            plugin: Plugin;
+            result: T;
+        }>;
     }
 }
 export {};

package/lib/interfaces/index.d.ts

@@ -1,14 +1,14 @@
 export type { AlphabetLowercase, AlphabetUppercase } from './alphabet';
-export type { Config, ArchTypes, PlatformTypes, LoadOptions, VersionDetails, PluginVersionDetail } from './config';
-export type { OclifError, PrettyPrintableError, CommandError } from './errors';
+export type { InferredArgs } from './args';
+export type { ArchTypes, Config, LoadOptions, PlatformTypes, PluginVersionDetail, VersionDetails } from './config';
+export type { CommandError, OclifError, PrettyPrintableError } from './errors';
+export type { InferredFlags } from './flags';
 export type { HelpOptions } from './help';
 export type { Hook, Hooks } from './hooks';
 export type { Manifest } from './manifest';
-export type { S3Manifest } from './s3-manifest';
-export type { Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, OptionFlag, } from './parser';
+export type { Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, OptionFlag } from './parser';
 export type { PJSON } from './pjson';
-export type { Plugin, PluginOptions, Options } from './plugin';
+export type { Options, Plugin, PluginOptions } from './plugin';
+export type { S3Manifest } from './s3-manifest';
 export type { Topic } from './topic';
 export type { TSConfig } from './ts-config';
-export type { InferredFlags } from './flags';
-export type { InferredArgs } from './args';

package/lib/interfaces/manifest.d.ts

@@ -1,7 +1,7 @@
 import { Command } from '../command';
 export type Manifest = {
-    version: string;
     commands: {
         [id: string]: Command.Cached;
     };
+    version: string;
 };