@wlix/logger 1.0.2 → 2.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 Andrew (e60m5ss / wlix)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,34 +1,53 @@
-# @wlix/logger
+<h1 align="center">@wlix/logger</h1>
 
-A tiny file-based logger for Node.js projects. It writes logs to daily files and can also print them to stdout.
+> Tiny file-based logger for Node.js projects
 
-## How it works
+## Installation
 
--   When you create a logger instance, it makes sure the logs directory exists.
--   Each calendar day gets its own log file named `DD-MM-YYYY.log`.
--   Every log line has UTC time (or UTC offset), log type (info, warn, or error), and message.
--   Logs are then written to the appropriate log file.
-
-## Usage
-
--   Use `createLogger()` to create a new logger.
--   Use the returned function with `"info" | "warn" | "error"` and your message.
--   Files are written to the `./logs` dir by default.
+```bash
+npm install @wlix/logger
+# or
+yarn add @wlix/logger
+# or
+pnpm add @wlix/logger
+# or
+bun add @wlix/logger
+```
 
-```ts
-import { createLogger } from "./Logger";
+## Example
+
+```js
+import { Logger } from "@wlix/logger";
+
+// all options are optional
+const logger = new Logger({
+    logsPath: "./logs", // where log files will go
+    logToStdout: true, // log to console (default: true)
+    timezone: "UTC", // timezone (UTC offsets, e.g., UTC+3 or UTC-7)
+});
+
+logger.info("This is information"); // green [INFO] log
+logger.warn("This is a warning"); // orange [WARN] log
+logger.error("This is an error"); // red [ERROR] log
+
+// custom logs
+logger.log("This is a custom log", {
+    level: "example", // appears as [EXAMPLE] This is a custom log
+    color: "blue", // suppots multiple color presets, ...or:
+    hex: "#0000FF", // supports hex colors
+});
+
+logger.set({
+    // ...change logger config
+    // same options when initialising
+    timezone: "UTC+2",
+});
+```
 
-const logger = createLogger();
+## Contributing
 
-logger("info", "Connected to server");
-logger("warn", "Memory is low");
-logger("error", "Something went wrong");
-```
+Pull requests are always welcomed. For more major changes, please open an issue to discuss what you wish to change.
 
-## Configuration
+## License
 
