@wiajs/log 4.3.13 → 4.3.16

package/dist/log.bs.cjs

@@ -0,0 +1,221 @@
+/*!
+  * wia log v4.3.15
+  * (c) 2024-2024 Sibyl Yu and contributors
+  * Released under the MIT License.
+  */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * 前端日志输出，封装 console日志，简化代码，支持模块或直接输出
+ * 调用时，描述字符串后置，便于可选缺省，输出时，自带前置，类似 后端pino，保持前后端一致性
+ * m 为模块，fn 为函数名称
+ */
+class Log {
+  /** @type {string} 模块 */
+  m = ''
+
+  /** @type {string} 函数 */
+  fn = ''
+
+  /**
+   * @param {string} m 模块
+   */
+  constructor(m) {
+    this.m = m;
+  }
+
+  /**
+   * get log desc
+   * 描述字符串作为最后参数调用，显示时，前置
+   * @param {*[]} args
+   * @returns {{desc: string, arg: *[]}}
+   */
+  getDesc(args) {
+    let R = {desc: '', arg: args};
+    try {
+      const _ = this;
+      const {m} = _;
+      let fn = '';
+      let desc = '';
+
+      if (args.length > 1) {
+        const last = args.at(-1);
+        if (typeof last === 'object') {
+          ;({desc, fn} = last);
+        } else if (typeof last === 'string') desc = last;
+        if (desc || fn) {
+          fn = fn || _.fn;
+          _.fn = fn;
+          args.pop();
+        }
+      }
+      fn = fn || _.fn;
+      if (m) desc = `${desc}[${m}${fn ? `:${fn}` : ''}]`; // eslint-disable-line
+      R = {desc, arg: args};
+    } catch (e) {
+      console.error(`getDesc exp:${e.message}`);
+    }
+
+    return R
+  }
+
+  /** @param {...any} args - params */
+  log(...args) {
+    const _ = this;
+    const last = args.at(-1);
+    // clear fn
+    if (args.length === 1 && typeof last === 'object' && last.fn) _.fn = '';
+    else {
+      const desc = _.getDesc(args);
+      console.log(desc, ...args);
+    }
+  }
+
+  /** @param {...any} args - params */
+  debug(...args) {
+    const _ = this;
+    const desc = _.getDesc(args);
+    if (desc) console.log(desc, ...args);
+    else console.log(...args);
+  }
+
+  /** @param {...any} args - params */
+  info(...args) {
+    const _ = this;
+    const desc = _.getDesc(args);
+    if (desc) console.info(desc, ...args);
+    else console.log(...args);
+  }
+
+  /** @param {...any} args - params */
+  warn(...args) {
+    const _ = this;
+    const {desc, arg} = _.getDesc(args);
+    if (desc) console.warn(desc, ...arg);
+    else console.log(...args);
+  }
+
+  /** @param {...any} args - params */
+  trace(...args) {
+    const _ = this;
+    const {desc, arg} = _.getDesc(args);
+    if (desc) console.trace(desc, ...arg);
+    else console.trace(...args);
+  }
+
+  /** @param {...any} args - params */
+  error(...args) {
+    const _ = this;
+    const {desc, arg} = _.getDesc(args);
+    if (desc) console.error(desc, ...arg);
+    else console.log(...args);
+  }
+
+  /**
+   * 用于 catch(e) log.err(e)
+   * @param {...any} args - params */
+  err(...args) {
+    const _ = this;
+    const first = args?.[0];
+    if (first instanceof Error || (first?.message && first?.cause && first?.stack))
+      args[0] = {exp: args[0].message};
+    _.error(...args);
+  }
+}
+
+/**
+ * get log desc
+ * 描述字符串作为最后参数调用，显示时，前置
+ * @param {*[]} args
+ * @returns {{desc: string, arg: *[]}}
+ */
+function getDesc(args) {
+  let desc = '';
+  const last = args.at(-1);
+  if (typeof last === 'string') {
+    desc = last;
+    args.pop();
+  }
+  return {desc, arg: args}
+}
+
+/**
+ * 标准日志输出或构建模块日志类实例，用于模块中带[m:xxx]标记日志输出
+ * 启用 {f:fn} 标记时，需在函数尾部清除f（log({f:''})），否则会溢出到其他函数
+ * @param {...any} args - params
+ * returns {*}
+ */
+function log(...args) {
+  const last = args.at(-1);
+
+  // 全局日志
+  if (args.length !== 1 || !last?.m) {
+    const desc = getDesc(args);
+    desc ? console.log(desc, ...args) : console.log(...args);
+    return // 退出，不创建实例
+  }
+
+  // 唯一 m 属性，则构造新的 log 实例，这种写法，能被jsDoc识别子属性
+  const lg = new Log(last?.m);
+  /** @param {*} args2 */
+  const R = (...args2) => lg.log(...args2);
+  R.debug = lg.debug.bind(lg);
+  R.info = lg.info.bind(lg);
+  R.warn = lg.warn.bind(lg);
+  R.info = lg.info.bind(lg);
+  R.trace = lg.trace.bind(lg);
+  R.error = lg.error.bind(lg);
+  R.err = lg.err.bind(lg);
+
+  return R
+}
+
+/**
+ * 用于 catch(e) log.err(e)
+ * @param {...any} args - params */
+log.err = (...args) => {
+  const {desc, arg} = getDesc(args);
+  const first = args?.[0];
+  if (first instanceof Error || (first?.message && first?.cause && first?.stack))
+    args[0] = {exp: args[0].message};
+  desc ? console.error(desc, ...arg) : console.error(...args);
+};
+
+/**
+ * @param {...any} args - params */
+log.error = (...args) => {
+  const {desc, arg} = getDesc(args);
+  desc ? console.error(desc, ...arg) : console.error(...args);
+};
+
+/**
+ * @param {...any} args - params */
+log.warn = (...args) => {
+  const {desc, arg} = getDesc(args);
+  desc ? console.warn(desc, ...arg) : console.warn(...args);
+};
+
+/**
+ * @param {...any} args - params */
+log.info = (...args) => {
+  const {desc, arg} = getDesc(args);
+  desc ? console.info(desc, ...arg) : console.info(...args);
+};
+
+/**
+ * @param {...any} args - params */
+log.debug = (...args) => {
+  const {desc, arg} = getDesc(args);
+  desc ? console.log(desc, ...arg) : console.log(...args);
+};
+
+/**
+ * @param {...any} args - params */
+log.trace = (...args) => {
+  const {desc, arg} = getDesc(args);
+  desc ? console.trace(desc, ...arg) : console.trace(...args);
+};
+
+exports.default = log;

