@oclif/core 4.0.0-beta.2 → 4.0.0-beta.4

package/lib/command.js

@@ -34,6 +34,7 @@ const cache_1 = __importDefault(require("./cache"));
 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");
@@ -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 = () => {
@@ -179,22 +180,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;

package/lib/config/config.d.ts

@@ -13,9 +13,7 @@ export declare class Config implements IConfig {
     channel: string;
     configDir: string;
     dataDir: string;
-    debug: number;
     dirname: string;
-    errlog: string;
     flexibleTaxonomy: boolean;
     home: string;
     isSingleCommandCLI: boolean;
@@ -114,14 +112,9 @@ 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;
     private buildS3Config;
     /**
@@ -159,4 +152,6 @@ export declare class Config implements IConfig {
     private isJitPluginCommand;
     private loadCommands;
     private loadTopics;
+    private maybeAdjustDebugSetting;
+    private warn;
 }

package/lib/config/config.js

@@ -35,6 +35,7 @@ const node_url_1 = require("node:url");
 const cache_1 = __importDefault(require("../cache"));
 const errors_1 = require("../errors");
 const util_1 = require("../help/util");
+const logger_1 = require("../logger");
 const module_loader_1 = require("../module-loader");
 const performance_1 = require("../performance");
 const settings_1 = require("../settings");
@@ -46,11 +47,19 @@ const theme_1 = require("../ux/theme");
 const plugin_loader_1 = __importDefault(require("./plugin-loader"));
 const ts_path_1 = require("./ts-path");
 const util_3 = require("./util");
-// eslint-disable-next-line new-cap
-const debug = (0, util_3.Debug)();
+const debug = (0, util_3.makeDebug)();
 const _pjson = cache_1.default.getInstance().get('@oclif/core');
 const BASE = `${_pjson.name}@${_pjson.version}`;
 const ROOT_ONLY_HOOKS = new Set(['preparse']);
+function displayWarnings() {
+    if (process.listenerCount('warning') > 1)
+        return;
+    process.on('warning', (warning) => {
+        console.error(warning.stack);
+        if (warning.detail)
+            console.error(warning.detail);
+    });
+}
 function channelFromVersion(version) {
     const m = version.match(/[^-]+(?:-([^.]+))?/);
     return (m && m[1]) || 'stable';
@@ -94,9 +103,7 @@ class Config {
     channel;
     configDir;
     dataDir;
-    debug = 0;
     dirname;
-    errlog;
     flexibleTaxonomy;
     home;
     isSingleCommandCLI = false;
@@ -129,6 +136,7 @@ class Config {
         this.options = options;
     }
     static async load(opts = module.filename || __dirname) {
+        (0, logger_1.setLogger)(opts);
         // Handle the case when a file URL string is passed in such as 'import.meta.url'; covert to file path.
         if (typeof opts === 'string' && opts.startsWith('file://')) {
             opts = (0, node_url_1.fileURLToPath)(opts);
@@ -263,6 +271,9 @@ class Config {
     async load() {
         settings_1.settings.performanceEnabled =
             (settings_1.settings.performanceEnabled === undefined ? this.options.enablePerf : settings_1.settings.performanceEnabled) ?? false;
+        if (settings_1.settings.debug)
+            displayWarnings();
+        (0, logger_1.setLogger)(this.options);
         const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, 'config.load');
         this.pluginLoader = new plugin_loader_1.default({ plugins: this.options.plugins, root: this.options.root });
         this.rootPlugin = await this.pluginLoader.loadRoot({ pjson: this.options.pjson });
@@ -295,12 +306,10 @@ class Config {
             this.dirname = this.dirname.replace('/', '\\');
         this.userAgent = `${this.name}/${this.version} ${this.platform}-${this.arch} node-${process.version}`;
         this.shell = this._shell();
-        this.debug = this._debug();
         this.home = process.env.HOME || (this.windows && this.windowsHome()) || (0, os_1.getHomeDir)() || (0, node_os_1.tmpdir)();
         this.cacheDir = this.scopedEnvVar('CACHE_DIR') || this.macosCacheDir() || this.dir('cache');
         this.configDir = this.scopedEnvVar('CONFIG_DIR') || this.dir('config');
         this.dataDir = this.scopedEnvVar('DATA_DIR') || this.dir('data');
-        this.errlog = (0, node_path_1.join)(this.cacheDir, 'error.log');
         this.binPath = this.scopedEnvVar('BINPATH');
         this.npmRegistry = this.scopedEnvVar('NPM_REGISTRY') || this.pjson.oclif.npmRegistry;
         this.theme = await this.loadTheme();
@@ -313,6 +322,7 @@ class Config {
             (typeof this.pjson.oclif.commands !== 'string' &&
                 this.pjson.oclif.commands?.strategy === 'single' &&
                 this.pjson.oclif.commands?.target));
+        this.maybeAdjustDebugSetting();
         await this.loadPluginsAndCommands();
         debug('config done');
         marker?.addDetails({
@@ -447,7 +457,7 @@ class Config {
         };
         const plugins = ROOT_ONLY_HOOKS.has(event) ? [this.rootPlugin] : [...this.plugins.values()];
         const promises = plugins.map(async (p) => {
-            const debug = require('debug')([this.bin, p.name, 'hooks', event].join(':'));
+            const debug = (0, logger_1.makeDebug)([p.name, 'hooks', event].join(':'));
             const context = {
                 config: this,
                 debug,
@@ -557,40 +567,6 @@ class Config {
         const v = this.scopedEnvVar(k);
         return v === '1' || v === 'true';
     }
-    warn(err, scope) {
-        if (this.warned)
-            return;
-        if (typeof err === 'string') {
-            process.emitWarning(err);
-            return;
-        }
-        if (err instanceof Error) {
-            const modifiedErr = err;
-            modifiedErr.name = `${err.name} Plugin: ${this.name}`;
-            modifiedErr.detail = (0, util_2.compact)([
-                err.detail,
-                `module: ${this._base}`,
-                scope && `task: ${scope}`,
-                `plugin: ${this.name}`,
-                `root: ${this.root}`,
-                'See more details with DEBUG=*',
-            ]).join('\n');
-            process.emitWarning(err);
-            return;
-        }
-        // err is an object
-        process.emitWarning('Config.warn expected either a string or Error, but instead received an object');
-        err.name = `${err.name} Plugin: ${this.name}`;
-        err.detail = (0, util_2.compact)([
-            err.detail,
-            `module: ${this._base}`,
-            scope && `task: ${scope}`,
-            `plugin: ${this.name}`,
-            `root: ${this.root}`,
-            'See more details with DEBUG=*',
-        ]).join('\n');
-        process.emitWarning(JSON.stringify(err));
-    }
     windowsHome() {
         return this.windowsHomedriveHome() || this.windowsUserprofileHome();
     }
@@ -600,17 +576,6 @@ class Config {
     windowsUserprofileHome() {
         return process.env.USERPROFILE;
     }
-    _debug() {
-        if (this.scopedEnvVarTrue('DEBUG'))
-            return 1;
-        try {
-            const { enabled } = require('debug')(this.bin);
-            if (enabled)
-                return 1;
-        }
-        catch { }
-        return 0;
-    }
     _shell() {
         let shellPath;
         const { COMSPEC } = process.env;
@@ -828,5 +793,45 @@ class Config {
         }
         marker?.stop();
     }
+    maybeAdjustDebugSetting() {
+        if (this.scopedEnvVarTrue('DEBUG')) {
+            settings_1.settings.debug = true;
+            displayWarnings();
+        }
+    }
+    warn(err, scope) {
+        if (this.warned)
+            return;
+        if (typeof err === 'string') {
+            process.emitWarning(err);
+            return;
+        }
+        if (err instanceof Error) {
+            const modifiedErr = err;
+            modifiedErr.name = `${err.name} Plugin: ${this.name}`;
+            modifiedErr.detail = (0, util_2.compact)([
+                err.detail,
+                `module: ${this._base}`,
+                scope && `task: ${scope}`,
+                `plugin: ${this.name}`,
+                `root: ${this.root}`,
+                'See more details with DEBUG=*',
+            ]).join('\n');
+            process.emitWarning(err);
+            return;
+        }
+        // err is an object
+        process.emitWarning('Config.warn expected either a string or Error, but instead received an object');
+        err.name = `${err.name} Plugin: ${this.name}`;
+        err.detail = (0, util_2.compact)([
+            err.detail,
+            `module: ${this._base}`,
+            scope && `task: ${scope}`,
+            `plugin: ${this.name}`,
+            `root: ${this.root}`,
+            'See more details with DEBUG=*',
+        ]).join('\n');
+        process.emitWarning(JSON.stringify(err));
+    }
 }
 exports.Config = Config;

package/lib/config/plugin-loader.js

@@ -30,8 +30,7 @@ const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
 const Plugin = __importStar(require("./plugin"));
 const util_2 = require("./util");
-// eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)();
+const debug = (0, util_2.makeDebug)();
 function findMatchingDependencies(dependencies, patterns) {
     return Object.keys(dependencies).filter((p) => patterns.some((w) => (0, minimatch_1.minimatch)(p, w)));
 }

package/lib/config/plugin.js

@@ -104,8 +104,7 @@ class Plugin {
     valid = false;
     version;
     _base = `${_pjson.name}@${_pjson.version}`;
-    // eslint-disable-next-line new-cap
-    _debug = (0, util_2.Debug)();
+    _debug = (0, util_2.makeDebug)();
     commandCache;
     commandDiscoveryOpts;
     flexibleTaxonomy;
@@ -190,8 +189,7 @@ class Plugin {
         this.alias = this.options.name ?? this.pjson.name;
         if (!this.name)
             throw new errors_1.CLIError(`no name in package.json (${root})`);
-        // eslint-disable-next-line new-cap
-        this._debug = (0, util_2.Debug)(this.name);
+        this._debug = (0, util_2.makeDebug)(this.name);
         this.version = this.pjson.version;
         if (this.pjson.oclif) {
             this.valid = true;

package/lib/config/ts-path.js

@@ -13,8 +13,7 @@ const fs_1 = require("../util/fs");
 const read_tsconfig_1 = require("../util/read-tsconfig");
 const util_1 = require("../util/util");
 const util_2 = require("./util");
-// eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)('ts-path');
+const debug = (0, util_2.makeDebug)('ts-path');
 exports.TS_CONFIGS = {};
 const REGISTERED = new Set();
 function determineRuntime() {

package/lib/config/util.d.ts

@@ -1,4 +1,4 @@
-export declare function Debug(...scope: string[]): (..._: any) => void;
+export declare function makeDebug(...scope: string[]): (..._: any) => void;
 export declare function getPermutations(arr: string[]): Array<string[]>;
 export declare function getCommandIdPermutations(commandId: string): string[];
 /**

package/lib/config/util.js

@@ -1,27 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.Debug = void 0;
-const debug = require('debug');
-function displayWarnings() {
-    if (process.listenerCount('warning') > 1)
-        return;
-    process.on('warning', (warning) => {
-        console.error(warning.stack);
-        if (warning.detail)
-            console.error(warning.detail);
-    });
+exports.collectUsableIds = exports.getCommandIdPermutations = exports.getPermutations = exports.makeDebug = void 0;
+const logger_1 = require("../logger");
+function makeDebug(...scope) {
+    return (formatter, ...args) => (0, logger_1.getLogger)(['config', ...scope].join(':')).debug(formatter, ...args);
 }
-function Debug(...scope) {
-    if (!debug)
-        return (..._) => {
-            // noop
-        };
-    const d = debug(['config', ...scope].join(':'));
-    if (d.enabled)
-        displayWarnings();
-    return (...args) => d(...args);
-}
-exports.Debug = Debug;
+exports.makeDebug = makeDebug;
 // Adapted from https://github.com/angus-c/just/blob/master/packages/array-permutations/index.js
 function getPermutations(arr) {
     if (arr.length === 0)

package/lib/errors/error.js

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.error = void 0;
+const logger_1 = require("../logger");
 const write_1 = require("../ux/write");
-const config_1 = require("./config");
 const cli_1 = require("./errors/cli");
 const pretty_print_1 = __importStar(require("./errors/pretty-print"));
 function error(input, options = {}) {
@@ -44,8 +44,8 @@ function error(input, options = {}) {
         const message = (0, pretty_print_1.default)(err);
         if (message)
             (0, write_1.stderr)(message);
-        if (config_1.config.errorLogger)
-            config_1.config.errorLogger.log(err?.stack ?? '');
+        if (err?.stack)
+            (0, logger_1.getLogger)().error(err.stack);
     }
     else
         throw err;

package/lib/errors/errors/cli.js

@@ -10,7 +10,7 @@ const indent_string_1 = __importDefault(require("indent-string"));
 const wrap_ansi_1 = __importDefault(require("wrap-ansi"));
 const cache_1 = __importDefault(require("../../cache"));
 const screen_1 = require("../../screen");
-const config_1 = require("../config");
+const settings_1 = require("../../settings");
 /**
  * properties specific to internal oclif error handling
  */
@@ -48,7 +48,7 @@ class CLIError extends Error {
      * @return {string} returns a string representing the dispay of the error
      */
     render() {
-        if (config_1.config.debug) {
+        if (settings_1.settings.debug) {
             return this.stack;
         }
         let output = `${this.name}: ${this.message}`;

package/lib/errors/errors/pretty-print.js

@@ -7,7 +7,7 @@ exports.applyPrettyPrintOptions = void 0;
 const indent_string_1 = __importDefault(require("indent-string"));
 const wrap_ansi_1 = __importDefault(require("wrap-ansi"));
 const screen_1 = require("../../screen");
-const config_1 = require("../config");
+const settings_1 = require("../../settings");
 function applyPrettyPrintOptions(error, options) {
     const prettyErrorKeys = ['message', 'code', 'ref', 'suggestions'];
     for (const key of prettyErrorKeys) {
@@ -30,7 +30,7 @@ const formatSuggestions = (suggestions) => {
     return `${label}\n${(0, indent_string_1.default)(multiple, 2)}`;
 };
 function prettyPrint(error) {
-    if (config_1.config.debug) {
+    if (settings_1.settings.debug) {
         return error.stack;
     }
     const { bang, code, message, name: errorSuffix, ref, suggestions } = error;

package/lib/errors/handle.js

@@ -7,7 +7,7 @@ exports.handle = exports.Exit = void 0;
 const clean_stack_1 = __importDefault(require("clean-stack"));
 const cache_1 = __importDefault(require("../cache"));
 const index_1 = require("../help/index");
-const config_1 = require("./config");
+const logger_1 = require("../logger");
 const cli_1 = require("./errors/cli");
 const exit_1 = require("./errors/exit");
 const pretty_print_1 = __importDefault(require("./errors/pretty-print"));
@@ -46,17 +46,10 @@ async function handle(err) {
             }
         }
         const exitCode = err.oclif?.exit ?? 1;
-        if (config_1.config.errorLogger && err.code !== 'EEXIT') {
-            if (stack) {
-                config_1.config.errorLogger.log(stack);
-            }
-            await config_1.config.errorLogger
-                .flush()
-                .then(() => exports.Exit.exit(exitCode))
-                .catch(console.error);
+        if (err.code !== 'EEXIT' && stack) {
+            (0, logger_1.getLogger)().error(stack);
         }
-        else
-            exports.Exit.exit(exitCode);
+        exports.Exit.exit(exitCode);
     }
     catch (error) {
         console.error(err.stack);

package/lib/errors/index.d.ts

@@ -1,10 +1,8 @@
 export { PrettyPrintableError } from '../interfaces';
-export { config } from './config';
 export { error } from './error';
 export { CLIError } from './errors/cli';
 export { ExitError } from './errors/exit';
 export { ModuleLoadError } from './errors/module-load';
 export { exit } from './exit';
 export { handle } from './handle';
-export { Logger } from './logger';
 export { warn } from './warn';

package/lib/errors/index.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.warn = exports.Logger = exports.handle = exports.exit = exports.ModuleLoadError = exports.ExitError = exports.CLIError = exports.error = exports.config = void 0;
-var config_1 = require("./config");
-Object.defineProperty(exports, "config", { enumerable: true, get: function () { return config_1.config; } });
+exports.warn = exports.handle = exports.exit = exports.ModuleLoadError = exports.ExitError = exports.CLIError = exports.error = void 0;
 var error_1 = require("./error");
 Object.defineProperty(exports, "error", { enumerable: true, get: function () { return error_1.error; } });
 var cli_1 = require("./errors/cli");
@@ -15,7 +13,5 @@ var exit_2 = require("./exit");
 Object.defineProperty(exports, "exit", { enumerable: true, get: function () { return exit_2.exit; } });
 var handle_1 = require("./handle");
 Object.defineProperty(exports, "handle", { enumerable: true, get: function () { return handle_1.handle; } });
-var logger_1 = require("./logger");
-Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
 var warn_1 = require("./warn");
 Object.defineProperty(exports, "warn", { enumerable: true, get: function () { return warn_1.warn; } });

package/lib/errors/warn.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.warn = void 0;
+const logger_1 = require("../logger");
 const write_1 = require("../ux/write");
-const config_1 = require("./config");
 const cli_1 = require("./errors/cli");
 const pretty_print_1 = __importDefault(require("./errors/pretty-print"));
 const WARNINGS = new Set();
@@ -33,8 +33,8 @@ function warn(input, options) {
     const message = (0, pretty_print_1.default)(err);
     if (message)
         (0, write_1.stderr)(message);
-    if (config_1.config.errorLogger)
-        config_1.config.errorLogger.log(err?.stack ?? '');
+    if (err?.stack)
+        (0, logger_1.getLogger)().error(err.stack);
 }
 exports.warn = warn;
 exports.default = warn;

package/lib/index.d.ts

@@ -10,6 +10,7 @@ export { CommandHelp, Help, HelpBase, loadHelpClass } from './help';
 export { HelpSection, HelpSectionKeyValueTable, HelpSectionRenderer } from './help/formatter';
 export * as Interfaces from './interfaces';
 export { Hook } from './interfaces/hooks';
+export { getLogger } from './logger';
 export { run } from './main';
 export * as ModuleLoader from './module-loader';
 export * as Parser from './parser';

package/lib/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ux = exports.toStandardizedId = exports.toConfiguredId = exports.settings = exports.Performance = exports.Parser = exports.ModuleLoader = exports.run = exports.Interfaces = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.flush = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.Args = void 0;
+exports.ux = exports.toStandardizedId = exports.toConfiguredId = exports.settings = exports.Performance = exports.Parser = exports.ModuleLoader = exports.run = exports.getLogger = exports.Interfaces = exports.loadHelpClass = exports.HelpBase = exports.Help = exports.CommandHelp = exports.flush = exports.Flags = exports.execute = exports.handle = exports.Errors = exports.Plugin = exports.Config = exports.Command = exports.Args = void 0;
 function checkCWD() {
     try {
         process.cwd();
@@ -55,6 +55,8 @@ Object.defineProperty(exports, "Help", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "HelpBase", { enumerable: true, get: function () { return help_1.HelpBase; } });
 Object.defineProperty(exports, "loadHelpClass", { enumerable: true, get: function () { return help_1.loadHelpClass; } });
 exports.Interfaces = __importStar(require("./interfaces"));
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return logger_1.getLogger; } });
 var main_1 = require("./main");
 Object.defineProperty(exports, "run", { enumerable: true, get: function () { return main_1.run; } });
 exports.ModuleLoader = __importStar(require("./module-loader"));

package/lib/interfaces/config.d.ts

@@ -57,22 +57,10 @@ 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
      */
     readonly dirname: string;
-    /**
-     * points to a file that should be appended to for error logs
-     *
-     * example: ~/Library/Caches/mycli/error.log
-     */
-    readonly errlog: string;
     findCommand(id: string, opts: {
         must: true;
     }): Command.Loadable;

package/lib/interfaces/index.d.ts

@@ -5,6 +5,7 @@ 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 { Logger } from './logger';
 export type { Manifest } from './manifest';
 export type { Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, OptionFlag } from './parser';
 export type { PJSON } from './pjson';

package/lib/interfaces/logger.d.ts

@@ -0,0 +1,9 @@
+export type Logger = {
+    debug: (formatter: unknown, ...args: unknown[]) => void;
+    error: (formatter: unknown, ...args: unknown[]) => void;
+    info: (formatter: unknown, ...args: unknown[]) => void;
+    trace: (formatter: unknown, ...args: unknown[]) => void;
+    warn: (formatter: unknown, ...args: unknown[]) => void;
+    child: (namespace: string) => Logger;
+    namespace: string;
+};

package/lib/interfaces/logger.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/plugin.d.ts

@@ -1,4 +1,5 @@
 import { Command } from '../command';
+import { Logger } from './logger';
 import { HookOptions, PJSON } from './pjson';
 import { Topic } from './topic';
 export interface PluginOptions {
@@ -21,6 +22,7 @@ export interface Options extends PluginOptions {
     devPlugins?: boolean;
     enablePerf?: boolean;
     jitPlugins?: boolean;
+    logger?: Logger;
     pjson?: PJSON.Plugin;
     pluginAdditions?: {
         core?: string[];

package/lib/logger.d.ts

@@ -0,0 +1,14 @@
+import { LoadOptions } from './interfaces/config';
+import { Logger } from './interfaces/logger';
+/**
+ * Returns a logger instance for the given namespace.
+ * If a namespace is provided, a child logger is returned.
+ * If no namespace is provided, the root logger is returned.
+ */
+export declare function getLogger(namespace?: string): Logger;
+/**
+ * Convenience function to create a debug function for a specific namespace
+ */
+export declare function makeDebug(namespace: string): Logger['debug'];
+export declare function setLogger(loadOptions: LoadOptions): void;
+export declare function clearLoggers(): void;

package/lib/logger.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearLoggers = exports.setLogger = exports.makeDebug = exports.getLogger = void 0;
+const debug_1 = __importDefault(require("debug"));
+const OCLIF_NS = 'oclif';
+function makeLogger(namespace = OCLIF_NS) {
+    const debug = (0, debug_1.default)(namespace);
+    return {
+        child: (ns, delimiter) => makeLogger(`${namespace}${delimiter ?? ':'}${ns}`),
+        debug,
+        error: (formatter, ...args) => makeLogger(`${namespace}:error`).debug(formatter, ...args),
+        info: debug,
+        namespace,
+        trace: debug,
+        warn: debug,
+    };
+}
+/**
+ * Cache of logger instances. This is used to prevent creating multiple logger instances for the same namespace.
+ *
+ * The root logger is stored under the 'root' key as well as it's namespace.
+ */
+const cachedLoggers = new Map();
+/**
+ * Returns a logger instance for the given namespace.
+ * If a namespace is provided, a child logger is returned.
+ * If no namespace is provided, the root logger is returned.
+ */
+function getLogger(namespace) {
+    let rootLogger = cachedLoggers.get('root');
+    if (!rootLogger) {
+        set(makeLogger(OCLIF_NS));
+    }
+    rootLogger = cachedLoggers.get('root');
+    if (namespace) {
+        const cachedLogger = cachedLoggers.get(namespace);
+        if (cachedLogger)
+            return cachedLogger;
+        const logger = rootLogger.child(namespace);
+        cachedLoggers.set(namespace, logger);
+        return logger;
+    }
+    return rootLogger;
+}
+exports.getLogger = getLogger;
+function ensureItMatchesInterface(newLogger) {
+    return (typeof newLogger.child === 'function' &&
+        typeof newLogger.debug === 'function' &&
+        typeof newLogger.error === 'function' &&
+        typeof newLogger.info === 'function' &&
+        typeof newLogger.trace === 'function' &&
+        typeof newLogger.warn === 'function' &&
+        typeof newLogger.namespace === 'string');
+}
+function set(newLogger) {
+    if (cachedLoggers.has(newLogger.namespace))
+        return;
+    if (cachedLoggers.has('root'))
+        return;
+    if (ensureItMatchesInterface(newLogger)) {
+        cachedLoggers.set(newLogger.namespace, newLogger);
+        cachedLoggers.set('root', newLogger);
+    }
+    else {
+        process.emitWarning('Logger does not match the Logger interface. Using default logger.');
+    }
+}
+/**
+ * Convenience function to create a debug function for a specific namespace
+ */
+function makeDebug(namespace) {
+    return (formatter, ...args) => getLogger(namespace).debug(formatter, ...args);
+}
+exports.makeDebug = makeDebug;
+function setLogger(loadOptions) {
+    if (loadOptions && typeof loadOptions !== 'string' && 'logger' in loadOptions && loadOptions.logger) {
+        set(loadOptions.logger);
+    }
+    else {
+        set(makeLogger(OCLIF_NS));
+    }
+}
+exports.setLogger = setLogger;
+function clearLoggers() {
+    cachedLoggers.clear();
+}
+exports.clearLoggers = clearLoggers;

package/lib/main.js

@@ -8,10 +8,10 @@ const node_url_1 = require("node:url");
 const cache_1 = __importDefault(require("./cache"));
 const config_1 = require("./config");
 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 debug = require('debug')('oclif:main');
 const helpAddition = (argv, config) => {
     if (argv.length === 0 && !config.isSingleCommandCLI)
         return true;
@@ -48,6 +48,8 @@ async function run(argv, options) {
         const help = new Help(config, config.pjson.oclif.helpOptions ?? config.pjson.helpOptions);
         await help.showHelp(argv);
     };
+    (0, logger_1.setLogger)(options);
+    const { debug } = (0, logger_1.getLogger)('main');
     debug(`process.execPath: ${process.execPath}`);
     debug(`process.execArgv: ${process.execArgv}`);
     debug('process.argv: %O', process.argv);

package/lib/parser/parse.js

@@ -7,13 +7,14 @@ exports.Parser = exports.readStdin = void 0;
 /* eslint-disable no-await-in-loop */
 const node_readline_1 = require("node:readline");
 const cache_1 = __importDefault(require("../cache"));
+const logger_1 = require("../logger");
 const util_1 = require("../util/util");
 const errors_1 = require("./errors");
 let debug;
 try {
     debug =
         process.env.CLI_FLAGS_DEBUG === '1'
-            ? require('debug')('../parser')
+            ? (0, logger_1.makeDebug)('parser')
             : () => {
                 // noop
             };

package/lib/performance.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Performance = exports.OCLIF_MARKER_OWNER = void 0;
 const node_perf_hooks_1 = require("node:perf_hooks");
+const logger_1 = require("./logger");
 const settings_1 = require("./settings");
 exports.OCLIF_MARKER_OWNER = '@oclif/core';
 class Marker {
@@ -143,7 +144,7 @@ class Performance {
     static debug() {
         if (!Performance.enabled)
             return;
-        const oclifDebug = require('debug')('oclif-perf');
+        const oclifDebug = (0, logger_1.makeDebug)('perf');
         const processUpTime = (process.uptime() * 1000).toFixed(4);
         oclifDebug('Process Uptime: %sms', processUpTime);
         oclifDebug('Oclif Time: %sms', Performance.oclifPerf['oclif.runMs'].toFixed(4));
@@ -176,7 +177,7 @@ class Performance {
         if (Performance.oclifPerf['oclif.configLoadMs'] > Performance.oclifPerf['oclif.runMs']) {
             oclifDebug('! Config load time is greater than total oclif time. This might mean that Config was instantiated before oclif was run.');
         }
-        const nonCoreDebug = require('debug')('non-oclif-perf');
+        const nonCoreDebug = (0, logger_1.makeDebug)('non-oclif-perf');
         const nonCorePerf = Performance.results;
         if (nonCorePerf.size > 0) {
             nonCoreDebug('Non-Core Performance Measurements:');

package/lib/settings.d.ts

@@ -13,12 +13,6 @@ export type Settings = {
      * oclif.settings.debug = true;
      */
     debug?: boolean;
-    /**
-     * The path to the error.log file.
-     *
-     * NOTE: This is read-only and setting it will have no effect.
-     */
-    errlog?: string;
     /**
      * 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.

package/lib/util/find-root.d.ts

@@ -1,3 +1,4 @@
+export declare function debug(...scope: string[]): (..._: any) => void;
 /**
  * Returns the root directory of the plugin.
  *

package/lib/util/find-root.js

@@ -1,13 +1,13 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findRoot = void 0;
-const debug_1 = __importDefault(require("debug"));
+exports.findRoot = exports.debug = void 0;
 const node_path_1 = require("node:path");
+const logger_1 = require("../logger");
 const fs_1 = require("./fs");
-const debug = (0, debug_1.default)('find-root');
+function debug(...scope) {
+    return (formatter, ...args) => (0, logger_1.getLogger)(['find-root', ...scope].join(':')).debug(formatter, ...args);
+}
+exports.debug = debug;
 // essentially just "cd .."
 function* up(from) {
     while ((0, node_path_1.dirname)(from) !== from) {
@@ -25,11 +25,11 @@ function* up(from) {
 async function findPluginRoot(root, name) {
     // If we know the plugin name then we just need to traverse the file
     // system until we find the directory that matches the plugin name.
-    debug.extend(name ?? 'root-plugin')(`Finding root starting at ${root}`);
+    debug(name ?? 'root-plugin')(`Finding root starting at ${root}`);
     if (name) {
         for (const next of up(root)) {
             if (next.endsWith((0, node_path_1.basename)(name))) {
-                debug.extend(name)('Found root based on plugin name!');
+                debug(name)('Found root based on plugin name!');
                 return next;
             }
         }
@@ -44,9 +44,9 @@ async function findPluginRoot(root, name) {
         }
         try {
             const cur = (0, node_path_1.join)(next, 'package.json');
-            debug.extend(name ?? 'root-plugin')(`Checking ${cur}`);
+            debug(name ?? 'root-plugin')(`Checking ${cur}`);
             if (await (0, fs_1.safeReadJson)(cur)) {
-                debug.extend(name ?? 'root-plugin')('Found root by traversing up from starting point!');
+                debug(name ?? 'root-plugin')('Found root by traversing up from starting point!');
                 return (0, node_path_1.dirname)(cur);
             }
         }
@@ -60,7 +60,7 @@ async function findPluginRoot(root, name) {
  * See https://github.com/oclif/config/pull/289#issuecomment-983904051
  */
 async function findRootLegacy(name, root) {
-    debug.extend(name ?? 'root-plugin')('Finding root using legacy method');
+    debug(name ?? 'root-plugin')('Finding root using legacy method');
     for (const next of up(root)) {
         let cur;
         if (name) {
@@ -106,7 +106,7 @@ function findPnpRoot(name, root) {
     maybeRequirePnpApi(root);
     if (!pnp)
         return;
-    debug.extend(name)('Finding root for using pnp method');
+    debug(name)('Finding root for using pnp method');
     const seen = new Set();
     const traverseDependencyTree = (locator, parentPkg) => {
         // Prevent infinite recursion when A depends on B which depends on A
@@ -158,29 +158,29 @@ function findPnpRoot(name, root) {
  */
 async function findRoot(name, root) {
     if (name) {
-        debug.extend(name)(`Finding root using ${root}`);
+        debug(name)(`Finding root using ${root}`);
         let pkgPath;
         try {
             pkgPath = require.resolve(name, { paths: [root] });
-            debug.extend(name)(`Found starting point with require.resolve`);
+            debug(name)(`Found starting point with require.resolve`);
         }
         catch {
-            debug.extend(name)(`require.resolve could not find plugin starting point`);
+            debug(name)(`require.resolve could not find plugin starting point`);
         }
         if (pkgPath) {
             const found = await findPluginRoot((0, node_path_1.dirname)(pkgPath), name);
             if (found) {
-                debug.extend(name)(`Found root at ${found}`);
+                debug(name)(`Found root at ${found}`);
                 return found;
             }
         }
         const found = process.versions.pnp ? findPnpRoot(name, root) : await findRootLegacy(name, root);
-        debug.extend(name)(found ? `Found root at ${found}` : 'No root found!');
+        debug(name)(found ? `Found root at ${found}` : 'No root found!');
         return found;
     }
-    debug.extend('root-plugin')(`Finding root plugin using ${root}`);
+    debug('root-plugin')(`Finding root plugin using ${root}`);
     const found = await findPluginRoot(root);
-    debug.extend('root-plugin')(found ? `Found root at ${found}` : 'No root found!');
+    debug('root-plugin')(found ? `Found root at ${found}` : 'No root found!');
     return found;
 }
 exports.findRoot = findRoot;

package/lib/util/read-tsconfig.js

@@ -1,15 +1,12 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readTSConfig = void 0;
-const debug_1 = __importDefault(require("debug"));
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
 const warn_1 = require("../errors/warn");
+const logger_1 = require("../logger");
 const util_1 = require("./util");
-const debug = (0, debug_1.default)('read-tsconfig');
+const debug = (0, logger_1.makeDebug)('read-tsconfig');
 function resolve(root, name) {
     try {
         return require.resolve(name, { paths: [root] });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.4",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -17,6 +17,7 @@
     "is-wsl": "^2.2.0",
     "minimatch": "^9.0.4",
     "string-width": "^4.2.3",
+    "supports-color": "^9.4.0",
     "widest-line": "^3.1.0",
     "wordwrap": "^1.0.0",
     "wrap-ansi": "^7.0.0"

package/lib/errors/config.d.ts

@@ -1,6 +0,0 @@
-import { Logger } from './logger';
-export declare const config: {
-    debug: boolean;
-    errlog: string | undefined;
-    errorLogger: Logger | undefined;
-};

package/lib/errors/config.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = void 0;
-const settings_1 = require("../settings");
-const logger_1 = require("./logger");
-function displayWarnings() {
-    if (process.listenerCount('warning') > 1)
-        return;
-    process.on('warning', (warning) => {
-        console.error(warning.stack);
-        if (warning.detail)
-            console.error(warning.detail);
-    });
-}
-exports.config = {
-    get debug() {
-        return Boolean(settings_1.settings.debug);
-    },
-    set debug(enabled) {
-        settings_1.settings.debug = enabled;
-        if (enabled)
-            displayWarnings();
-    },
-    get errlog() {
-        return settings_1.settings.errlog;
-    },
-    set errlog(errlog) {
-        if (errlog) {
-            this.errorLogger = new logger_1.Logger(errlog);
-            settings_1.settings.errlog = errlog;
-        }
-        else {
-            delete this.errorLogger;
-            delete settings_1.settings.errlog;
-        }
-    },
-    errorLogger: undefined,
-};

package/lib/errors/logger.d.ts

@@ -1,8 +0,0 @@
-export declare class Logger {
-    file: string;
-    protected buffer: string[];
-    protected flushing: Promise<void>;
-    constructor(file: string);
-    flush(waitForMs?: number): Promise<void>;
-    log(msg: string): void;
-}

package/lib/errors/logger.js

@@ -1,48 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = void 0;
-const ansis_1 = __importDefault(require("ansis"));
-const promises_1 = require("node:fs/promises");
-const node_path_1 = require("node:path");
-const timestamp = () => new Date().toISOString();
-let timer;
-const wait = (ms) => new Promise((resolve) => {
-    if (timer)
-        timer.unref();
-    timer = setTimeout(() => resolve(null), ms);
-});
-function chomp(s) {
-    if (s.endsWith('\n'))
-        return s.replace(/\n$/, '');
-    return s;
-}
-class Logger {
-    file;
-    buffer = [];
-    flushing = Promise.resolve();
-    constructor(file) {
-        this.file = file;
-    }
-    async flush(waitForMs = 0) {
-        await wait(waitForMs);
-        this.flushing = this.flushing.then(async () => {
-            if (this.buffer.length === 0)
-                return;
-            const mylines = this.buffer;
-            this.buffer = [];
-            await (0, promises_1.mkdir)((0, node_path_1.dirname)(this.file), { recursive: true });
-            await (0, promises_1.appendFile)(this.file, mylines.join('\n') + '\n');
-        });
-        await this.flushing;
-    }
-    log(msg) {
-        msg = ansis_1.default.strip(chomp(msg));
-        const lines = msg.split('\n').map((l) => `${timestamp()} ${l}`.trimEnd());
-        this.buffer.push(...lines);
-        this.flush(50).catch(console.error);
-    }
-}
-exports.Logger = Logger;