feat(ILogger): add #has method, auto-register Store#logger (#221)

Co-authored-by: Jeroen Claassens <[email protected]>

Author: kyranet

src/lib/SapphireClient.ts

@@ -1,4 +1,4 @@
-import { container } from '@sapphire/pieces';
+import { container, Store } from '@sapphire/pieces';
 import type { Awaited } from '@sapphire/utilities';
 import { Client, ClientOptions, Message } from 'discord.js';
 import { join } from 'path';
@@ -96,6 +96,13 @@ export interface SapphireClientOptions {
 	 */
 	logger?: ClientLoggerOptions;
 
+	/**
+	 * Whether or not trace logging should be enabled.
+	 * @since 2.0.0
+	 * @default container.logger.has(LogLevel.Trace)
+	 */
+	enableLoaderTraceLoggings?: boolean;
+
 	/**
 	 * If Sapphire should load our pre-included error event listeners that log any encountered errors to the {@link SapphireClient.logger} instance
 	 * @since 1.0.0
@@ -212,6 +219,9 @@ export class SapphireClient extends Client {
 
 		this.logger = options.logger?.instance ?? new Logger(options.logger?.level ?? LogLevel.Info);
 		container.logger = this.logger;
+		if (options.enableLoaderTraceLoggings ?? container.logger.has(LogLevel.Trace)) {
+			Store.logger = container.logger.trace.bind(container.logger);
+		}
 
 		this.stores = new StoreRegistry();
 		container.stores = this.stores;

src/lib/utils/logger/ILogger.ts

@@ -39,6 +39,12 @@ export const enum LogLevel {
 }
 
 export interface ILogger {
+	/**
+	 * Checks whether a level is supported.
+	 * @param level The level to check.
+	 */
+	has(level: LogLevel): boolean;
+
 	/**
 	 * Alias of {@link ILogger.write} with {@link LogLevel.Trace} as level.
 	 * @param values The values to log.

src/lib/utils/logger/Logger.ts

@@ -7,6 +7,10 @@ export class Logger implements ILogger {
 		this.level = level;
 	}
 
+	public has(level: LogLevel): boolean {
+		return level >= this.level;
+	}
+
 	public trace(...values: readonly unknown[]): void {
 		this.write(LogLevel.Trace, ...values);
 	}
@@ -32,7 +36,7 @@ export class Logger implements ILogger {
 	}
 
 	public write(level: LogLevel, ...values: readonly unknown[]): void {
-		if (level < this.level) return;
+		if (!this.has(level)) return;
 		const method = Logger.levels.get(level);
 		if (typeof method === 'string') console[method](...values);
 	}