@lowfat/log 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# Lowfat Log
+
+A simple and easy-to-use logging tool, small enough to be included with client-side code, but works excellent with Node, and Deno, as well.

package/dist/index.d.mts

@@ -0,0 +1,24 @@
+//#region src/index.d.ts
+interface LoggerProgessOptions {
+  color: number;
+  symbol: string;
+}
+declare class Log {
+  #private;
+  static error(...message: string[]): void;
+  static warn(...message: string[]): void;
+  static note(...message: string[]): void;
+  static info(...message: string[]): void;
+  constructor(label: string, total: number);
+  error(...message: string[]): void;
+  warn(...message: string[]): void;
+  note(...message: string[]): void;
+  info(...message: string[]): void;
+  update(total: number): void;
+  progress(i: number, {
+    color,
+    symbol
+  }?: Partial<LoggerProgessOptions>): void;
+}
+//#endregion
+export { LoggerProgessOptions, Log as default };

package/dist/index.mjs

@@ -0,0 +1,80 @@
+import { zeroPad } from "@lowfat/utils/strings";
+//#region src/index.ts
+var Log = class Log {
+	/** label The custom LFP label */
+	static #label = "[LFP]";
+	/** The column width of the `stdout` terminal window, minus padding */
+	static #maxColumns = process.stdout.columns - Log.#label.length - 6;
+	/** Per default `false` gets set to `true` when first instance gets created and sets up one listener to change the static variable `#maxColumns` */
+	static #listening = false;
+	/** Styles the line prefix. */
+	static #prefix(label = Log.#label) {
+		return `\x1b[90m${label}\x1b[0m`;
+	}
+	/** Creates a colored output string for printing; https://stackoverflow.com/a/41407246 */
+	static #clr(clr, msg) {
+		return `\x1b[${clr}m${msg}\x1b[0m`;
+	}
+	static error(...message) {
+		console.error(Log.#prefix(), Log.#clr(31, message.join(" ")));
+	}
+	static warn(...message) {
+		console.warn(Log.#prefix(), Log.#clr(33, message.join(" ")));
+	}
+	static note(...message) {
+		console.info(Log.#prefix(), Log.#clr(36, message.join(" ")));
+	}
+	static info(...message) {
+		console.log(Log.#prefix(), message.join(" "));
+	}
+	/** Updates the static value for maximum column count. */
+	static #setMaxColumns(label, padding = 6) {
+		Log.#maxColumns = process.stdout.columns - label.length - padding;
+	}
+	/** Sets up a listener to listen for output window size changes to adjust column count. */
+	static #setupListener(label = Log.#label) {
+		if (!Log.#listening) {
+			process.stdout.on("resize", () => Log.#setMaxColumns(label));
+			Log.#listening = false;
+		}
+	}
+	/** The total amount of data to process for the upper limit of the progress bar. */
+	#total = 0;
+	/** A custom prefix to identify origin of the logging. */
+	#instancePrefix;
+	/** Log instance that allows for updating */
+	constructor(label, total) {
+		const instanceLabel = !!label ? `${Log.#label.slice(0, -1)}/${label}]` : Log.#label;
+		this.#instancePrefix = Log.#prefix(instanceLabel);
+		this.update(total);
+		Log.#setMaxColumns(instanceLabel);
+		Log.#setupListener(instanceLabel);
+	}
+	error(...message) {
+		console.error(this.#instancePrefix, Log.#clr(31, message.join(" ")));
+	}
+	warn(...message) {
+		console.warn(this.#instancePrefix, Log.#clr(33, message.join(" ")));
+	}
+	note(...message) {
+		console.info(this.#instancePrefix, Log.#clr(36, message.join(" ")));
+	}
+	info(...message) {
+		console.log(this.#instancePrefix, message.join(" "));
+	}
+	/** Updates the total number, resets the progress visualizer. */
+	update(total) {
+		this.#total = total ?? 0;
+	}
+	/** Displays the next step in terminal progress bar. */
+	progress(i, { color = 0, symbol = "#" } = {}) {
+		if (!process.stdout.isTTY) return;
+		const progress = i / this.#total;
+		const columns = Math.ceil(progress * Log.#maxColumns);
+		process.stdout.cursorTo(0);
+		process.stdout.write(`${this.#instancePrefix} ${Log.#clr(color, symbol).repeat(columns)}${" ".repeat(Log.#maxColumns - columns)} ${zeroPad(Math.ceil(progress * 100), 3)}%`);
+		if (i >= this.#total - 1) process.stdout.write("\n");
+	}
+};
+//#endregion
+export { Log as default };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "author": {
+    "email": "lowfatprophet@googlemail.com",
+    "name": "lowfatprophet",
+    "url": "https://lowfatprophet.netlify.app"
+  },
+  "dependencies": {
+    "@lowfat/utils": "^0.0.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
+    "@types/node": "^25.6.2",
+    "@typescript/native-preview": "^7.0.0-dev.20260421.2",
+    "tsdown": "^0.22.0",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5"
+  },
+  "main": "./dist/index.mjs",
+  "name": "@lowfat/log",
+  "repository": {
+    "type": "git",
+    "url": "https://codeberg.org/lowfatprophet/log.git"
+  },
+  "scripts": {
+    "build": "vitest --run && npx tsdown",
+    "dev": "npx tsdown --watch",
+    "test": "vitest --disableConsoleIntercept true"
+  },
+  "tsdown": {
+    "format": {
+      "esm": [
+        "nodenext"
+      ]
+    },
+    "outDir": "dist"
+  },
+  "type": "module",
+  "types": "./dist/index.d.mts",
+  "version": "0.0.1"
+}