-| Option        | Type                    | Default    | Description                                                      |
-| ------------- | ----------------------- | ---------- | ---------------------------------------------------------------- |
-| `logsPath`    | `string`                | `"./logs"` | Path of the directory where log files are stored                 |
-| `logToStdout` | `boolean`               | `true`     | Whether to print logs to the console                             |
-| `timezone`    | `"UTC"` \| `UTC±number` | `"UTC"`    | Timezone for log timestamps, e.g., `"UTC"`, `"UTC+3"`, `"UTC-6"` |
+[MIT](LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,60 @@
+declare const colors: {
+    readonly beige: "#eab28c";
+    readonly black: "#000000";
+    readonly blue: "#3b79de";
+    readonly brown: "#8e7867";
+    readonly cyan: "#4cb2d7";
+    readonly green: "#87c54e";
+    readonly orange: "#e5822f";
+    readonly pink: "#f480ff";
+    readonly purple: "#b860db";
+    readonly red: "#F14746";
+    readonly white: "#ffffff";
+    readonly yellow: "#d3ba57";
+};
+
+interface LoggerOptions {
+    /**
+     * Path of directory to write log files to
+     * @default null
+     */
+    logsPath?: string;
+
+    /**
+     * Whether to log to stdout
+     * @default true
+     */
+    logToStdout?: boolean;
+
+    /**
+     * Timezone in UTC offsets
+     * @example UTC
+     * @example UTC+2
+     * @example UTC-5
+     * @default UTC
+     */
+    timezone?: Timezone;
+}
+
+type Timezone = "UTC" | `UTC${"" | "+" | "-"}${number}`;
+
+interface WriteOptions {
+    level: string;
+    message: string;
+    color?: keyof typeof colors;
+    hex?: string;
+}
+
+declare class Logger {
+    #private;
+    constructor(options: LoggerOptions);
+    set(options?: LoggerOptions): void;
+    info(message: string, options?: LoggerOptions): Logger;
+    warn(message: string, options?: LoggerOptions): Logger;
+    error(message: string, options?: LoggerOptions): Logger;
+    log(message: string, options?: Omit<WriteOptions, "message"> & {
+        level?: string;
+    }): Logger;
+}
+
+export { Logger, type LoggerOptions, type Timezone };

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+declare const colors: {
+    readonly beige: "#eab28c";
+    readonly black: "#000000";
+    readonly blue: "#3b79de";
+    readonly brown: "#8e7867";
+    readonly cyan: "#4cb2d7";
+    readonly green: "#87c54e";
+    readonly orange: "#e5822f";
+    readonly pink: "#f480ff";
+    readonly purple: "#b860db";
+    readonly red: "#F14746";
+    readonly white: "#ffffff";
+    readonly yellow: "#d3ba57";
+};
+
+interface LoggerOptions {
+    /**
+     * Path of directory to write log files to
+     * @default null
+     */
+    logsPath?: string;
+
+    /**
+     * Whether to log to stdout
+     * @default true
+     */
+    logToStdout?: boolean;
+
+    /**
+     * Timezone in UTC offsets
+     * @example UTC
+     * @example UTC+2
+     * @example UTC-5
+     * @default UTC
+     */
+    timezone?: Timezone;
+}
+
+type Timezone = "UTC" | `UTC${"" | "+" | "-"}${number}`;
+
+interface WriteOptions {
+    level: string;
+    message: string;
+    color?: keyof typeof colors;
+    hex?: string;
+}
+
+declare class Logger {
+    #private;
+    constructor(options: LoggerOptions);
+    set(options?: LoggerOptions): void;
+    info(message: string, options?: LoggerOptions): Logger;
+    warn(message: string, options?: LoggerOptions): Logger;
+    error(message: string, options?: LoggerOptions): Logger;
+    log(message: string, options?: Omit<WriteOptions, "message"> & {
+        level?: string;
+    }): Logger;
+}
+
+export { Logger, type LoggerOptions, type Timezone };

package/dist/index.js

@@ -0,0 +1,185 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Logger: () => Logger
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/logger.ts
+var import_node_fs = __toESM(require("fs"));
+var import_node_path = __toESM(require("path"));
+
+// src/colors.ts
+var colors = {
+  beige: "#eab28c",
+  black: "#000000",
+  blue: "#3b79de",
+  brown: "#8e7867",
+  cyan: "#4cb2d7",
+  green: "#87c54e",
+  orange: "#e5822f",
+  pink: "#f480ff",
+  purple: "#b860db",
+  red: "#F14746",
+  white: "#ffffff",
+  yellow: "#d3ba57"
+};
+
+// src/logger.ts
+var Logger = class {
+  static {
+    __name(this, "Logger");
+  }
+  #options = {
+    logToStdout: true,
+    timezone: "UTC"
+  };
+  /**
+   * Instantiate a new logger
+   * @param options Logger config
+   */
+  constructor(options) {
+    this.#options = { ...this.#options, ...options };
+  }
+  #color(input, hex) {
+    return `\x1B[38;2;${parseInt(hex.slice(1, 3), 16)};${parseInt(hex.slice(3, 5), 16)};${parseInt(hex.slice(5, 7), 16)}m${input}\x1B[0m`;
+  }
+  #getDate(date, timezone = "UTC") {
+    if (timezone === "UTC") {
+      return date;
+    }
+    const match = timezone.match(/^UTC([+-]\d{1,2})$/);
+    if (!match || !match[1]) {
+      return date;
+    }
+    return new Date(
+      date.getTime() + date.getTimezoneOffset() * 6e4 + parseInt(match[1], 10) * 36e5
+    );
+  }
+  #write(options) {
+    const now = this.#getDate(/* @__PURE__ */ new Date(), this.#options.timezone);
+    const time = `${now.getHours().toString().padStart(2, "0")}:${now.getMinutes().toString().padStart(2, "0")}:${now.getSeconds().toString().padStart(2, "0")}`;
+    const line = `[${time} ${this.#options.timezone}] [${options.level.toUpperCase()}] ${options.message.trim()}`;
+    if (this.#options.logsPath) {
+      const fileName = `${now.getDate().toString().padStart(2, "0")}-${(now.getMonth() + 1).toString().padStart(2, "0")}-${now.getFullYear()}.log`;
+      import_node_fs.default.mkdirSync(this.#options.logsPath, { recursive: true });
+      import_node_fs.default.appendFileSync(
+        import_node_path.default.join(this.#options.logsPath, fileName),
+        line + "\n"
+      );
+    }
+    if (this.#options.logToStdout) {
+      if (options.hex || options.color) {
+        const hex = options.hex ? options.hex.startsWith("#") ? options.hex : `#${options.hex}` : colors[options.color];
+        console.log(this.#color(line, hex));
+      } else {
+        console.log(line);
+      }
+    }
+  }
+  /**
+   * Update the logger's options
+   * @param options New config
+   */
+  set(options = {}) {
+    this.#options = { ...this.#options, ...options };
+  }
+  /**
+   * Info log
+   * Green text, INFO level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  info(message, options) {
+    this.#write({
+      level: "info",
+      color: "green",
+      message,
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Warning log
+   * Orange text, WARN level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  warn(message, options) {
+    this.#write({
+      level: "warn",
+      message,
+      color: "orange",
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Error log
+   * Red text, ERROR level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  error(message, options) {
+    this.#write({
+      level: "error",
+      message,
+      color: "red",
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Custom logs
+   * @param message Log message
+   * @param options Log options
+   */
+  log(message, options) {
+    if (!message) {
+      throw new Error("Logging requires a message");
+    }
+    this.#write({
+      ...options,
+      message,
+      level: options?.level ?? "log"
+    });
+    return this;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Logger
+});

package/dist/index.mjs

@@ -0,0 +1,150 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/logger.ts
+import fs from "fs";
+import path from "path";
+
+// src/colors.ts
+var colors = {
+  beige: "#eab28c",
+  black: "#000000",
+  blue: "#3b79de",
+  brown: "#8e7867",
+  cyan: "#4cb2d7",
+  green: "#87c54e",
+  orange: "#e5822f",
+  pink: "#f480ff",
+  purple: "#b860db",
+  red: "#F14746",
+  white: "#ffffff",
+  yellow: "#d3ba57"
+};
+
+// src/logger.ts
+var Logger = class {
+  static {
+    __name(this, "Logger");
+  }
+  #options = {
+    logToStdout: true,
+    timezone: "UTC"
+  };
+  /**
+   * Instantiate a new logger
+   * @param options Logger config
+   */
+  constructor(options) {
+    this.#options = { ...this.#options, ...options };
+  }
+  #color(input, hex) {
+    return `\x1B[38;2;${parseInt(hex.slice(1, 3), 16)};${parseInt(hex.slice(3, 5), 16)};${parseInt(hex.slice(5, 7), 16)}m${input}\x1B[0m`;
+  }
+  #getDate(date, timezone = "UTC") {
+    if (timezone === "UTC") {
+      return date;
+    }
+    const match = timezone.match(/^UTC([+-]\d{1,2})$/);
+    if (!match || !match[1]) {
+      return date;
+    }
+    return new Date(
+      date.getTime() + date.getTimezoneOffset() * 6e4 + parseInt(match[1], 10) * 36e5
+    );
+  }
+  #write(options) {
+    const now = this.#getDate(/* @__PURE__ */ new Date(), this.#options.timezone);
+    const time = `${now.getHours().toString().padStart(2, "0")}:${now.getMinutes().toString().padStart(2, "0")}:${now.getSeconds().toString().padStart(2, "0")}`;
+    const line = `[${time} ${this.#options.timezone}] [${options.level.toUpperCase()}] ${options.message.trim()}`;
+    if (this.#options.logsPath) {
+      const fileName = `${now.getDate().toString().padStart(2, "0")}-${(now.getMonth() + 1).toString().padStart(2, "0")}-${now.getFullYear()}.log`;
+      fs.mkdirSync(this.#options.logsPath, { recursive: true });
+      fs.appendFileSync(
+        path.join(this.#options.logsPath, fileName),
+        line + "\n"
+      );
+    }
+    if (this.#options.logToStdout) {
+      if (options.hex || options.color) {
+        const hex = options.hex ? options.hex.startsWith("#") ? options.hex : `#${options.hex}` : colors[options.color];
+        console.log(this.#color(line, hex));
+      } else {
+        console.log(line);
+      }
+    }
+  }
+  /**
+   * Update the logger's options
+   * @param options New config
+   */
+  set(options = {}) {
+    this.#options = { ...this.#options, ...options };
+  }
+  /**
+   * Info log
+   * Green text, INFO level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  info(message, options) {
+    this.#write({
+      level: "info",
+      color: "green",
+      message,
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Warning log
+   * Orange text, WARN level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  warn(message, options) {
+    this.#write({
+      level: "warn",
+      message,
+      color: "orange",
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Error log
+   * Red text, ERROR level
+   * @param message Log message
+   * @param options Optional log options
+   * @returns
+   */
+  error(message, options) {
+    this.#write({
+      level: "error",
+      message,
+      color: "red",
+      ...options
+    });
+    return this;
+  }
+  /**
+   * Custom logs
+   * @param message Log message
+   * @param options Log options
+   */
+  log(message, options) {
+    if (!message) {
+      throw new Error("Logging requires a message");
+    }
+    this.#write({
+      ...options,
+      message,
+      level: options?.level ?? "log"
+    });
+    return this;
+  }
+};
+export {
+  Logger
+};

package/package.json