package/dist/log.cjs

@@ -1,5 +1,5 @@
 /*!
-  * wia log v4.3.13
+  * wia log v4.3.15
   * (c) 2024-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -35,18 +35,18 @@ class Log {
   constructor(opts) {
     let {env} = opts;
     env = env ?? '';
-    const ds = {}; // debugs
-    ds.debug = debug(`${env}`);
-    ds.info = debug(`${env}:info`);
-    ds.err = debug(`${env}:err`);
-    ds.warn = debug(`${env}:warn`);
+    const dgs = {}; // debugs
+    dgs.debug = debug(`${env}`);
+    dgs.info = debug(`${env}:info`);
+    dgs.err = debug(`${env}:err`);
+    dgs.warn = debug(`${env}:warn`);
 
     // 仅最后调用生效，覆盖环境变量
-    if (ds.debug.enabled) debug.enable('*');
-    else if (ds.info.enabled) debug.enable(`${env}:info,${env}:err,${env}:warn`);
+    if (dgs.debug.enabled) debug.enable('*');
+    else if (dgs.info.enabled) debug.enable(`${env}:info,${env}:err,${env}:warn`);
     else debug.enable(`${env}:err,${env}:warn`);
 
-    this.ds = ds;
+    this.dgs = dgs;
   }
 
   /**
@@ -57,9 +57,9 @@ class Log {
     const first = args?.at(0);
     const last = args?.at(-1);
     if (typeof first === 'string') {
-      args[0] = `${first}`;
-      this.ds.debug(...args);
-    } else if (typeof first === 'object' && typeof last === 'string') this.ds.debug(`${last}:%O`, first);
+      args.shift();      
+      this.dgs.debug(first, ...args);
+    } else if (typeof first === 'object' && typeof last === 'string') this.dgs.debug(`${last}:%O`, first);
     // args[0] = `${this.pre}:${args[0]}`
     // console.debug(...args)
     // console.debug(this.pre, ...args)
@@ -73,9 +73,9 @@ class Log {
     const first = args?.at(0);
     const last = args?.at(-1);
     if (typeof first === 'string') {
-      args[0] = ` ${first}`;
-      this.ds.err(...args);
-    } else if (typeof first === 'object' && typeof last === 'string') this.ds.err(` ${last}:%O`, first);
+      args.shift();
+      this.dgs.err(` ${first}`, ...args);
+    } else if (typeof first === 'object' && typeof last === 'string') this.dgs.err(` ${last}:%O`, first);
   }
 
   /**
@@ -98,8 +98,11 @@ class Log {
   warn(...args) {
     const first = args?.at(0);
     const last = args?.at(-1);
-    if (typeof first === 'string') this.ds.warn(...args);
-    else if (typeof first === 'object' && typeof last === 'string') this.ds.warn(`${last}:%O`, first);
+    if (typeof first === 'string') {
+      args.shift();
+      this.dgs.warn(first, ...args);
+    }
+    else if (typeof first === 'object' && typeof last === 'string') this.dgs.warn(`${last}:%O`, first);
   }
 
   /**
@@ -107,10 +110,15 @@ class Log {
    * @param  {...any} args
    */
   info(...args) {
-    const first = args?.at(0);
+    const first = args?.at(0);    
     const last = args?.at(-1);
-    if (typeof first === 'string') this.ds.info(...args);
-    else if (typeof first === 'object' && typeof last === 'string') this.ds.info(`${last}:%O`, first);
+    // const dg = debug('ab')
+    // dg()
+    if (typeof first === 'string') {
+      args.shift();
+      this.dgs.info(first, ...args);
+    }
+    else if (typeof first === 'object' && typeof last === 'string') this.dgs.info(`${last}:%O`, first);
   }
 }