@wlix/logger 1.0.0

package/README.md

@@ -0,0 +1,26 @@
+# @wlix/logger
+
+A tiny file-based logger for Node.js projects. It writes logs to daily files and can also print them to stdout.
+
+## How it works
+
+-   When you create a `Logger`, it ensures the logs directory exists.
+-   Each day gets its own log file named `DD-MM-YYYY.log`.
+-   Every log line includes UTC time, log level, and your message.
+-   Logs are then written to the file automatically.
+
+## Usage
+
+-   Instantiate a new Logger instance.
+-   Use `Logger#info()`, `Logger#warn()`, or `Logger#error()` with a message.
+-   Files are written to the `./logs` dir by default.
+
+```ts
+import { Logger } from "./Logger";
+
+const logger = new Logger({ logToStdout: true });
+
+logger.info("Connected to server");
+logger.warn("Memory is low");
+logger.error("Something went wrong");
+```

package/index.d.ts

@@ -0,0 +1,33 @@
+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 Logger(
+    config?: LoggerConfig
+): (type: "info" | "warn" | "error", message: string) => void;

package/index.js

@@ -0,0 +1,76 @@
+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 Logger(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 };

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@wlix/logger",
+  "version": "1.0.0",
+  "description": "A simple logger.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "private": false,
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "wlix",
+  "license": "ISC",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}