@oclif/core 3.0.0-beta.9 → 3.0.0

package/lib/config/config.d.ts

@@ -1,12 +1,20 @@
-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 { Command } from '../command';
+import { Hook, Hooks, PJSON, Topic } from '../interfaces';
+import { ArchTypes, Config as IConfig, LoadOptions, PlatformTypes, VersionDetails } from '../interfaces/config';
+import { Plugin as IPlugin, Options } from '../interfaces/plugin';
 export declare class Config implements IConfig {
     options: Options;
     private _base;
+    private _commandIDs;
+    private _commands;
+    private static _rootPlugin;
+    private _topics;
+    private commandPermutations;
+    private pluginLoader;
+    private topicPermutations;
     arch: ArchTypes;
     bin: string;
+    binAliases?: string[];
     binPath?: string;
     cacheDir: string;
     channel: string;
@@ -19,62 +27,66 @@ export declare class Config implements IConfig {
     home: string;
     name: string;
     npmRegistry?: string;
+    nsisCustomization?: string;
     pjson: PJSON.CLI;
     platform: PlatformTypes;
     plugins: Map<string, IPlugin>;
     root: string;
     shell: string;
-    topicSeparator: ':' | ' ';
+    topicSeparator: ' ' | ':';
     userAgent: string;
     userPJSON?: PJSON.User;
     valid: boolean;
     version: string;
-    windows: boolean;
-    binAliases?: string[];
-    nsisCustomization?: string;
     protected warned: boolean;
-    private commandPermutations;
-    private topicPermutations;
-    private _commands;
-    private _topics;
-    private _commandIDs;
-    private pluginLoader;
-    private static _rootPlugin;
+    windows: boolean;
     constructor(options: Options);
     static load(opts?: LoadOptions): Promise<Config>;
     static get rootPlugin(): IPlugin | undefined;
-    load(): 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;
-    scopedEnvVarTrue(k: string): boolean;
+    protected _debug(): number;
+    protected _shell(): string;
     /**
-     * this DOES NOT account for bin aliases, use scopedEnvVarKeys instead which will account for bin aliases
-     * @param {string} k, the unscoped key you want to get the value for
-     * @returns {string} returns the env var key
+     * This method is responsible for locating the correct plugin to use for a named command id
+     * It searches the {Config} registered commands to match either the raw command id or the command alias
+     * It is possible that more than one command will be found. This is due the ability of two distinct plugins to
+     * create the same command or command alias.
+     *
+     * In the case of more than one found command, the function will select the command based on the order in which
+     * the plugin is included in the package.json `oclif.plugins` list. The command that occurs first in the list
+     * is selected as the command to run.
+     *
+     * Commands can also be present from either an install or a link. When a command is one of these and a core plugin
+     * is present, this function defers to the core plugin.
+     *
+     * If there is not a core plugin command present, this function will return the first
+     * plugin as discovered (will not change the order)
+     *
+     * @param commands commands to determine the priority of
+     * @returns command instance {Command.Loadable} or undefined
      */
-    scopedEnvVarKey(k: string): string;
+    private determinePriority;
+    private getCmdLookupId;
+    private getTopicLookupId;
     /**
-     * gets the scoped env var keys for a given key, including bin aliases
-     * @param {string} k, the env key e.g. 'debug'
-     * @returns {string[]} e.g. ['SF_DEBUG', 'SFDX_DEBUG']
+     * Insert legacy plugins
+     *
+     * Replace invalid CLI plugins (cli-engine plugins, mostly Heroku) loaded via `this.loadPlugins`
+     * with oclif-compatible ones returned by @oclif/plugin-legacy init hook.
+     *
+     * @param plugins array of oclif-compatible plugins
+     * @returns void
      */
-    scopedEnvVarKeys(k: string): string[];
+    private insertLegacyPlugins;
+    private isJitPluginCommand;
+    private loadCommands;
+    private loadTopics;
+    protected dir(category: 'cache' | 'config' | 'data'): string;
     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;
     /**
      * Find all command ids that include the provided command id.
      *
@@ -89,69 +101,56 @@ export declare class Config implements IConfig {
      * @returns string[]
      */
     findMatches(partialCmdId: string, argv: string[]): Command.Loadable[];
-    /**
-     * Returns an array of all commands. If flexible taxonomy is enabled then all permutations will be appended to the array.
-     * @returns Command.Loadable[]
-     */
-    getAllCommands(): Command.Loadable[];
+    findTopic(id: string, opts: {
+        must: true;
+    }): Topic;
+    findTopic(id: string, opts?: {
+        must: boolean;
+    }): Topic | undefined;
     /**
      * Returns an array of all command ids. If flexible taxonomy is enabled then all permutations will be appended to the array.
      * @returns string[]
      */
     getAllCommandIDs(): string[];
-    get commands(): Command.Loadable[];
-    get commandIDs(): string[];
-    get topics(): Topic[];
-    get versionDetails(): VersionDetails;
+    /**
+     * Returns an array of all commands. If flexible taxonomy is enabled then all permutations will be appended to the array.
+     * @returns Command.Loadable[]
+     */
+    getAllCommands(): Command.Loadable[];
+    getPluginsList(): IPlugin[];
+    load(): Promise<void>;
+    loadPluginsAndCommands(opts?: {
+        force: boolean;
+    }): Promise<void>;
+    protected macosCacheDir(): string | undefined;
+    runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable | null): 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: keyof PJSON.S3.Templates, ext?: '.tar.gz' | '.tar.xz' | IConfig.s3Key.Options, options?: IConfig.s3Key.Options): string;
     s3Url(key: string): string;
