@oclif/core 4.0.0-beta.6 → 4.0.0-beta.8

package/lib/interfaces/config.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Command } from '../command';
 import { Hook, Hooks } from './hooks';
-import { PJSON } from './pjson';
+import { Configuration, PJSON, S3Templates } from './pjson';
 import { Options, Plugin } from './plugin';
 import { Theme } from './theme';
 import { Topic } from './topic';
@@ -34,8 +34,8 @@ export interface Config {
     /**
      * name of any bin aliases that will execute the cli
      */
-    readonly binAliases?: string[];
-    readonly binPath?: string;
+    readonly binAliases?: string[] | undefined;
+    readonly binPath?: string | undefined;
     /**
      * cache directory to use for CLI
      *
@@ -89,9 +89,9 @@ export interface Config {
     /**
      * npm registry to use for installing plugins
      */
-    readonly npmRegistry?: string;
-    readonly nsisCustomization?: string;
-    readonly pjson: PJSON.CLI;
+    readonly npmRegistry?: string | undefined;
+    readonly nsisCustomization?: string | undefined;
+    readonly pjson: PJSON;
     /**
      * process.platform
      */
@@ -101,7 +101,7 @@ export interface Config {
     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;
+    s3Key(type: keyof S3Templates, options?: Config.s3Key.Options): string;
     s3Url(key: string): string;
     scopedEnvVar(key: string): string | undefined;
     scopedEnvVarKey(key: string): string;
@@ -111,10 +111,10 @@ export interface Config {
      * active shell
      */
     readonly shell: string;
-    readonly theme?: Theme;
+    readonly theme?: Theme | undefined;
     topicSeparator: ' ' | ':';
     readonly topics: Topic[];
-    readonly updateConfig: NonNullable<PJSON.CLI['oclif']['update']>;
+    readonly updateConfig: NonNullable<Configuration['update']>;
     /**
      * user agent to use for http calls
      *

package/lib/interfaces/errors.d.ts

@@ -3,25 +3,25 @@ export type CommandError = Error & {
 };
 export interface OclifError {
     oclif: {
-        exit?: number;
+        exit?: number | undefined;
     };
 }
 export interface PrettyPrintableError {
     /**
      * a unique error code for this error class
      */
-    code?: string;
+    code?: string | undefined;
     /**
      * message to display related to the error
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * a url to find out more information related to this error
      * or fixing the error
      */
-    ref?: string;
+    ref?: string | undefined;
     /**
      * a suggestion that may be useful or provide additional context
      */
-    suggestions?: string[];
+    suggestions?: string[] | undefined;
 }

package/lib/interfaces/index.d.ts

@@ -8,7 +8,7 @@ export type { Hook, Hooks } from './hooks';
 export type { Logger } from './logger';
 export type { Manifest } from './manifest';
 export type { Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, OptionFlag } from './parser';
-export type { PJSON } from './pjson';
+export type { Configuration, PJSON, S3, S3Templates, UserPJSON } from './pjson';
 export type { Options, Plugin, PluginOptions } from './plugin';
 export type { S3Manifest } from './s3-manifest';
 export type { Theme } from './theme';

package/lib/interfaces/parser.d.ts

@@ -8,10 +8,10 @@ export type ArgOutput = {
 };
 export type CLIParseErrorOptions = {
     parse: {
-        input?: ParserInput;
-        output?: ParserOutput;
+        input?: ParserInput | undefined;
+        output?: ParserOutput | undefined;
     };
-    exit?: number;
+    exit?: number | undefined;
 };
 export type OutputArgs<T extends ParserInput['args']> = {
     [P in keyof T]: any;
@@ -431,7 +431,7 @@ export type Input<TFlags extends FlagOutput, BFlags extends FlagOutput, AFlags e
     baseFlags?: FlagInput<BFlags>;
     enableJsonFlag?: true | false;
     args?: ArgInput<AFlags>;
-    strict?: boolean;
+    strict?: boolean | undefined;
     context?: ParserContext;
     '--'?: boolean;
 };
@@ -441,10 +441,10 @@ export type ParserInput = {
     args: ArgInput<any>;
     strict: boolean;
     context: ParserContext | undefined;
-    '--'?: boolean;
+    '--'?: boolean | undefined;
 };
 export type ParserContext = Command & {
-    token?: FlagToken | ArgToken;
+    token?: FlagToken | ArgToken | undefined;
 };
 export type FlagInput<T extends FlagOutput = {
     [flag: string]: any;

package/lib/interfaces/pjson.d.ts

@@ -1,21 +1,5 @@
 import { HelpOptions } from './help';
-export interface PJSON {
-    [k: string]: any;
-    dependencies?: {
-        [name: string]: string;
-    };
-    devDependencies?: {
-        [name: string]: string;
-    };
-    oclif: {
-        bin?: string;
-        dirname?: string;
-        hooks?: Record<string, string | string[]>;
-        plugins?: string[];
-        schema?: number;
-    };
-    version: string;
-}
+import { Theme } from './theme';
 export type CommandDiscovery = {
     /**
      * The strategy to use for loading commands.
@@ -96,141 +80,222 @@ export type HookOptions = {
      */
     identifier: string;
 };
-export declare namespace PJSON {
-    interface Plugin extends PJSON {
-        name: string;
-        oclif: PJSON['oclif'] & {
-            additionalHelpFlags?: string[];
-            additionalVersionFlags?: string[];
-            aliases?: {
-                [name: string]: null | string;
-            };
-            commands?: string | CommandDiscovery;
-            /**
-             * Default command id when no command is found. This is used to support single command CLIs.
-             * Only supported value is "."
-             *
-             * @deprecated Use `commands.strategy: 'single'` instead.
-             */
-            default?: string;
+export type HelpLocationOptions = {
+    /**
+     * The file path containing help class.
+     */
+    target: string;
+    /**
+     * The name of the export to use when loading the help class from the `target` file. Defaults to `default`.
+     */
+    identifier: string;
+};
+export type S3Templates = {
+    baseDir?: string;
+    manifest?: string;
+    unversioned?: string;
+    versioned?: string;
+};
+export type S3 = {
+    acl?: string | undefined;
+    bucket?: string | undefined;
+    folder?: string | undefined;
+    gz?: boolean | undefined;
+    host?: string | undefined;
+    templates?: {
+        target: S3Templates;
+        vanilla: S3Templates;
+    } | undefined;
+    xz?: boolean | undefined;
+};
+export type Configuration = {
+    /**
+     * Flags in addition to --help that should trigger help output.
+     */
+    additionalHelpFlags?: string[];
+    /**
+     * Flags in addition to --version that should trigger version output.
+     */
+    additionalVersionFlags?: string[];
+    /**
+     * Plugin aliases.
+     */
+    aliases?: {
+        [name: string]: null | string;
+    };
+    /**
+     * The name of the executable.
+     */
+    bin?: string;
+    /**
+     * Aliases for the executable.
+     */
+    binAliases?: string[];
+    commands?: string | CommandDiscovery;
+    /**
+     * Your CLI's description. Overrides the description in the package.json.
+     */
+    description?: string | undefined;
+    /**
+     * Plugins to load when in development mode.
+     */
+    devPlugins?: string[];
+    /**
+     * The directory name to use when determining the cache, config, and data directories.
+     */
+    dirname?: string;
+    /**
+     * Example plugin to use in @oclif/plugin-plugin's help output.
+     */
+    examplePlugin?: string;
+    /**
+     * Customize the exit codes for the CLI.
+     */
+    exitCodes?: {
+        default?: number;
+        failedFlagParsing?: number;
+        failedFlagValidation?: number;
+        invalidArgsSpec?: number;
+        nonExistentFlag?: number;
+        requiredArgs?: number;
+        unexpectedArgs?: number;
+    };
+    /**
+     * Enable flexible taxonomy for commands.
+     */
+    flexibleTaxonomy?: boolean;
+    /**
+     * The location of your custom help class.
+     */
+    helpClass?: string | HelpLocationOptions;
+    /**
+     * Options for the help output.
+     */
+    helpOptions?: HelpOptions;
+    /**
+     * Register hooks to run at various points in the CLI lifecycle.
+     */
+    hooks?: {
+        [name: string]: string | string[] | HookOptions | HookOptions[];
+    };
+    /**
+     * Plugins that can be installed just-in-time.
+     */
+    jitPlugins?: Record<string, string>;
+    macos?: {
+        identifier?: string;
+        sign?: string;
+    };
+    /**
+     * Use a private or alternate npm registry.
+     */
+    npmRegistry?: string;
+    /**
+     * Script to run during postinstall on windows.
+     */
+    nsisCustomization?: string;
+    /**
+     * Plugin prefix to use when working with plugins with @oclif/plugin-plugins.
+     *
+     * Defaults to `plugin-`.
+     */
+    pluginPrefix?: string;
+    /**
+     * Plugins to load.
+     */
+    plugins?: string[];
+    /**
+     * Template string used to build links to source code in CLI's README (when using `oclif readme`).
+     */
+    repositoryPrefix?: string;
+    schema?: number;
+    /**
+     * The namespace to be used for plugins of your CLI, e.g. `@salesforce`.
+     */
+    scope?: string;
+    /**
+     * State of your CLI
+     *
+     * - `beta` - will show message to user that command or CLI is in beta
+     * - `deprecated` - will show message to user that command or CLI is deprecated
+     */
+    state?: 'beta' | 'deprecated' | string;
+    /**
+     * The theme to ship with the CLI.
+     *
+     * Can be a path to a JSON file or a Theme object.
+     */
+    theme?: string | Theme;
+    /**
+     * Separator to use for your CLI. Can be `:` or ` `.
+     */
+    topicSeparator?: ' ' | ':';
+    /**
+     * Customize the topics in the CLI.
+     */
+    topics?: {
+        [k: string]: {
             description?: string;
-            devPlugins?: string[];
-            exitCodes?: {
-                default?: number;
-                failedFlagParsing?: number;
-                failedFlagValidation?: number;
-                invalidArgsSpec?: number;
-                nonExistentFlag?: number;
-                requiredArgs?: number;
-                unexpectedArgs?: number;
-            };
-            flexibleTaxonomy?: boolean;
-            helpClass?: string;
-            helpOptions?: HelpOptions;
-            hooks?: {
-                [name: string]: string | string[] | HookOptions | HookOptions[];
-            };
-            jitPlugins?: Record<string, string>;
-            macos?: {
-                identifier?: string;
-                sign?: string;
-            };
-            plugins?: string[];
-            repositoryPrefix?: string;
-            schema?: number;
-            state?: 'beta' | 'deprecated' | string;
-            theme?: string;
-            topicSeparator?: ' ' | ':';
-            topics?: {
-                [k: string]: {
-                    description?: string;
-                    hidden?: boolean;
-                    subtopics?: Plugin['oclif']['topics'];
-                };
-            };
-            update?: {
-                autoupdate?: {
-                    debounce?: number;
-                    rollout?: number;
-                };
-                disableNpmLookup?: boolean;
-                node: {
-                    targets?: string[];
-                    version?: string;
-                    options?: string | string[];
-                };
-                s3: S3;
-            };
-            windows?: {
-                homepage?: string;
-                keypath?: string;
-                name?: string;
-            };
-        };
-        version: string;
-    }
-    interface S3 {
-        acl?: string;
-        bucket?: string;
-        folder?: string;
-        gz?: boolean;
-        host?: string;
-        templates: {
-            target: S3.Templates;
-            vanilla: S3.Templates;
+            hidden?: boolean;
+            subtopics?: Configuration['topics'];
         };
-        xz?: boolean;
-    }
-    namespace S3 {
-        interface Templates {
-            baseDir?: string;
-            manifest?: string;
-            unversioned?: string;
-            versioned?: string;
-        }
-    }
-    interface CLI extends Plugin {
-        oclif: Plugin['oclif'] & {
-            bin?: string;
-            binAliases?: string[];
-            dirname?: string;
-            flexibleTaxonomy?: boolean;
-            jitPlugins?: Record<string, string>;
-            npmRegistry?: string;
-            nsisCustomization?: string;
-            schema?: number;
-            scope?: string;
-            pluginPrefix?: string;
-            'warn-if-update-available'?: {
-                authorization: string;
-                message: string;
-                registry: string;
-                timeoutInDays: number;
-                frequency: number;
-                frequencyUnit: 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds';
-            };
+    };
+    update?: {
+        autoupdate?: {
+            debounce?: number;
+            rollout?: number;
         };
-    }
-    interface User extends PJSON {
-        oclif: PJSON['oclif'] & {
-            plugins?: (PluginTypes.Link | PluginTypes.User | string)[];
+        disableNpmLookup?: boolean;
+        node: {
+            targets?: string[];
+            version?: string;
+            options?: string | string[];
         };
-        private?: boolean;
-    }
-    type PluginTypes = {
-        root: string;
-    } | PluginTypes.Link | PluginTypes.User;
-    namespace PluginTypes {
-        interface User {
-            name: string;
-            tag?: string;
-            type: 'user';
-            url?: string;
-        }
-        interface Link {
-            name: string;
-            root: string;
-            type: 'link';
-        }
-    }
-}
+        s3: S3;
+    };
+    'warn-if-update-available'?: {
+        authorization?: string;
+        message?: string;
+        registry?: string;
+        timeoutInDays?: number;
+        frequency?: number;
+        frequencyUnit?: 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds';
+    };
+    windows?: {
+        homepage?: string;
+        keypath?: string;
+        name?: string;
+    };
+};
+export type UserPlugin = {
+    name: string;
+    tag?: string;
+    type: 'user';
+    url?: string;
+};
+export type LinkedPlugin = {
+    name: string;
+    root: string;
+    type: 'link';
+};
+export type PluginTypes = {
+    root: string;
+} | UserPlugin | LinkedPlugin;
+export type UserPJSON = {
+    oclif: {
+        plugins?: PluginTypes[];
+    };
+    private?: boolean;
+};
+export type PJSON = {
+    [k: string]: any;
+    dependencies?: {
+        [name: string]: string;
+    };
+    devDependencies?: {
+        [name: string]: string;
+    };
+    name: string;
+    oclif: Configuration;
+    version: string;
+};

package/lib/interfaces/plugin.d.ts

@@ -3,35 +3,35 @@ import { Logger } from './logger';
 import { HookOptions, PJSON } from './pjson';
 import { Topic } from './topic';
 export interface PluginOptions {
-    children?: Plugin[];
-    errorOnManifestCreate?: boolean;
-    flexibleTaxonomy?: boolean;
-    ignoreManifest?: boolean;
-    isRoot?: boolean;
-    name?: string;
-    parent?: Plugin;
-    pjson?: PJSON.Plugin;
-    respectNoCacheDefault?: boolean;
+    children?: Plugin[] | undefined;
+    errorOnManifestCreate?: boolean | undefined;
+    flexibleTaxonomy?: boolean | undefined;
+    ignoreManifest?: boolean | undefined;
+    isRoot?: boolean | undefined;
+    name?: string | undefined;
+    parent?: Plugin | undefined;
+    pjson?: PJSON | undefined;
+    respectNoCacheDefault?: boolean | undefined;
     root: string;
-    tag?: string;
-    type?: string;
-    url?: string;
+    tag?: string | undefined;
+    type?: string | undefined;
+    url?: string | undefined;
 }
 export interface Options extends PluginOptions {
-    channel?: string;
-    devPlugins?: boolean;
-    enablePerf?: boolean;
-    jitPlugins?: boolean;
-    logger?: Logger;
-    pjson?: PJSON.Plugin;
+    channel?: string | undefined;
+    devPlugins?: boolean | undefined;
+    enablePerf?: boolean | undefined;
+    jitPlugins?: boolean | undefined;
+    logger?: Logger | undefined;
+    pjson?: PJSON | undefined;
     pluginAdditions?: {
         core?: string[];
         dev?: string[];
         path?: string;
-    };
-    plugins?: Map<string, Plugin>;
-    userPlugins?: boolean;
-    version?: string;
+    } | undefined;
+    plugins?: Map<string, Plugin> | undefined;
+    userPlugins?: boolean | undefined;
+    version?: string | undefined;
 }
 export interface Plugin {
     /**
@@ -69,13 +69,13 @@ export interface Plugin {
      */
     name: string;
     readonly options: Options;
-    parent?: Plugin;
+    parent?: Plugin | undefined;
     /**
      * full package.json
      *
      * parsed with read-pkg
      */
-    pjson: PJSON.CLI | PJSON.Plugin;
+    pjson: PJSON;
     /**
      * base path of plugin
      */
@@ -84,7 +84,7 @@ export interface Plugin {
      * npm dist-tag of plugin
      * only used for user plugins
      */
-    tag?: string;
+    tag?: string | undefined;
     readonly topics: Topic[];
     /**
      * used to tell the user how the plugin was installed

package/lib/interfaces/topic.d.ts

@@ -1,5 +1,5 @@
 export interface Topic {
-    description?: string;
-    hidden?: boolean;
+    description?: string | undefined;
+    hidden?: boolean | undefined;
     name: string;
 }

package/lib/main.js

@@ -11,7 +11,7 @@ const help_1 = require("./help");
 const logger_1 = require("./logger");
 const performance_1 = require("./performance");
 const symbols_1 = require("./symbols");
-const ux_1 = __importDefault(require("./ux"));
+const ux_1 = require("./ux");
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.isSingleCommandCLI)
         return true;
@@ -69,7 +69,7 @@ async function run(argv, options) {
     await config.runHook('init', { argv: argvSlice, id });
     // display version if applicable
     if ((0, exports.versionAddition)(argv, config)) {
-        ux_1.default.stdout(config.userAgent);
+        ux_1.ux.stdout(config.userAgent);
         await collectPerf();
         return;
     }

package/lib/parser/errors.d.ts

@@ -3,7 +3,7 @@ import { Arg, ArgInput, CLIParseErrorOptions, OptionFlag } from '../interfaces/p
 export { CLIError } from '../errors';
 export type Validation = {
     name: string;
-    reason?: string;
+    reason?: string | undefined;
     status: 'failed' | 'success';
     validationFn: string;
 };

package/lib/settings.d.ts

@@ -5,19 +5,19 @@ export type Settings = {
      * Environment Variable:
      *   OCLIF_COLUMNS=80
      */
-    columns?: number;
+    columns?: number | undefined;
     /**
      * Show additional debug output without DEBUG. Mainly shows stackstraces.
      *
      * Useful to set in the ./bin/dev.js script.
      * oclif.settings.debug = true;
      */
-    debug?: boolean;
+    debug?: boolean | undefined;
     /**
      * Enable performance tracking. Resulting data is available in the `perf` property of the `Config` class.
      * This will be overridden by the `enablePerf` property passed into Config constructor.
      */
-    performanceEnabled?: boolean;
+    performanceEnabled?: boolean | undefined;
     /**
      * Try to use ts-node to load typescript source files instead of javascript files.
      * Defaults to true in development and test environments (e.g. using bin/dev.js or
@@ -25,12 +25,12 @@ export type Settings = {
      *
      * @deprecated use enableAutoTranspile instead.
      */
-    tsnodeEnabled?: boolean;
+    tsnodeEnabled?: boolean | undefined;
     /**
      * Enable automatic transpilation of TypeScript files to JavaScript.
      *
      * Defaults to true in development and test environments (e.g. using bin/dev.js or NODE_ENV=development or NODE_ENV=test).
      */
-    enableAutoTranspile?: boolean;
+    enableAutoTranspile?: boolean | undefined;
 };
 export declare const settings: Settings;

package/lib/util/ids.d.ts

@@ -1,3 +1,3 @@
-import { Config } from '../interfaces';
+import { type Config } from '../interfaces/config';
 export declare function toStandardizedId(commandID: string, config: Config): string;
 export declare function toConfiguredId(commandID: string, config: Config): string;

package/lib/util/read-pjson.d.ts

@@ -4,4 +4,4 @@ import { PJSON } from '../interfaces';
  *
  * We can assume that the package.json file exists because the plugin root has already been loaded at this point.
  */
-export declare function readPjson(path: string): Promise<PJSON.Plugin>;
+export declare function readPjson(path: string): Promise<PJSON>;