ph-utils 0.6.2 → 0.7.0

package/lib/file.js

@@ -12,19 +12,20 @@ import fs from "node:fs/promises";
  * @returns 文件内容
  */
 export async function read(filepath, defaultValue) {
-  let content;
-  try {
-    content = await fs.readFile(filepath, "utf8");
-    if (defaultValue != null && typeof defaultValue === "object") {
-      return JSON.parse(content);
+    let content;
+    try {
+        content = await fs.readFile(filepath, "utf8");
+        if (defaultValue != null && typeof defaultValue === "object") {
+            return JSON.parse(content);
+        }
+        return content;
     }
-    return content;
-  } catch (error) {
-    if (defaultValue === undefined) {
-      throw error;
+    catch (error) {
+        if (defaultValue === undefined) {
+            throw error;
+        }
+        return defaultValue;
     }
-    return defaultValue;
-  }
 }
 /**
  * 写入 JSON 格式的数据到文件
@@ -35,12 +36,12 @@ export async function read(filepath, defaultValue) {
  * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
  */
 export async function write(file, data, opts) {
-  let writeData = data.toString();
-  opts = { json: true, format: true, ...opts };
-  if (opts.json === true && typeof data === "object") {
-    writeData = JSON.stringify(data, null, opts.format === true ? 2 : 0);
-  }
-  return await fs.writeFile(path.resolve(file), writeData);
+    let writeData = data.toString();
+    opts = { json: true, format: true, ...opts };
+    if (opts.json === true && typeof data === "object") {
+        writeData = JSON.stringify(data, null, opts.format === true ? 2 : 0);
+    }
+    return await fs.writeFile(path.resolve(file), writeData);
 }
 /**
  * 根据文件的 stat 获取文件的 etag
@@ -48,6 +49,6 @@ export async function write(file, data, opts) {
  * @returns file stat etag
  */
 export async function statTag(filePath) {
-  let stat = await fs.stat(filePath);
-  return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
+    let stat = await fs.stat(filePath);
+    return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
 }

package/lib/logger.d.ts

@@ -0,0 +1,62 @@
+type LoggerLevel = "debug" | "info" | "warn" | "error" | "fatal";
+/** 日志消息类型 */
+type MessageIntf = number | string | boolean | object | any[] | Error;
+/** 日志消息选项 */
+type MessageOption = {
+    /** 日志名称 */
+    name?: string;
+    /** 日志级别 */
+    level?: LoggerLevel;
+    /** 日志消息 */
+    message: MessageIntf;
+    /** 当前消息是否美化输出 */
+    pretty?: boolean;
+    /** 如果消息是 JSON 格式, 转换为字符串时, 是否格式化 JSON */
+    jsonSpace?: number;
+};
+type LoggerOption = {
+    /** 记录的日志名称, 通常用于表明哪个页面 */
+    name?: string;
+    /** 记录日志级别, 通常上线时 error 或者禁用日志, 默认: debug */
+    level?: LoggerLevel;
+    /** 是否需要美化输出, 默认: true */
+    pretty?: boolean;
+};
+/**
+ * 日志记录器
+ */
+export declare class Logger {
+    /** 日志级别 */
+    levels: string[];
+    colors: {
+        debug: string;
+        info: string;
+        warn: string;
+        error: string;
+    };
+    option: LoggerOption & {
+        levelNum: number;
+    };
+    /** 构造日志记录器 */
+    constructor(option?: LoggerOption);
+    setOption(option: LoggerOption): void;
+    log(message: MessageIntf | MessageOption): void;
+    info(message: MessageIntf | MessageOption): void;
+    debug(message: MessageIntf | MessageOption): void;
+    warn(message: MessageIntf | MessageOption): void;
+    error(message: MessageIntf | MessageOption): void;
+    fatal(message: MessageIntf | MessageOption): void;
+    getLevel(): string;
+    getName(): string | undefined;
+    getOption(): LoggerOption & {
+        levelNum: number;
+    };
+    private generateLog;
+    /** 格式化显示 */
+    private formatShow;
+}
+/** 默认日志记录器 */
+export declare const logger: Logger;
+/** 获取新的日志记录器, 属性采用之前的 */
+export declare const getLogger: (option?: LoggerOption) => Logger;
+export {};

package/lib/logger.js

@@ -0,0 +1,123 @@
+import { format } from "./date";
+/**
+ * 日志记录器
+ */
+export class Logger {
+    /** 日志级别 */
+    levels = ["debug", "info", "warn", "error", "fatal"];
+    colors = {
+        debug: "#909399",
+        info: "#1677ff",
+        warn: "#fadb14",
+        error: "#eb2f96",
+    };
+    option;
+    /** 构造日志记录器 */
+    constructor(option) {
+        this.setOption(option || {});
+    }
+    setOption(option) {
+        let opts = { level: "debug", levelNum: 0, pretty: true, ...option };
+        opts.levelNum = this.levels.indexOf(opts.level);
+        this.option = opts;
+    }
+    log(message) {
+        let msgInfo = {
+            name: this.option.name,
+            level: "info",
+            time: format(null, "yyyy-mm-dd HH:MM:ss.S"),
+            pretty: this.option.pretty,
+            jsonSpace: 0,
+        };
+        let msgContent = message;
+        if (typeof message === "object") {
+            if (message instanceof Error) {
+                msgInfo.level = "error";
+                msgContent = msgContent.stack;
+            }
+            else if (message.message != null) {
+                msgContent = message.message;
+                msgInfo = { ...msgInfo, ...message };
+            }
+        }
+        if (typeof msgContent === "object") {
+            try {
+                msgInfo.message = JSON.stringify(msgContent, null, msgInfo.jsonSpace);
+            }
+            catch (error) {
+                msgInfo.message = msgContent.toString();
+            }
+        }
+        else {
+            msgInfo.message = msgContent;
+        }
+        if (msgInfo.pretty == null) {
+            msgInfo.pretty = this.option.pretty;
+        }
+        let levelIndex = this.levels.indexOf(msgInfo.level);
+        if (levelIndex >= this.option.levelNum) {
+            this.formatShow(msgInfo);
+        }
+    }
+    info(message) {
+        this.log(this.generateLog(message, "info"));
+    }
+    debug(message) {
+        this.log(this.generateLog(message, "debug"));
+    }
+    warn(message) {
+        this.log(this.generateLog(message, "warn"));
+    }
+    error(message) {
+        this.log(this.generateLog(message, "error"));
+    }
+    fatal(message) {
+        this.log(this.generateLog(message, "fatal"));
+    }
+    getLevel() {
+        return this.levels[this.option.levelNum];
+    }
+    getName() {
+        return this.option.name;
+    }
+    getOption() {
+        return this.option;
+    }
+    generateLog(message, level = "info") {
+        let msgInfo = {
+            message: message,
+        };
+        if (typeof message === "object") {
+            if (message.message != null) {
+                msgInfo = message;
+            }
+        }
+        msgInfo["level"] = level;
+        return msgInfo;
+    }
+    /** 格式化显示 */
+    formatShow(msg) {
+        if (msg.level === "fatal") {
+            msg.level = "error";
+        }
+        const res = [`[${msg.time}]`];
+        if (msg.name != null) {
+            res.push(`[${msg.name}]`);
+        }
+        res.push(`- ${msg.message}`);
+        if (!msg.pretty) {
+            res.splice(1, 0, `${msg.level.toUpperCase()}`);
+            console[msg.level](res.join(" "));
+        }
+        else {
+            const color = this.colors[msg.level];
+            console.log(`%c ${`${msg.level.toUpperCase()}`} %c ${res.join(" ")} %c`, `background:${color};border:1px solid ${color}; padding: 1px; border-radius: 2px 0 0 2px; color: #fff;`, `border:1px solid ${color}; padding: 1px; border-radius: 0 2px 2px 0; color: ${color};`, "background:transparent");
+        }
+    }
+}
+/** 默认日志记录器 */
+export const logger = new Logger({ name: "APP" });
+/** 获取新的日志记录器, 属性采用之前的 */
+export const getLogger = (option) => {
+    return new Logger({ ...logger.getOption(), ...option });
+};

package/package.json

@@ -52,7 +52,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.6.2",
+  "version": "0.7.0",
   "type": "module",
   "repository": {
     "type": "git",