-    getPluginsList(): IPlugin[];
-    protected dir(category: 'cache' | 'data' | 'config'): string;
+    scopedEnvVar(k: string): string | undefined;
+    /**
+     * this DOES NOT account for bin aliases, use scopedEnvVarKeys instead which will account for bin aliases
+     * @param {string} k, the unscoped key you want to get the value for
+     * @returns {string} returns the env var key
+     */
+    scopedEnvVarKey(k: string): string;
+    /**
+     * gets the scoped env var keys for a given key, including bin aliases
+     * @param {string} k, the env key e.g. 'debug'
+     * @returns {string[]} e.g. ['SF_DEBUG', 'SFDX_DEBUG']
+     */
+    scopedEnvVarKeys(k: string): string[];
+    scopedEnvVarTrue(k: string): boolean;
+    protected warn(err: {
+        detail: string;
+        name: string;
+    } | Error | string, scope?: string): void;
     protected windowsHome(): string | undefined;
     protected windowsHomedriveHome(): string | undefined;
     protected windowsUserprofileHome(): string | undefined;
-    protected macosCacheDir(): string | undefined;
-    protected _shell(): string;
-    protected _debug(): number;
-    protected warn(err: string | Error | {
-        name: string;
-        detail: string;
-    }, scope?: string): void;
+    get commandIDs(): string[];
+    get commands(): Command.Loadable[];
     protected get isProd(): boolean;
-    private isJitPluginCommand;
-    private getCmdLookupId;
-    private getTopicLookupId;
-    private loadCommands;
-    private loadTopics;
-    /**
-     * This method is responsible for locating the correct plugin to use for a named command id
-     * It searches the {Config} registered commands to match either the raw command id or the command alias
-     * It is possible that more than one command will be found. This is due the ability of two distinct plugins to
-     * create the same command or command alias.
-     *
-     * In the case of more than one found command, the function will select the command based on the order in which
-     * the plugin is included in the package.json `oclif.plugins` list. The command that occurs first in the list
-     * is selected as the command to run.
-     *
-     * Commands can also be present from either an install or a link. When a command is one of these and a core plugin
-     * is present, this function defers to the core plugin.
-     *
-     * If there is not a core plugin command present, this function will return the first
-     * plugin as discovered (will not change the order)
-     *
-     * @param commands commands to determine the priority of
-     * @returns command instance {Command.Loadable} or undefined
-     */
-    private determinePriority;
-    /**
-      * Insert legacy plugins
-      *
-      * Replace invalid CLI plugins (cli-engine plugins, mostly Heroku) loaded via `this.loadPlugins`
-      * with oclif-compatible ones returned by @oclif/plugin-legacy init hook.
-      *
-      * @param plugins array of oclif-compatible plugins
-      * @returns void
-      */
-    private insertLegacyPlugins;
+    get topics(): Topic[];
+    get versionDetails(): VersionDetails;
 }
-export declare function toCached(c: Command.Class, plugin?: IPlugin, respectNoCacheDefault?: boolean): Promise<Command.Cached>;