@larvit/log 1.0.2 → 1.0.4

package/README.md

@@ -58,4 +58,4 @@ const log = new Log({
 
 ### Metadata
 
-`log.info("foo", { hey: "luring" });` --> 2022-09-24T23:40:39Z [info] foo {"hey":"luring"}
+`log.info("foo", { hey: "luring" });` --> 2022-09-24T23:40:39Z [info] foo {"hey":"luring"}

package/index.d.ts

@@ -0,0 +1,40 @@
+declare type Metadata = {
+    [key: string]: string;
+};
+declare type LogShorthand = (msg: string, metadata?: Metadata) => void;
+interface LogInt {
+    error: LogShorthand;
+    warn: LogShorthand;
+    info: LogShorthand;
+    verbose: LogShorthand;
+    debug: LogShorthand;
+    silly: LogShorthand;
+}
+declare type LogLevel = keyof LogInt;
+declare type EntryFormatterConf = {
+    logLevel: LogLevel;
+    metadata?: Metadata;
+    msg: string;
+};
+declare type LogConf = {
+    context?: Metadata;
+    entryFormatter?: (conf: EntryFormatterConf) => string;
+    format?: "text" | "json";
+    logLevel?: LogLevel | "none";
+    stderr?: (msg: string) => void;
+    stdout?: (msg: string) => void;
+};
+export declare function msgJsonFormatter(conf: EntryFormatterConf): string;
+export declare function msgTextFormatter(conf: EntryFormatterConf): string;
+export declare class Log implements LogInt {
+    #private;
+    context: Metadata;
+    constructor(conf?: LogConf | LogLevel | "none");
+    error(msg: string, metadata?: Metadata): void;
+    warn(msg: string, metadata?: Metadata): void;
+    info(msg: string, metadata?: Metadata): void;
+    verbose(msg: string, metadata?: Metadata): void;
+    debug(msg: string, metadata?: Metadata): void;
+    silly(msg: string, metadata?: Metadata): void;
+}
+export {};

package/index.js

@@ -0,0 +1 @@
+export function msgJsonFormatter(conf){const payload=Object.assign(conf.metadata,{logLevel:conf.logLevel,msg:conf.msg,time:(new Date).toISOString()});return JSON.stringify(payload)}export function msgTextFormatter(conf){let levelOut="";if(conf.logLevel==="silly"){levelOut="sil"}else if(conf.logLevel==="debug"){levelOut="deb"}else if(conf.logLevel==="verbose"){levelOut="ver"}else if(conf.logLevel==="info"){levelOut="inf"}else if(conf.logLevel==="warn"){levelOut="war"}else if(conf.logLevel==="error"){levelOut="err"}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{context;#logLevel;#entryFormatter;#stderr;#stdout;constructor(conf){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.#logLevel=conf.logLevel;this.#entryFormatter=conf.entryFormatter;this.#stderr=conf.stderr;this.#stdout=conf.stdout;this.context=conf.context||{}}error(msg,metadata){if(this.#logLevel==="none")return;this.#stderr(this.#entryFormatter({logLevel:"error",metadata:Object.assign(metadata||{},this.context),msg:msg}))}warn(msg,metadata){if(["none","error"].includes(this.#logLevel))return;this.#stderr(this.#entryFormatter({logLevel:"warn",metadata:Object.assign(metadata||{},this.context),msg:msg}))}info(msg,metadata){if(["none","error","warn"].includes(this.#logLevel))return;this.#stdout(this.#entryFormatter({logLevel:"info",metadata:Object.assign(metadata||{},this.context),msg:msg}))}verbose(msg,metadata){if(["none","error","warn","info"].includes(this.#logLevel))return;this.#stdout(this.#entryFormatter({logLevel:"verbose",metadata:Object.assign(metadata||{},this.context),msg:msg}))}debug(msg,metadata){if(["none","error","warn","info","verbose"].includes(this.#logLevel))return;this.#stdout(this.#entryFormatter({logLevel:"debug",metadata:Object.assign(metadata||{},this.context),msg:msg}))}silly(msg,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:msg}))}}

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAkCA,MAAM,UAAU,gBAAgB,CAAC,IAAwB;IACxD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC5C,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KAC9B,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAwB;IACxD,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;QAC9B,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;QACrC,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QACvC,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE;QACpC,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE;QACpC,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;QACrC,QAAQ,GAAG,sBAAsB,CAAC;KAClC;SAAM;QACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;KAC7D;IAED,IAAI,GAAG,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,QAAQ,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;IACpF,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,WAAW,KAAK,IAAI,EAAE;QACzB,GAAG,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;KAC3C;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,MAAM,OAAO,GAAG;IACf,OAAO,CAAW;IACT,SAAS,CAAoB;IAC7B,eAAe,CAAuC;IACtD,OAAO,CAAwB;IAC/B,OAAO,CAAwB;IAExC,YAAY,IAAkC;QAC7C,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,IAAI,GAAG,EAAE,CAAC;SACV;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;SAC1B;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;SACvB;QAED,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE;YAChE,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;SACvC;aAAM,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;YAC7C,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC;SACvC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;SAC5B;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;SAC1B;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,QAAmB;QACrC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM;YAAE,OAAO;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACvH,CAAC;IAED,IAAI,CAAC,GAAW,EAAE,QAAmB;QACpC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO;QACvD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACtH,CAAC;IAED,IAAI,CAAC,GAAW,EAAE,QAAmB;QACpC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO;QAC/D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACtH,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,QAAmB;QACvC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO;QACvE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACzH,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,QAAmB;QACrC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO;QAClF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACvH,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,QAAmB;QACrC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO;QAC3F,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACvH,CAAC;CACD"}

package/index.ts

@@ -0,0 +1,141 @@
+type Metadata = {
+	[key: string]: string;
+}
+
+type LogShorthand = (msg: string, metadata?: Metadata) => void;
+
+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 */
+}
+
+type LogLevel = keyof LogInt;
+
+type EntryFormatterConf = {
+	logLevel: LogLevel;
+	metadata?: Metadata;
+	msg: string;
+}
+
+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 #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.#logLevel = conf.logLevel;
+		this.#entryFormatter = conf.entryFormatter;
+		this.#stderr = conf.stderr;
+		this.#stdout = conf.stdout;
+		this.context = conf.context || {};
+	}
+
+	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 }));
+	}
+}

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@larvit/log",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "license": "MIT",
-  "packageManager": "yarn@3.2.3",
+  "packageManager": "yarn@3.2.4",
   "scripts": {
     "build": "rm -f index.js index.d.ts index.js.map && tsc && uglifyjs index.js -o index.js",
-    "test": "node --loader ts-node/esm test.ts | tap-spec"
+    "lint-fix": "eslint --fix index.ts test.ts",
+    "lint": "eslint index.ts test.ts",
+    "test-unit": "node --loader ts-node/esm test.ts | tap-spec",
+    "test": "yarn test-unit && yarn lint"
   },
   "devDependencies": {
+    "@larvit/eslint-config-typescript-esm": "1.0.1",
     "@randomgoods/tap-spec": "5.0.2",
     "@types/node": "18.7.20",
     "@types/tape": "4.13.2",
+    "eslint": "8.25.0",
     "tape": "5.6.1",
     "ts-node": "10.9.1",
     "typescript": "4.8.4",
-    "uglify-js": "3.17.2"
+    "uglify-js": "3.17.3"
   },
   "publishConfig": {
     "access": "public",
@@ -24,5 +29,15 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/larvit/log.git"
-  }
+  },
+  "main": "index.js",
+  "files": [
+    "index.d.ts",
+    "index.js.map",
+    "index.js",
+    "index.ts",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ]
 }