@oclif/core 3.26.6 → 4.0.0-beta.10

package/lib/args.d.ts

@@ -21,14 +21,14 @@ import { Arg, ArgDefinition } from './interfaces/parser';
 export declare function custom<T = string, P = Record<string, unknown>>(defaults: Partial<Arg<T, P>>): ArgDefinition<T, P>;
 export declare const boolean: ArgDefinition<boolean, Record<string, unknown>>;
 export declare const integer: ArgDefinition<number, {
-    max?: number | undefined;
-    min?: number | undefined;
+    max?: number;
+    min?: number;
 }>;
 export declare const directory: ArgDefinition<string, {
-    exists?: boolean | undefined;
+    exists?: boolean;
 }>;
 export declare const file: ArgDefinition<string, {
-    exists?: boolean | undefined;
+    exists?: boolean;
 }>;
 /**
  * Initializes a string as a URL. Throws an error

package/lib/cache.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config/config';
-import { PJSON, Plugin } from './interfaces';
+import { OclifConfiguration, Plugin } from './interfaces';
 type OclifCoreInfo = {
     name: string;
     version: string;
@@ -7,7 +7,7 @@ type OclifCoreInfo = {
 type CacheContents = {
     rootPlugin: Plugin;
     config: Config;
-    exitCodes: PJSON.Plugin['oclif']['exitCodes'];
+    exitCodes: OclifConfiguration['exitCodes'];
     '@oclif/core': OclifCoreInfo;
 };
 type ValueOf<T> = T[keyof T];
@@ -21,7 +21,7 @@ export default class Cache extends Map<keyof CacheContents, ValueOf<CacheContent
     get(key: 'config'): Config | undefined;
     get(key: '@oclif/core'): OclifCoreInfo;
     get(key: 'rootPlugin'): Plugin | undefined;
-    get(key: 'exitCodes'): PJSON.Plugin['oclif']['exitCodes'] | undefined;
+    get(key: 'exitCodes'): OclifConfiguration['exitCodes'] | undefined;
     private getOclifCoreMeta;
 }
 export {};

package/lib/cache.js

@@ -28,7 +28,7 @@ class Cache extends Map {
             try {
                 return {
                     name: '@oclif/core',
-                    version: JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, '..', 'package.json'), 'utf8')),
+                    version: JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, '..', 'package.json'), 'utf8')).version,
                 };
             }
             catch {

package/lib/command.d.ts

@@ -109,7 +109,7 @@ export declare abstract class Command {
     log(message?: string, ...args: any[]): void;
     protected logJson(json: unknown): void;
     logToStderr(message?: string, ...args: any[]): void;
-    protected parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(options?: Input<F, B, A>, argv?: string[]): Promise<ParserOutput<F, B, A>>;
+    protected parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(options?: Input<F, B, A>, argv?: string[]): Promise<ParserOutput<F, A>>;
     protected toErrorJson(err: unknown): any;
     protected toSuccessJson(result: unknown): any;
     warn(input: Error | string): Error | string;
@@ -143,15 +143,15 @@ export declare namespace Command {
      */
     type Cached = {
         [key: string]: unknown;
-        aliasPermutations?: string[];
+        aliasPermutations?: string[] | undefined;
         aliases: string[];
         args: {
             [name: string]: Arg.Cached;
         };
-        deprecateAliases?: boolean;
-        deprecationOptions?: Deprecation;
-        description?: string;
-        examples?: Example[];
+        deprecateAliases?: boolean | undefined;
+        deprecationOptions?: Deprecation | undefined;
+        description?: string | undefined;
+        examples?: Example[] | undefined;
         flags: {
             [name: string]: Flag.Cached;
         };
@@ -159,22 +159,22 @@ export declare namespace Command {
         hidden: boolean;
         hiddenAliases: string[];
         id: string;
-        isESM?: boolean;
-        permutations?: string[];
-        pluginAlias?: string;
-        pluginName?: string;
-        pluginType?: string;
-        relativePath?: string[];
-        state?: 'beta' | 'deprecated' | string;
-        strict?: boolean;
-        summary?: string;
-        type?: string;
-        usage?: string | string[];
+        isESM?: boolean | undefined;
+        permutations?: string[] | undefined;
+        pluginAlias?: string | undefined;
+        pluginName?: string | undefined;
+        pluginType?: string | undefined;
+        relativePath?: string[] | undefined;
+        state?: 'beta' | 'deprecated' | string | undefined;
+        strict?: boolean | undefined;
+        summary?: string | undefined;
+        type?: string | undefined;
+        usage?: string | string[] | undefined;
     };
     type Flag = IFlag<any>;
     namespace Flag {
         type Cached = Omit<Flag, 'input' | 'parse'> & (BooleanFlagProps | OptionFlagProps) & {
-            hasDynamicHelp?: boolean;
+            hasDynamicHelp?: boolean | undefined;
         };
         type Any = Cached | Flag;
     }

package/lib/command.js

@@ -27,18 +27,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Command = void 0;
-const chalk_1 = __importDefault(require("chalk"));
+const ansis_1 = __importDefault(require("ansis"));
 const node_url_1 = require("node:url");
 const node_util_1 = require("node:util");
 const cache_1 = __importDefault(require("./cache"));
-const cli_ux_1 = require("./cli-ux");
 const config_1 = require("./config");
 const Errors = __importStar(require("./errors"));
 const util_1 = require("./help/util");
+const logger_1 = require("./logger");
 const Parser = __importStar(require("./parser"));
 const aggregate_flags_1 = require("./util/aggregate-flags");
 const ids_1 = require("./util/ids");
 const util_2 = require("./util/util");
+const ux_1 = require("./ux");
 const pjson = cache_1.default.getInstance().get('@oclif/core');
 /**
  * swallows stdout epipe errors
@@ -123,7 +124,7 @@ class Command {
         this.config = config;
         this.id = this.ctor.id;
         try {
-            this.debug = require('debug')(this.id ? `${this.config.bin}:${this.id}` : this.config.bin);
+            this.debug = (0, logger_1.makeDebug)(this.id ? `${this.config.bin}:${this.id}` : this.config.bin);
         }
         catch {
             this.debug = () => {
@@ -147,6 +148,9 @@ class Command {
             opts = (0, node_url_1.fileURLToPath)(opts);
         }
         const config = await config_1.Config.load(opts || require.main?.filename || __dirname);
+        const cache = cache_1.default.getInstance();
+        if (!cache.has('config'))
+            cache.set('config', config);
         const cmd = new this(argv, config);
         if (!cmd.id) {
             const id = cmd.constructor.name.toLowerCase();
@@ -167,7 +171,7 @@ class Command {
             if (!err.message)
                 throw err;
             try {
-                cli_ux_1.ux.action.stop(chalk_1.default.bold.red('!'));
+                ux_1.ux.action.stop(ansis_1.default.bold.red('!'));
             }
             catch { }
             throw err;
@@ -179,22 +183,9 @@ class Command {
     exit(code = 0) {
         Errors.exit(code);
     }
-    async finally(_) {
-        try {
-            const { config } = Errors;
-            if (config.errorLogger)
-                await config.errorLogger.flush();
-        }
-        catch (error) {
-            console.error(error);
-        }
-    }
+    async finally(_) { }
     async init() {
         this.debug('init version: %s argv: %o', this.ctor._base, this.argv);
-        if (this.config.debug)
-            Errors.config.debug = true;
-        if (this.config.errlog)
-            Errors.config.errlog = this.config.errlog;
         const g = global;
         g['http-call'] = g['http-call'] || {};
         g['http-call'].userAgent = this.config.userAgent;
@@ -223,16 +214,16 @@ class Command {
     log(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, node_util_1.inspect)(message);
-            cli_ux_1.ux.info(message, ...args);
+            ux_1.ux.stdout(message, ...args);
         }
     }
     logJson(json) {
-        cli_ux_1.ux.styledJSON(json);
+        ux_1.ux.stdout(ux_1.ux.colorizeJson(json, { pretty: true, theme: this.config.theme?.json }));
     }
     logToStderr(message = '', ...args) {
         if (!this.jsonEnabled()) {
             message = typeof message === 'string' ? message : (0, node_util_1.inspect)(message);
-            cli_ux_1.ux.logToStderr(message, ...args);
+            ux_1.ux.stderr(message, ...args);
         }
     }
     async parse(options, argv = this.argv) {

package/lib/config/config.d.ts

@@ -1,5 +1,5 @@
 import { Command } from '../command';
-import { Hook, Hooks, PJSON, Topic } from '../interfaces';
+import { Hook, Hooks, OclifConfiguration, PJSON, S3Templates, Topic, UserPJSON } from '../interfaces';
 import { ArchTypes, Config as IConfig, LoadOptions, PlatformTypes, VersionDetails } from '../interfaces/config';
 import { Plugin as IPlugin, Options } from '../interfaces/plugin';
 import { Theme } from '../interfaces/theme';
@@ -7,30 +7,29 @@ export declare class Config implements IConfig {
     options: Options;
     arch: ArchTypes;
     bin: string;
-    binAliases?: string[];
-    binPath?: string;
+    binAliases?: string[] | undefined;
+    binPath?: string | undefined;
     cacheDir: string;
     channel: string;
     configDir: string;
     dataDir: string;
-    debug: number;
     dirname: string;
-    errlog: string;
     flexibleTaxonomy: boolean;
     home: string;
     isSingleCommandCLI: boolean;
     name: string;
-    npmRegistry?: string;
-    nsisCustomization?: string;
-    pjson: PJSON.CLI;
+    npmRegistry?: string | undefined;
+    nsisCustomization?: string | undefined;
+    pjson: PJSON;
     platform: PlatformTypes;
     plugins: Map<string, IPlugin>;
     root: string;
     shell: string;
-    theme?: Theme;
+    theme?: Theme | undefined;
     topicSeparator: ' ' | ':';
+    updateConfig: NonNullable<OclifConfiguration['update']>;
     userAgent: string;
-    userPJSON?: PJSON.User;
+    userPJSON?: UserPJSON | undefined;
     valid: boolean;
     version: string;
     protected warned: boolean;
@@ -93,14 +92,11 @@ export declare class Config implements IConfig {
     loadPluginsAndCommands(opts?: {
         force: boolean;
     }): Promise<void>;
-    loadThemes(): Promise<{
-        file: string | undefined;
-        theme: Theme | undefined;
-    }>;
+    loadTheme(): Promise<Theme | undefined>;
     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;
+    s3Key(type: keyof S3Templates, ext?: '.tar.gz' | '.tar.xz' | IConfig.s3Key.Options, options?: IConfig.s3Key.Options): string;
     s3Url(key: string): string;
     scopedEnvVar(k: string): string | undefined;
     /**
@@ -116,35 +112,11 @@ export declare class Config implements IConfig {
      */
     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 _debug(): number;
     protected _shell(): string;
-    /**
-     * 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;
+    private buildS3Config;
     private getCmdLookupId;
     private getTopicLookupId;
     /**
@@ -160,4 +132,6 @@ export declare class Config implements IConfig {
     private isJitPluginCommand;
     private loadCommands;
     private loadTopics;
+    private maybeAdjustDebugSetting;
+    private warn;
 }