Move runtime into BaseLogger, fix #256

Author: terehov

examples/nodejs/index2.ts

@@ -1,5 +1,4 @@
 import { Logger, BaseLogger } from "../../src/index.js";
-import { Runtime } from "../../src/index.js";
 
 const defaultLogObject: {
   name: string;
@@ -23,7 +22,7 @@ logger.fatal("test1 %s test3", "test2");
 
 console.log("###############");
 
-const baseLogger = new BaseLogger(Runtime, {}, defaultLogObject);
+const baseLogger = new BaseLogger({}, defaultLogObject);
 
 baseLogger.log(0, "test", "test base logger", { haha: true, password: "123456" }, ["SECRET"]);
 

src/BaseLogger.ts

@@ -1,17 +1,20 @@
 import { formatTemplate } from "./formatTemplate.js";
 import { formatNumberAddZeros } from "./formatNumberAddZeros.js";
-import { ISettingsParam, ISettings, ILogObjMeta, ILogObj, IErrorObject, Runtime, IMeta } from "./interfaces.js";
+import { ISettingsParam, ISettings, ILogObjMeta, ILogObj, IErrorObject, IRuntime, IMeta } from "./interfaces.js";
 import { urlToObject } from "./urlToObj.js";
+import Runtime from "./runtime/nodejs/index.js";
+
 export * from "./interfaces.js";
+export { Runtime };
 
 export class BaseLogger<LogObj> {
-  private readonly runtime: Runtime;
+  private readonly runtime: IRuntime;
   public settings: ISettings<LogObj>;
   // not needed yet
   //private subLoggers: BaseLogger<LogObj>[] = [];
 
-  constructor(runtime: Runtime, settings?: ISettingsParam<LogObj>, private logObj?: LogObj, private stackDepthLevel: number = 4) {
-    this.runtime = runtime;
+  constructor(settings?: ISettingsParam<LogObj>, private logObj?: LogObj, private stackDepthLevel: number = 4) {
+    this.runtime = Runtime;
 
     this.settings = {
       type: settings?.type ?? "pretty",

src/index.browser.ts

@@ -1,10 +1,8 @@
 import { BaseLogger } from "./BaseLogger.js";
 import { ILogObj, ILogObjMeta, ISettingsParam } from "./interfaces.js";
-import BrowserRuntime from "./runtime/browser/index.js";
 
 export * from "./interfaces.js";
 export * from "./BaseLogger.js";
-export { BrowserRuntime };
 
 export class Logger<LogObj> extends BaseLogger<LogObj> {
   constructor(settings?: ISettingsParam<LogObj>, logObj?: LogObj) {
@@ -18,7 +16,7 @@ export class Logger<LogObj> extends BaseLogger<LogObj> {
     // style only for blink browsers
     settings.stylePrettyLogs = settings.stylePrettyLogs && isBrowser && !isBrowserBlinkEngine ? false : settings.stylePrettyLogs;
 
-    super(BrowserRuntime, settings, logObj, isSafari ? 4 : 5);
+    super(settings, logObj, isSafari ? 4 : 5);
   }
 
   /**

src/index.ts

@@ -1,10 +1,7 @@
 import { BaseLogger } from "./BaseLogger.js";
 import { ILogObj, ILogObjMeta, ISettingsParam } from "./interfaces.js";
-import Runtime from "./runtime/nodejs/index.js";
-
 export * from "./interfaces.js";
 export * from "./BaseLogger.js";
-export { Runtime };
 
 declare global {
   interface Window {
@@ -22,7 +19,7 @@ export class Logger<LogObj> extends BaseLogger<LogObj> {
     // style only for blink browsers
     settings.stylePrettyLogs = settings.stylePrettyLogs && isBrowser && !isBrowserBlinkEngine ? false : settings.stylePrettyLogs;
 
-    super(Runtime, settings, logObj, isSafari ? 4 : 5);
+    super(settings, logObj, isSafari ? 4 : 5);
   }
 
   /**

src/interfaces.ts

@@ -186,7 +186,7 @@ export interface IMeta extends IMetaStatic {
   path?: IStackFrame;
 }
 
-export interface Runtime {
+export interface IRuntime {
   getMeta: (
     logLevelId: number,
     logLevelName: string,

src/runtime/browser/index.ts

@@ -1,4 +1,4 @@
-import { ILogObjMeta, ISettings, IStackFrame, Runtime } from "../../interfaces.js";
+import { ILogObjMeta, ISettings, IStackFrame, IRuntime } from "../../interfaces.js";
 import { formatTemplate } from "../../formatTemplate.js";
 import { formatWithOptions, InspectOptions } from "./util.inspect.polyfil.js";
 import { jsonStringifyRecursive } from "./helper.jsonStringifyRecursive.js";
@@ -15,7 +15,7 @@ export default {
   isError,
   prettyFormatLogObj,
   prettyFormatErrorObj,
-} as Runtime;
+} as IRuntime;
 
 export interface IMetaStatic {
   name?: string;

src/runtime/nodejs/index.ts

@@ -1,9 +1,8 @@
 import { hostname } from "os";
 import { normalize as fileNormalize } from "path";
 import { types, formatWithOptions, InspectOptions } from "util";
-import { Runtime, ILogObjMeta, ISettings, IStackFrame } from "../../interfaces.js";
+import { IRuntime, ILogObjMeta, ISettings, IStackFrame } from "../../interfaces.js";
 import { formatTemplate } from "../../formatTemplate.js";
-import { stdout } from "process";
 export { InspectOptions };
 
 export default {
@@ -16,7 +15,7 @@ export default {
   isError,
   prettyFormatLogObj,
   prettyFormatErrorObj,
-} as Runtime;
+} as IRuntime;
 
 export interface IMetaStatic {
   name?: string;

tests/Nodejs/8_json_LogObj.test.ts

@@ -1,7 +1,6 @@
 import "ts-jest";
 import { Logger, BaseLogger } from "../../src";
 import { getConsoleLog, mockConsoleLog } from "./helper.js";
-import NodeRuntime from "../../src/runtime/nodejs/index";
 
 interface ILogObj {
   name: string;
@@ -17,7 +16,7 @@ describe("JSON: LogObj", () => {
     const defaultLogObject: ILogObj = {
       name: "test",
     };
-    const logger = new BaseLogger<ILogObj>(NodeRuntime, { type: "json" }, defaultLogObject);
+    const logger = new BaseLogger<ILogObj>({ type: "json" }, defaultLogObject);
     const logMsg = logger.log(1234, "testLevel", "Test");
     expect(logMsg?.name).toContain(defaultLogObject.name);
     expect(getConsoleLog()).toContain(`"name":"test",`);