Created
June 30, 2023 22:58
-
-
Save markflorkowski/39e07268180d19c58e157e2ce8c67070 to your computer and use it in GitHub Desktop.
Logger
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument */ | |
| interface Logger { | |
| trace(message: string, ...optionalParams: any[]): void; | |
| debug(message: string, ...optionalParams: any[]): void; | |
| info(message: string, ...optionalParams: any[]): void; | |
| warn(message: string, ...optionalParams: any[]): void; | |
| error(message: string, ...optionalParams: any[]): void; | |
| [x: string]: any; | |
| } | |
| const levels = ["trace", "debug", "info", "warn", "error"] as const; | |
| export type LogLevels = (typeof levels)[number]; | |
| const prefixColors = { | |
| trace: `\x1b[90m`, // gray | |
| debug: `\x1b[36m`, // cyan | |
| info: `\x1b[97m`, // white | |
| warn: `\x1b[33m`, // yellow | |
| error: `\x1b[31m`, // red | |
| }; | |
| const colorReset = `\x1b[0m`; | |
| class logger implements Logger { | |
| private subscriptions: { | |
| fn: (m: { message: string; level: LogLevels; ts: number }) => void; | |
| level: LogLevels; | |
| }[]; | |
| constructor() { | |
| this.subscriptions = []; | |
| } | |
| trace(message: string | Error | unknown, ...optionalParams: any[]) { | |
| if (message instanceof Error) { | |
| this.log("trace", message.message, [ | |
| optionalParams, | |
| message.stack, | |
| message.cause, | |
| ]); | |
| } else if (typeof message === "string") { | |
| this.log("trace", message, optionalParams); | |
| } else { | |
| this.log("trace", JSON.stringify(message), optionalParams); | |
| } | |
| } | |
| debug(message: string | Error | unknown, ...optionalParams: any[]) { | |
| if (message instanceof Error) { | |
| this.log("debug", message.message, [ | |
| optionalParams, | |
| message.stack, | |
| message.cause, | |
| ]); | |
| } else if (typeof message === "string") { | |
| this.log("debug", message, optionalParams); | |
| } else { | |
| this.log("debug", JSON.stringify(message), optionalParams); | |
| } | |
| } | |
| info(message: string | Error | unknown, ...optionalParams: any[]) { | |
| if (message instanceof Error) { | |
| this.log("info", message.message, [ | |
| optionalParams, | |
| message.stack, | |
| message.cause, | |
| ]); | |
| } else if (typeof message === "string") { | |
| this.log("info", message, optionalParams); | |
| } else { | |
| this.log("info", JSON.stringify(message), optionalParams); | |
| } | |
| } | |
| warn(message: string | Error | unknown, ...optionalParams: any[]) { | |
| if (message instanceof Error) { | |
| this.log("warn", message.message, [ | |
| optionalParams, | |
| message.stack, | |
| message.cause, | |
| ]); | |
| } else if (typeof message === "string") { | |
| this.log("warn", message, optionalParams); | |
| } else { | |
| this.log("warn", JSON.stringify(message), optionalParams); | |
| } | |
| } | |
| error(message: string | Error | unknown, ...optionalParams: any[]) { | |
| if (message instanceof Error) { | |
| this.log("error", message.message, [ | |
| optionalParams, | |
| message.stack, | |
| message.cause, | |
| ]); | |
| } else if (typeof message === "string") { | |
| this.log("error", message, optionalParams); | |
| } else { | |
| this.log("error", JSON.stringify(message), optionalParams); | |
| } | |
| } | |
| subscribe( | |
| fn: (m: { message: string; level: LogLevels; ts: number }) => void, | |
| level?: LogLevels | |
| ) { | |
| if (!level) level = "info"; | |
| this.subscriptions.push({ fn, level }); | |
| } | |
| unsubscribe( | |
| fn: (m: { message: string; level: LogLevels; ts: number }) => void | |
| ) { | |
| this.subscriptions = this.subscriptions.filter( | |
| ({ fn: subFn }) => subFn !== fn | |
| ); | |
| } | |
| private log(level: LogLevels, message: string, optionalParams: any[]) { | |
| const ts = Date.now(); | |
| const defaultLevel = | |
| process.env.NODE_ENV === "development" ? "trace" : "info"; | |
| if (getLogLevels(defaultLevel).includes(level)) { | |
| console[level](consoleFormat(level, message), ...optionalParams); | |
| } | |
| this.subscriptions.forEach(({ fn, level: subLevel }) => { | |
| if (getLogLevels(subLevel).includes(level)) fn({ message, level, ts }); | |
| }); | |
| } | |
| } | |
| // get all log levels above and including the given level | |
| const getLogLevels = (level: LogLevels): LogLevels[] => { | |
| return levels.slice(levels.indexOf(level)); | |
| }; | |
| // formatting | |
| const consoleFormat = (level: LogLevels, message: string) => { | |
| return `${ | |
| prefixColors[level] | |
| }[${level.toUpperCase()}] ${message}${colorReset}`; | |
| }; | |
| const loggerInstance = new logger(); | |
| export default loggerInstance; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment