Adds disposable logger

 - Similar to the log decorator, but usable in a function with `using`

Author: eamodio

src/system/loggable.ts

@@ -0,0 +1,58 @@
+import { hrtime } from '@env/hrtime';
+import { Logger } from './logger';
+import type { LogScope } from './logger.scope';
+import { setLogScopeExit, startLogScope } from './logger.scope';
+import { getDurationMilliseconds } from './string';
+
+export class LoggableScope implements Disposable {
+	private readonly scope: LogScope & Disposable;
+	private readonly start: [number, number];
+
+	constructor(
+		prefix: string,
+		private readonly options?: { debug?: boolean; enter?: string },
+	) {
+		this.scope = startLogScope(prefix, true);
+		this.start = hrtime();
+
+		(options?.debug ? Logger.debug : Logger.log).call(Logger, this.scope, options?.enter ?? '');
+	}
+
+	[Symbol.dispose](): void {
+		const duration = getDurationMilliseconds(this.start);
+		const timing = ` [${duration}ms]`;
+		const exit = this.scope.exitFailed ?? 'completed';
+
+		if (this.scope.exitFailed != null) {
+			Logger.error(null, this.scope, `${exit}${this.scope.exitDetails ?? ''}${timing}`);
+		} else {
+			(this.options?.debug ? Logger.debug : Logger.log).call(
+				Logger,
+				this.scope,
+				`${exit}${this.scope.exitDetails ?? ''}${timing}`,
+			);
+		}
+
+		this.scope[Symbol.dispose]();
+	}
+
+	setExit(details: string | undefined, failed?: string): void {
+		setLogScopeExit(this.scope, details, failed);
+	}
+
+	error(ex: Error | unknown, message?: string, ...params: any[]): void {
+		Logger.error(ex, this.scope, message, ...params);
+	}
+
+	log(message: string, ...params: any[]): void {
+		(this.options?.debug ? Logger.debug : Logger.log).call(Logger, this.scope, message, ...params);
+	}
+
+	warn(message: string, ...params: any[]): void {
+		Logger.warn(this.scope, message, ...params);
+	}
+}
+
+export function maybeStartLoggableScope(prefix: string, options?: { debug?: boolean; enter?: string }) {
+	return Logger.enabled('error') ? new LoggableScope(prefix, options) : undefined;
+}