@chaeco/logger 0.1.7

package/dist/utils/formatter.js

@@ -0,0 +1,166 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogFormatter = void 0;
+const color_utils_1 = require("./color-utils");
+const dayjs_1 = __importDefault(require("dayjs"));
+/**
+ * 日志格式化器
+ * @internal
+ * 负责将 LogEntry 转换为可输出的字符串，支持普通文本、彩色控制台和 JSON 格式。
+ */
+class LogFormatter {
+    constructor(settings) {
+        this.settings = settings;
+    }
+    /**
+     * 更新格式化选项（支持部分更新）
+     */
+    updateFormat(options) {
+        const f = this.settings.format;
+        if (options.enabled !== undefined)
+            f.enabled = options.enabled;
+        if (options.timestampFormat !== undefined)
+            f.timestampFormat = options.timestampFormat;
+        if (options.formatter !== undefined)
+            f.formatter = options.formatter;
+        if (options.includeStack !== undefined)
+            f.includeStack = options.includeStack;
+        if (options.includeName !== undefined)
+            f.includeName = options.includeName;
+        if (options.json !== undefined)
+            f.json = options.json;
+        if (options.jsonIndent !== undefined)
+            f.jsonIndent = options.jsonIndent;
+    }
+    // ─── 公开格式化方法 ───────────────────────────────────────
+    /**
+     * 格式化为文件输出字符串。
+     * 注意：文件日志始终包含时间戳，与控制台的 consoleTimestamp 开关无关。
+     */
+    formatMessage(entry) {
+        const { format } = this.settings;
+        // 自定义格式化函数
+        if (format.enabled && format.formatter) {
+            try {
+                return format.formatter(entry);
+            }
+            catch (error) {
+                console.error('Error in custom formatter:', error);
+                // 降级到默认格式
+            }
+        }
+        // JSON 格式输出
+        if (format.json) {
+            const jsonEntry = {
+                timestamp: entry.timestamp,
+                level: entry.level,
+                message: entry.message,
+            };
+            if (format.includeName && entry.name)
+                jsonEntry.name = entry.name;
+            if (format.includeStack && entry.file && entry.line) {
+                jsonEntry.file = entry.file;
+                jsonEntry.line = entry.line;
+            }
+            if (entry.data !== undefined)
+                jsonEntry.data = entry.data;
+            return this.safeStringify(jsonEntry, format.jsonIndent);
+        }
+        // 默认格式：文件日志始终包含时间戳
+        return this.buildPlainText(entry, true);
+    }
+    /**
+     * 格式化为带 ANSI 颜色的控制台字符串。
+     * 无色模式下使用纯文本，且遵守 consoleTimestamp 开关（与文件格式独立）。
+     * 自定义 formatter 函数的优先级高于颜色开关。
+     */
+    formatConsoleMessage(entry) {
+        const { consoleColors, consoleTimestamp, format } = this.settings;
+        // 自定义格式化函数优先——无论是否启用颜色，均走自定义逻辑
+        if (format.enabled && format.formatter) {
+            try {
+                return format.formatter(entry);
+            }
+            catch (error) {
+                console.error('Error in custom formatter:', error);
+                // 降级到默认格式
+            }
+        }
+        if (!consoleColors) {
+            // 无色模式：纯文本，遵守 consoleTimestamp 开关。
+            // 不能调用 formatMessage()，因为文件格式始终包含时间戳，两者策略不同。
+            return this.buildPlainText(entry, consoleTimestamp);
+        }
+        const parts = [];
+        if (consoleTimestamp) {
+            parts.push(color_utils_1.ColorUtils.colorizeTimestamp(entry.timestamp));
+        }
+        if (entry.name)
+            parts.push(color_utils_1.ColorUtils.colorizeName(entry.name));
+        parts.push(color_utils_1.ColorUtils.colorizeLevel(entry.level));
+        if (entry.file && entry.line) {
+            parts.push(color_utils_1.ColorUtils.colorizeFileLocation(`${entry.file}:${entry.line}`));
+        }
+        parts.push(color_utils_1.ColorUtils.colorizeMessage(entry.level, entry.message));
+        if (entry.data !== undefined)
+            parts.push(this.safeStringify(entry.data));
+        return parts.join(' ');
+    }
+    // ─── 私有辅助 ───────────────────────────────────────────────
+    /**
+     * 构建纯文本日志行，供文件输出和无色控制台复用。
+     * @param includeTimestamp 是否包含时间戳（文件格式始终传 true；控制台按 consoleTimestamp 传入）
+     */
+    buildPlainText(entry, includeTimestamp) {
+        const { format } = this.settings;
+        const parts = [];
+        if (includeTimestamp) {
+            const ts = (0, dayjs_1.default)(entry.timestamp).format(format.timestampFormat);
+            parts.push(`[${ts}]`);
+        }
+        if (format.includeName && entry.name)
+            parts.push(`[${entry.name}]`);
+        parts.push(entry.level.toUpperCase().padEnd(6));
+        if (format.includeStack && entry.file && entry.line) {
+            parts.push(`(${entry.file}:${entry.line})`);
+        }
+        parts.push(entry.message);
+        if (entry.data !== undefined)
+            parts.push(this.safeStringify(entry.data));
+        return parts.join(' ');
+    }
+    /**
+     * 安全的 JSON 序列化，处理循环引用
+     */
+    safeStringify(obj, indent) {
+        // 基础类型直接返回或使用默认序列化，提升性能
+        if (obj === null || typeof obj !== 'object')
+            return String(obj);
+        try {
+            // 只有对象才需要 WeakSet 检查循环引用
+            const seen = new WeakSet();
+            return JSON.stringify(obj, (_key, value) => {
+                if (typeof value === 'object' && value !== null) {
+                    if (seen.has(value))
+                        return '[Circular]';
+                    seen.add(value);
+                }
+                return value;
+            }, indent);
+        }
+        catch {
+            try {
+                return String(obj);
+            }
+            catch {
+                return '[Unable to serialize]';
+            }
+        }
+    }
+}
+exports.LogFormatter = LogFormatter;
+//# sourceMappingURL=formatter.js.map

