@larvit/log 1.2.0 → 1.2.2

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@larvit/log",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "type": "module",
   "license": "MIT",
-  "packageManager": "yarn@3.3.1",
+  "packageManager": "yarn@3.6.3",
   "scripts": {
     "build": "rm -f index.js index.d.ts index.js.map && tsc && uglifyjs index.js -o index.js",
     "lint-fix": "eslint --fix index.ts test.ts",
@@ -12,14 +12,14 @@
     "test": "yarn test-unit && yarn lint"
   },
   "devDependencies": {
-    "@larvit/eslint-config-typescript-esm": "1.2.0",
+    "@larvit/eslint-config-typescript-esm": "1.2.1",
     "@randomgoods/tap-spec": "5.0.3",
-    "@types/node": "18.11.18",
-    "@types/tape": "4.13.2",
-    "eslint": "8.31.0",
-    "tape": "5.6.1",
+    "@types/node": "20.5.7",
+    "@types/tape": "5.6.0",
+    "eslint": "8.48.0",
+    "tape": "5.6.6",
     "ts-node": "10.9.1",
-    "typescript": "4.9.4",
+    "typescript": "5.2.2",
     "uglify-js": "3.17.4"
   },
   "publishConfig": {
@@ -35,7 +35,6 @@
     "index.d.ts",
     "index.js.map",
     "index.js",
-    "index.ts",
     "LICENSE",
     "package.json",
     "README.md"

package/index.ts

@@ -1,178 +0,0 @@
-export type Metadata = {
-	[key: string]: string;
-}
-
-export type LogShorthand = (msg: string, metadata?: Metadata) => void;
-
-export interface LogInt {
-	/* eslint-disable typescript-sort-keys/interface */
-	error: LogShorthand;
-	warn: LogShorthand;
-	info: LogShorthand;
-	verbose: LogShorthand;
-	debug: LogShorthand;
-	silly: LogShorthand
-	/* eslint-enable typescript-sort-keys/interface */
-}
-
-export type LogLevel = keyof LogInt;
-
-export type EntryFormatterConf = {
-	logLevel: LogLevel;
-	metadata?: Metadata;
-	msg: string;
-}
-
-export type LogConf = {
-	context?: Metadata;
-	entryFormatter?: (conf: EntryFormatterConf) => string;
-	format?: "text" | "json";
-	logLevel?: LogLevel | "none";
-	stderr?: (msg: string) => void;
-	stdout?: (msg: string) => void;
-}
-
-export function msgJsonFormatter(conf: EntryFormatterConf) {
-	const payload = Object.assign(conf.metadata, {
-		logLevel: conf.logLevel,
-		msg: conf.msg,
-		time: new Date().toISOString(),
-	});
-
-	return JSON.stringify(payload);
-}
-
-export function msgTextFormatter(conf: EntryFormatterConf) {
-	let levelOut = "";
-
-	if (conf.logLevel === "silly") {
-		levelOut = "\x1b[1;37msil\x1b[0m";
-	} else if (conf.logLevel === "debug") {
-		levelOut = "\x1b[1;35mdeb\x1b[0m";
-	} else if (conf.logLevel === "verbose") {
-		levelOut = "\x1b[1;34mver\x1b[0m";
-	} else if (conf.logLevel === "info") {
-		levelOut = "\x1b[1;32minf\x1b[0m";
-	} else if (conf.logLevel === "warn") {
-		levelOut = "\x1b[1;33mwar\x1b[0m";
-	} else if (conf.logLevel === "error") {
-		levelOut = "\x1b[1;31merr\x1b[0m";
-	} else {
-		throw new Error(`Invalid conf.logLevel: "${conf.logLevel}"`);
-	}
-
-	let str = `${new Date().toISOString().substring(0, 19)}Z [${levelOut}] ${conf.msg}`;
-	const metadataStr = JSON.stringify(conf.metadata);
-	if (metadataStr !== "{}") {
-		str += ` ${JSON.stringify(conf.metadata)}`;
-	}
-
-	return str;
-}
-
-export class Log implements LogInt {
-	context: Metadata;
-	readonly #conf: LogConf; // Saved to be able to recreate instance
-	readonly #logLevel: LogLevel | "none";
-	readonly #entryFormatter: (conf: EntryFormatterConf) => string;
-	readonly #stderr: (msg: string) => void;
-	readonly #stdout: (msg: string) => void;
-
-	constructor(conf?: LogConf | LogLevel | "none") {
-		if (conf === undefined) {
-			conf = {};
-		} else if (typeof conf === "string") {
-			conf = { logLevel: conf };
-		}
-
-		if (conf.logLevel === undefined) {
-			conf.logLevel = "info";
-		}
-
-		if (conf.entryFormatter === undefined && conf.format === "json") {
-			conf.entryFormatter = msgJsonFormatter;
-		} else if (conf.entryFormatter === undefined) {
-			conf.entryFormatter = msgTextFormatter;
-		}
-
-		if (conf.stderr === undefined) {
-			conf.stderr = console.error;
-		}
-
-		if (conf.stdout === undefined) {
-			conf.stdout = console.log;
-		}
-
-		this.#conf = conf;
-		this.#logLevel = conf.logLevel;
-		this.#entryFormatter = conf.entryFormatter;
-		this.#stderr = conf.stderr;
-		this.#stdout = conf.stdout;
-		this.context = conf.context || {};
-	}
-
-	// Create a new instance based on the current instance
-	// All options sent in will override the current instance settings
-	clone(conf?: LogConf | LogLevel | "none") {
-		if (conf === undefined) {
-			conf = {};
-		} else if (typeof conf === "string") {
-			conf = { logLevel: conf };
-		}
-
-		if (conf.logLevel === undefined) {
-			conf.logLevel = this.#logLevel;
-		}
-
-		if (this.#conf.format !== "json" && conf.format === "json") {
-			conf.entryFormatter = msgJsonFormatter;
-		} else {
-			conf.entryFormatter = this.#entryFormatter;
-		}
-
-		if (conf.stderr === undefined) {
-			conf.stderr = this.#conf.stderr;
-		}
-
-		if (conf.stdout === undefined) {
-			conf.stdout = this.#conf.stdout;
-		}
-
-		conf.context = {
-			...this.context,
-			...conf.context,
-		};
-
-		return new Log(conf);
-	}
-
-	error(msg: string, metadata?: Metadata) {
-		if (this.#logLevel === "none") return;
-		this.#stderr(this.#entryFormatter({ logLevel: "error", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-
-	warn(msg: string, metadata?: Metadata) {
-		if (["none", "error"].includes(this.#logLevel)) return;
-		this.#stderr(this.#entryFormatter({ logLevel: "warn", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-
-	info(msg: string, metadata?: Metadata) {
-		if (["none", "error", "warn"].includes(this.#logLevel)) return;
-		this.#stdout(this.#entryFormatter({ logLevel: "info", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-
-	verbose(msg: string, metadata?: Metadata) {
-		if (["none", "error", "warn", "info"].includes(this.#logLevel)) return;
-		this.#stdout(this.#entryFormatter({ logLevel: "verbose", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-
-	debug(msg: string, metadata?: Metadata) {
-		if (["none", "error", "warn", "info", "verbose"].includes(this.#logLevel)) return;
-		this.#stdout(this.#entryFormatter({ logLevel: "debug", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-
-	silly(msg: string, metadata?: Metadata) {
-		if (["none", "error", "warn", "info", "verbose", "debug"].includes(this.#logLevel)) return;
-		this.#stdout(this.#entryFormatter({ logLevel: "silly", metadata: Object.assign(metadata || {}, this.context), msg }));
-	}
-}