feature(logger): ScopedLogger provider

packages/logger/package.json

@@ -24,15 +24,17 @@
   "author": "Marc J. Schmidt <[email protected]>",
   "license": "MIT",
   "peerDependencies": {
-    "@deepkit/core": "^1.0.1-alpha.13"
+    "@deepkit/core": "^1.0.1-alpha.13",
+    "@deepkit/injector": "^1.0.1-alpha.97"
   },
   "dependencies": {
     "@types/format-util": "^1.0.1",
     "ansi-styles": "^4.3.0",
     "format-util": "^1.0.5"
   },
   "devDependencies": {
-    "@deepkit/core": "^1.0.1-alpha.97"
+    "@deepkit/core": "^1.0.1-alpha.97",
+    "@deepkit/injector": "^1.0.1-alpha.97"
   },
   "jest": {
     "testEnvironment": "node",

packages/logger/src/logger.ts

@@ -11,6 +11,7 @@
 import style from 'ansi-styles';
 import format from 'format-util';
 import { arrayRemoveItem, ClassType } from '@deepkit/core';
+import { Inject, Provider, TransientInjectionTarget } from '@deepkit/injector';
 
 export enum LoggerLevel {
     none,
@@ -309,3 +310,11 @@ export class Logger implements LoggerInterface {
         this.send(message, LoggerLevel.debug);
     }
 }
+
+export type ScopedLogger = Inject<Logger, 'scoped-logger'>;
+export const ScopedLogger: Provider<Logger> = {
+    provide: 'scoped-logger',
+    transient: true,
+    useFactory: (target: TransientInjectionTarget, logger: Logger = new Logger()) =>
+        logger.scoped(target.token?.name ?? String(target.token)),
+};

packages/logger/tests/logger.spec.ts

@@ -1,6 +1,7 @@
 import { expect, test } from '@jest/globals';
-import { JSONTransport, Logger, LoggerLevel, ScopeFormatter } from '../src/logger.js';
+import { JSONTransport, Logger, LoggerLevel, ScopedLogger, ScopeFormatter } from '../src/logger.js';
 import { MemoryLoggerTransport } from '../src/memory-logger.js';
+import { Injector, ServiceNotFoundError } from '@deepkit/injector';
 
 test('log level', () => {
     const logger = new Logger();
@@ -79,3 +80,33 @@ test('colorless', () => {
 
     logger.log('This is a <yellow>color</yellow> test');
 });
+
+test('scoped logger', () => {
+    class MyProvider {
+        constructor (public logger: ScopedLogger) {
+        }
+    }
+
+    {
+        const injector = Injector.from([
+            MyProvider,
+            Logger, // optional base logger used by ScopedLogger
+            ScopedLogger,
+        ]);
+        const logger = injector.get(Logger);
+        const provider = injector.get(MyProvider);
+        expect(logger).toBeInstanceOf(Logger);
+        expect(provider.logger).toBeInstanceOf(Logger);
+        expect(provider.logger).toBe(logger.scoped('MyProvider'));
+    }
+
+    {
+        const injector = Injector.from([
+            MyProvider,
+            ScopedLogger,
+        ]);
+        expect(() => injector.get(Logger)).toThrow(ServiceNotFoundError);
+        const provider = injector.get(MyProvider);
+        expect(provider.logger).toBeInstanceOf(Logger);
+    }
+});