@@ -1,21 +1,40 @@
 {
   "name": "@wlix/logger",
-  "version": "1.0.2",
-  "description": "A simple logger.",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "private": false,
+  "description": "Tiny file-based logging for Node.js projects",
+  "version": "2.0.0",
+  "author": {
+    "name": "e60m5ss",
+    "url": "https://github.com/e60m5ss"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "index.js",
-    "index.d.ts",
+    "dist",
+    "LICENSE",
+    "package.json",
     "README.md"
   ],
-  "publishConfig": {
-    "access": "public"
+  "prettier": {
+    "filepath": "src/**/*.ts",
+    "jsxSingleQuote": false,
+    "printWidth": 85,
+    "semi": true,
+    "singleQuote": false,
+    "tabWidth": 4,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "devDependencies": {
+    "@types/node": "^25.1.0",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
-  "author": "wlix",
-  "license": "MIT",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup",
+    "format": "prettier ./src --write --ignore-path=.prettierignore",
+    "lint": "tsc --noEmit; prettier ./src --check --ignore-path=.prettierignore",
+    "prepublish": "tsup"
   }
 }

package/index.d.ts

@@ -1,33 +0,0 @@
-export type Timezone = "UTC" | `UTC${"" | "+" | "-"}${number}`;
-
-export interface LoggerConfig {
-    /**
-     * Path of the directory with log files.
-     * @default "./logs"
-     */
-    logsPath?: string;
-
-    /**
-     * Whether to log to stdout.
-     * @default true
-     */
-    logToStdout?: boolean;
-
-    /**
-     * UTC, or UTC offsets only.
-     * @example "UTC"
-     * @example "UTC-6"
-     * @example "UTC+7"
-     * @default "UTC"
-     */
-    timezone?: Timezone;
-}
-
-/**
- * Creates a logger function.
- * @param config Optional logger configuration.
- * @returns A function to log messages: log(type, message)
- */
-export declare function createLogger(
-    config?: LoggerConfig
-): (type: "info" | "warn" | "error", message: string) => void;

package/index.js

@@ -1,76 +0,0 @@
-const { existsSync, mkdirSync, appendFileSync } = require("fs");
-const { join } = require("path");
-
-/**
- * @typedef {"UTC" | `UTC${"" | "+" | "-"}${number}`} Timezone
- * @typedef {Object} LoggerConfig
- * @property {string} [logsPath] Path of the directory with log files. Default: "./logs"
- * @property {boolean} [logToStdout] Whether to log to stdout. Default: true
- * @property {Timezone} [timezone] UTC, or UTC offsets only. Default: "UTC"
- */
-
-/**
- * Creates a logger function.
- * @param {LoggerConfig} config Optional logger configuration.
- * @returns {(type: "info" | "warn" | "error", message: string) => void} Function to log messages
- */
-function createLogger(config = {}) {
-    const logsPath = config.logsPath ?? "./logs";
-    const logToStdout = config.logToStdout ?? true;
-    const timezone = config.timezone ?? "UTC";
-
-    if (!existsSync(logsPath)) {
-        mkdirSync(logsPath, { recursive: true });
-    }
-
-    /**
-     * Returns a Date object adjusted for the given timezone.
-     * @param {Date} date
-     * @param {Timezone} tz
-     * @returns {Date}
-     */
-    function getOffsetDate(date, tz) {
-        if (tz === "UTC") return date;
-
-        const match = tz.match(/^UTC([+-]\d{1,2})$/);
-        if (!match) return date;
-
-        const offsetHours = parseInt(match[1], 10);
-        const utc = date.getTime() + date.getTimezoneOffset() * 60000;
-        return new Date(utc + offsetHours * 3600000);
-    }
-
-    /**
-     * Logs a message to a file and optionally to stdout.
-     * @param {"info" | "warn" | "error"} type
-     * @param {string} message
-     */
-    function log(type, message) {
-        const now = getOffsetDate(new Date(), timezone);
-
-        const fileName = [
-            String(now.getDate()).padStart(2, "0"),
-            String(now.getMonth() + 1).padStart(2, "0"),
-            now.getFullYear(),
-        ].join("-");
-
-        const time = [
-            String(now.getHours()).padStart(2, "0"),
-            String(now.getMinutes()).padStart(2, "0"),
-            String(now.getSeconds()).padStart(2, "0"),
-        ].join(":");
-
-        const line = `[${time} ${timezone}] [${type.toUpperCase()}] ${message}\n`;
-        const filePath = join(logsPath, `${fileName}.log`);
-
-        appendFileSync(filePath, line);
-
-        if (logToStdout) {
-            console.log(line.trim());
-        }
-    }
-
-    return log;
-}
-
-module.exports = { Logger: createLogger };