package/dist/utils/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../src/utils/formatter.ts"],"names":[],"mappings":";AAAA,uDAAuD;;;;;;AAGvD,+CAA0C;AAC1C,kDAAyB;AAmBzB;;;;GAIG;AACH,MAAa,YAAY;IAGvB,YAAY,QAA2B;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,OAA+B;QAC1C,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;QAC9B,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;YAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QAC9D,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS;YAAE,CAAC,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;QACtF,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;YAAE,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QACpE,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;YAAE,CAAC,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;QAC7E,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAAE,CAAC,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QAC1E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,CAAC,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACrD,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS;YAAE,CAAC,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;IACzE,CAAC;IAED,sDAAsD;IAEtD;;;OAGG;IACH,aAAa,CAAC,KAAe;QAC3B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAA;QAEhC,WAAW;QACX,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;gBAClD,UAAU;YACZ,CAAC;QACH,CAAC;QAED,YAAY;QACZ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,SAAS,GAA4B;gBACzC,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAA;YACD,IAAI,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI;gBAAE,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;YACjE,IAAI,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACpD,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;gBAC3B,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;YAC7B,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;gBAAE,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;YACzD,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACzD,CAAC;QAED,mBAAmB;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,KAAe;QAClC,MAAM,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAA;QAEjE,+BAA+B;QAC/B,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;gBAClD,UAAU;YACZ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,mCAAmC;YACnC,6CAA6C;YAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;QACrD,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,wBAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAA;QAC3D,CAAC;QAED,IAAI,KAAK,CAAC,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,wBAAU,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;QAE/D,KAAK,CAAC,IAAI,CAAC,wBAAU,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;QAEjD,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,wBAAU,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;QAC5E,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,wBAAU,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;QAElE,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;QAExE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,2DAA2D;IAE3D;;;OAGG;IACK,cAAc,CAAC,KAAe,EAAE,gBAAyB;QAC/D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAA;QAChC,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,EAAE,GAAG,IAAA,eAAK,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;YAChE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACvB,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;QAEnE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAE/C,IAAI,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;QAC7C,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAEzB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;QAExE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,GAAQ,EAAE,MAAe;QAC7C,wBAAwB;QACxB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;QAE/D,IAAI,CAAC;YACH,yBAAyB;YACzB,MAAM,IAAI,GAAG,IAAI,OAAO,EAAE,CAAA;YAC1B,OAAO,IAAI,CAAC,SAAS,CACnB,GAAG,EACH,CAAC,IAAY,EAAE,KAAU,EAAE,EAAE;gBAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBAChD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;wBAAE,OAAO,YAAY,CAAA;oBACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBACjB,CAAC;gBACD,OAAO,KAAK,CAAA;YACd,CAAC,EACD,MAAM,CACP,CAAA;QACH,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC;gBACH,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;YACpB,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,uBAAuB,CAAA;YAChC,CAAC;QACH,CAAC;IACH,CAAC;CACF;AApKD,oCAoKC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@chaeco/logger",
+  "version": "0.1.7",
+  "description": "A comprehensive logging module with file rotation, colors, and multiple log levels",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "build:watch": "tsc --watch",
+    "dev": "tsx src/index.ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"examples/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"examples/**/*.ts\"",
+    "docs": "typedoc --out docs src/index.ts",
+    "docs:watch": "typedoc --out docs src/index.ts --watch",
+    "prepublishOnly": "npm run build && npm test",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "logger",
+    "logging",
+    "file-rotation",
+    "colors",
+    "typescript"
+  ],
+  "author": "iptodays",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:chaeco/logger.git"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.0",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.0.0",
+    "typedoc": "^0.25.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@chaeco/indexed-db-storage": "github:chaeco/indexed-db-storage",
+    "chalk": "^5.3.0",
+    "dayjs": "^1.11.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}