@lowfat/log 0.0.1 → 0.2.0

package/README.md

@@ -1,3 +1,86 @@
 # 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.
+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.
+
+## Usage
+
+> [!IMPORTANT]
+> `@lowfat/log` does currently not work in browsers (i.e., via [UNPKG](https://unpkg.com)). Feel free to change that and let me know via a pull request!
+
+Install the package with [NPM](https://npmjs.com), [NodeJS](https://nodejs.org) is required:
+
+```bash
+npm i @lowfat/log
+# or only for development purposes
+npm i -D @lowfat/log
+```
+Directly import the package into your project:
+
+```javascript
+import Log from '@lowfat/log';
+
+Log.info('Works without initialization!');
+// prints "[LFP] Works without initialization!"
+```
+
+### Customization
+
+#### Change label
+
+By default, every message is prefixed with `[LFP]`, to change that, you have to initialize a new instance of the logger:
+
+```javascript
+import Log from '@lowfat/log';
+
+const sublabel = 'my sublabel';
+const logger1 = new Log({ sublabel });
+logger1.info('Now with custom label!');
+// prints "[LFP/my sublabel] Now with custom label!"
+
+const logger2 = new Log({ label: 'my label', sublabel });
+logger2.warn('Custom label AND sublabel');
+// prints "[my label/my sublabel] Custom label AND sublabel"
+```
+
+Use this logger as your new default:
+
+```javascript
+// ./logger.js
+import Log from '@lowfat/log';
+
+export const logger = new Log({ label: 'my label' });
+
+// ./some-place-else.js
+import { logger } from './path/to/logger.js';
+
+logger.info('Works everywhere!');
+// prints "[my label] Works everywhere!"
+```
+
+## Development
+
+Clone this repository and install dependencies:
+
+```bash
+git clone https://codeberg.org/lowfatprophet/log.git
+cd log
+npm i
+```
+
+Start a development watcher for faster iterations:
+
+```bash
+npm run dev
+```
+
+Building is done with [tsdown](https://tsdown.dev):
+
+```bash
+npm run build
+```
+
+Testing is done with [vitest](https://vitest.dev):
+
+```bash
+npm run test
+```

package/dist/index.d.mts

@@ -1,24 +1,64 @@
 //#region src/index.d.ts
+declare global {
+  interface ImportMeta {
+    env: ImportMetaEnv;
+  }
+}
+interface ImportMetaEnv {
+  LOG: string;
+}
 interface LoggerProgessOptions {
   color: number;
   symbol: string;
 }
+interface LoggerOptions {
+  label?: string;
+  sublabel?: string;
+  total?: number;
+}
+interface LoggerColors {
+  BLACK: number;
+  CYAN: number;
+  GRAY: number;
+  GREEN: number;
+  MAGENTA: number;
+  RED: number;
+  YELLOW: number;
+}
 declare class Log {
   #private;
+  static colors: LoggerColors;
   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);
+  static success(...message: string[]): void;
+  static debug(...message: string[]): void;
+  constructor({
+    label,
+    sublabel,
+    total
+  }: LoggerOptions);
   error(...message: string[]): void;
   warn(...message: string[]): void;
   note(...message: string[]): void;
   info(...message: string[]): void;
+  success(...message: string[]): void;
+  debug(...message: string[]): void;
   update(total: number): void;
   progress(i: number, {
     color,
     symbol
   }?: Partial<LoggerProgessOptions>): void;
 }
+declare function error(...message: string[]): void;
+declare function warn(...message: string[]): void;
+declare function note(...message: string[]): void;
+declare function info(...message: string[]): void;
+declare function success(...message: string[]): void;
+declare function debug(...message: string[]): void;
+declare function bold(msg: string | number): string;
+declare function italic(msg: string | number): string;
+declare function dim(msg: string | number): string;
 //#endregion
-export { LoggerProgessOptions, Log as default };
+export { LoggerColors, LoggerOptions, LoggerProgessOptions, bold, debug, Log as default, dim, error, info, italic, note, success, warn };

package/dist/index.mjs

@@ -1,32 +1,49 @@
 import { zeroPad } from "@lowfat/utils/strings";
 //#region src/index.ts
 var Log = class Log {
+	static {
+		this.colors = {
+			BLACK: 0,
+			CYAN: 36,
+			GRAY: 90,
+			GREEN: 32,
+			MAGENTA: 35,
+			RED: 31,
+			YELLOW: 33
+		};
+	}
 	/** label The custom LFP label */
-	static #label = "[LFP]";
+	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`;
+		return `\x1b[${Log.colors.GRAY}m[${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(" ")));
+		console.error(Log.#prefix(), Log.#clr(Log.colors.RED, message.join(" ")));
 	}
 	static warn(...message) {
-		console.warn(Log.#prefix(), Log.#clr(33, message.join(" ")));
+		console.warn(Log.#prefix(), Log.#clr(Log.colors.YELLOW, message.join(" ")));
 	}
 	static note(...message) {
-		console.info(Log.#prefix(), Log.#clr(36, message.join(" ")));
+		console.info(Log.#prefix(), Log.#clr(Log.colors.CYAN, message.join(" ")));
 	}
 	static info(...message) {
 		console.log(Log.#prefix(), message.join(" "));
 	}
+	static success(...message) {
+		console.log(Log.#prefix(), Log.#clr(Log.colors.GREEN, message.join(" ")));
+	}
+	static debug(...message) {
+		console.debug(Log.#prefix(), Log.#clr(Log.colors.MAGENTA, message.join(" ")));
+	}
 	/** Updates the static value for maximum column count. */
 	static #setMaxColumns(label, padding = 6) {
 		Log.#maxColumns = process.stdout.columns - label.length - padding;
@@ -42,26 +59,32 @@ var Log = class Log {
 	#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;
+	/** Log instance that allows for updating and custom labels */
+	constructor({ label, sublabel, total }) {
+		const instanceLabel = sublabel?.length ? `${label?.length ? label : Log.#label}/${sublabel}` : label?.length ? label : Log.#label;
 		this.#instancePrefix = Log.#prefix(instanceLabel);
-		this.update(total);
+		if (total) this.update(total);
 		Log.#setMaxColumns(instanceLabel);
 		Log.#setupListener(instanceLabel);
 	}
 	error(...message) {
-		console.error(this.#instancePrefix, Log.#clr(31, message.join(" ")));
+		console.error(this.#instancePrefix, Log.#clr(Log.colors.RED, message.join(" ")));
 	}
 	warn(...message) {
-		console.warn(this.#instancePrefix, Log.#clr(33, message.join(" ")));
+		console.warn(this.#instancePrefix, Log.#clr(Log.colors.YELLOW, message.join(" ")));
 	}
 	note(...message) {
-		console.info(this.#instancePrefix, Log.#clr(36, message.join(" ")));
+		console.info(this.#instancePrefix, Log.#clr(Log.colors.CYAN, message.join(" ")));
 	}
 	info(...message) {
 		console.log(this.#instancePrefix, message.join(" "));
 	}
+	success(...message) {
+		console.log(this.#instancePrefix, Log.#clr(Log.colors.GREEN, message.join(" ")));
+	}
+	debug(...message) {
+		console.debug(this.#instancePrefix, Log.#clr(Log.colors.MAGENTA, message.join(" ")));
+	}
 	/** Updates the total number, resets the progress visualizer. */
 	update(total) {
 		this.#total = total ?? 0;
@@ -76,5 +99,35 @@ var Log = class Log {
 		if (i >= this.#total - 1) process.stdout.write("\n");
 	}
 };
+function error(...message) {
+	Log.error(...message);
+}
+function warn(...message) {
+	Log.warn(...message);
+}
+function note(...message) {
+	Log.note(...message);
+}
+function info(...message) {
+	Log.info(...message);
+}
+function success(...message) {
+	Log.success(...message);
+}
+function debug(...message) {
+	Log.debug(...message);
+}
+/** Returns a string affixed with ASCII formatting for bold text. */
+function bold(msg) {
+	return `\x1b[1m${msg}\x1b[22m`;
+}
+/** Returns a string affixed with ASCII formatting for italic text. */
+function italic(msg) {
+	return `\x1b[3m${msg}\x1b[23m`;
+}
+/** Returns a string affixed with ASCII formatting for dim text. */
+function dim(msg) {
+	return `\x1b[2m${msg}\x1b[22m`;
+}
 //#endregion
-export { Log as default };
+export { bold, debug, Log as default, dim, error, info, italic, note, success, warn };

package/package.json

@@ -10,7 +10,6 @@
   "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",
@@ -27,15 +26,7 @@
     "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"
+  "version": "0.2.0"
 }

package/tsdown.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: 'src/index.ts',
+  format: {
+    esm: ['nodexnext'],
+  },
+  outDir: 'dist',
+});