feat: expose the styler from the logger and logger service (#1826)

Author: jmcdo29

.changeset/strange-snakes-poke.md

@@ -0,0 +1,6 @@
+---
+'@ogma/nestjs-module': minor
+'@ogma/logger': minor
+---
+
+The `@ogma/styler` instance is now exposed at the `.style` property of ogma

packages/logger/src/logger/ogma.ts

@@ -49,6 +49,15 @@ export class Ogma {
    */
   public log = this.info;
 
+  /**
+   * The [`@ogma/styler`](https://ogma.jaymcdoniel.dev/en/styler)
+   * instance that the logger uses for custom coloring without needing
+   * to manage a new styler instance
+   */
+  public get style() {
+    return this.styler;
+  }
+
   constructor(options?: Partial<OgmaOptions>) {
     if (options?.logLevel) {
       options.logLevel = options.logLevel.toUpperCase() as keyof typeof LogLevel;
@@ -82,6 +91,7 @@ export class Ogma {
     if (this.options.json) {
       this.hostname &&= `"hostname":${this.asString(this.hostname)},`;
       this.pid &&= `"pid":${process.pid},`;
+      this.options.stream.getColorDepth = () => 1;
     }
     this.cachedMasks = this.options?.masks
       ? new Map(this.options.masks.map((mask) => [mask, true]))
@@ -107,12 +117,13 @@ export class Ogma {
     if (this.options.color) {
       colorDepthVal = 4;
     }
-    if (this.options.color === false) {
+    if (this.options.color === false || this.options.json) {
       colorDepthVal = 1;
     }
     if (!colorDepthVal && this.options.stream !== process.stdout && process.stdout.getColorDepth) {
       colorDepthVal = process.stdout.getColorDepth();
     }
+    console.log({ colorDepthVal, json: this.options.json });
     this.options.stream.getColorDepth = () => colorDepthVal ?? 1;
   }
 

packages/logger/test/ogma.spec.ts

@@ -3,7 +3,7 @@ import { style } from '@ogma/styler';
 import { spy, Stub } from 'hanbi';
 import { Socket } from 'net';
 import { suite } from 'uvu';
-import { is, match, not, ok } from 'uvu/assert';
+import { equal, is, match, not, ok } from 'uvu/assert';
 
 import { Ogma, OgmaOptions } from '../src';
 
@@ -518,5 +518,10 @@ OgmaSuite('The mixin should be called if for every log JSON-mode', ({ writeSpy,
   expectCallToPass(2);
   writeSpy.calls.forEach((c) => console.log(c.args.join(' ')));
 });
+OgmaSuite.only('a .style with json mode should return a regular string', ({ ogmaFactory }) => {
+  process.env.FORCE_COLOR = '';
+  const ogma = ogmaFactory({ json: true });
+  equal(ogma.style.blue.apply('Hello World!'), 'Hello World!');
+});
 
 OgmaSuite.run();

packages/nestjs-module/src/ogma.service.ts

@@ -42,6 +42,15 @@ export class OgmaService implements LoggerService {
     return requestContext.requestId;
   }
 
+  /**
+   * The [`@ogma/styler`](https://ogma.jaymcdoniel.dev/en/styler)
+   * instance that the logger uses for custom coloring without needing
+   * to manage a new styler instance
+   */
+  public get style() {
+    return this.ogma.style;
+  }
+
   /**
    * Change the log level during runtime
    * @param the new log level to use
@@ -177,7 +186,7 @@ export class OgmaService implements LoggerService {
 
   private printMessage(
     message: any,
-    levelString: Exclude<keyof Ogma, 'printMessage' | 'printError' | 'setLogLevel'>,
+    levelString: Exclude<keyof Ogma, 'printMessage' | 'printError' | 'setLogLevel' | 'style'>,
     meta: OgmaServiceMeta = {},
   ): void {
     meta.context = meta.context ?? this.context;