@ubean/shared 0.3.4 → 0.3.6

package/dist/logger/hono.js

@@ -1,4 +1,4 @@
-import { n as getLogger } from "../logger-CG0K8cWb.js";
+import { n as getLogger } from "../logger-C9j4b6yh.js";
 //#region src/logger/hono.ts
 /**
 * 判断路径是否应被跳过。

package/dist/logger/index.d.ts

@@ -3,9 +3,11 @@ import { i as UbeanLoggerOptions, n as RequestLoggerOptions, r as UbeanLogger, t
 /**
  * 创建一个 ubean 命名的 tslog logger(默认 name 为 `ubean`)。
  *
- * - 未显式提供 `minLevel` 时读取 `LOG_LEVEL`/`TSLOG_LEVEL` 环境变量
- * - 输出格式沿用 tslog 默认:交互式终端彩色 pretty,管道/CI 自动去色;需要结构化 JSON 时显式
- *   `{ type: 'json' }` 或设 `TSLOG_TYPE=json`
+ * - 未显式提供 `minLevel` 时读取 `LOG_LEVEL`/`TSLOG_LEVEL` 环境变量,
+ *   都没有则默认 `info`(debug/silly 需显式打开)
+ * - pretty 输出默认仅消息(精简模板);debug 模式或显式 `pretty.template` 时按需覆盖,
+ *   交互式终端彩色、管道/CI 自动去色
+ * - 需要结构化 JSON 时显式 `{ type: 'json' }` 或设 `TSLOG_TYPE=json`
  *
  * @example
  * ```ts
@@ -30,5 +32,18 @@ declare const logger: UbeanLogger;
  * ```
  */
 declare function getLogger(scope?: string, options?: UbeanLoggerOptions): UbeanLogger;
+/**
+ * 切换 debug 日志模式,对所有已创建的 logger 实例(含子 logger)即时生效:
+ * - `true`:输出详细日志(日期 + 等级 + 调用位置 + logger 名)
+ * - `false`:恢复精简输出(仅消息)
+ *
+ * 供 CLI 在解析 `--debug` 后调用。
+ *
+ * @example
+ * ```ts
+ * setDebugLogging(process.argv.includes('--debug'));
+ * ```
+ */
+declare function setDebugLogging(enabled: boolean): void;
 //#endregion
-export { type LogLevelName, type RequestLoggerOptions, type UbeanLogger, type UbeanLoggerOptions, createUbeanLogger, getLogger, logger };
+export { type LogLevelName, type RequestLoggerOptions, type UbeanLogger, type UbeanLoggerOptions, createUbeanLogger, getLogger, logger, setDebugLogging };

package/dist/logger/index.js

@@ -1,2 +1,2 @@
-import { n as getLogger, r as logger, t as createUbeanLogger } from "../logger-CG0K8cWb.js";
-export { createUbeanLogger, getLogger, logger };
+import { i as setDebugLogging, n as getLogger, r as logger, t as createUbeanLogger } from "../logger-C9j4b6yh.js";
+export { createUbeanLogger, getLogger, logger, setDebugLogging };

package/dist/logger-C9j4b6yh.js

@@ -0,0 +1,134 @@
+import { Logger } from "tslog";
+//#region src/logger/logger.ts
+const DEFAULT_NAME = "ubean";
+/**
+* 默认精简模板:空模板 → 仅输出消息(无日期 / 等级 / 路径),适合 CLI 日常使用。
+* 需要完整上下文(日期 + 调用位置 + logger 名)时,用 `setDebugLogging(true)` 切换。
+*/
+const DEFAULT_PRETTY_TEMPLATE = "";
+/**
+* debug 模式的详细模板:日期 + 等级 + 调用位置 + logger 名 + 消息。
+* 仅在显式开启 debug 日志时使用(见 {@link setDebugLogging})。
+*/
+const DEBUG_PRETTY_TEMPLATE = "{{yyyy}}.{{mm}}.{{dd}} {{hh}}:{{MM}}:{{ss}}	{{logLevelName}}	{{filePathWithLine}}	{{nameWithDelimiterPrefix}}	";
+/** 未显式配置时的默认等级:info(debug/silly 需通过 LOG_LEVEL 打开) */
+const DEFAULT_MIN_LEVEL = "INFO";
+/** 是否处于 debug 模式(输出详细模板) */
+let debugMode = false;
+/** 已创建的 logger 实例注册表,`setDebugLogging` 切换模板时统一更新(含子 logger) */
+const instances = /* @__PURE__ */ new Set();
+function registerInstance(instance) {
+	instances.add(instance);
+	return instance;
+}
+/**
+* 运行时切换单个实例的栈捕获。
+*
+* tslog 在构造时一次性计算 `captureStackForMeta`(`_shouldCaptureStack()`),之后仅在每次
+* 日志调用时读取该标志决定是否解析调用位置。因此运行期切换模板时,需要同步刷新这个内部
+* 标志(否则 debug 模板中的 `{{filePathWithLine}}` 渲染为空)。该属性为 tslog 私有字段,
+* 这里通过受控的类型断言访问——本模块是 tslog 的唯一集成点,且 tslog 版本已锁定。
+*/
+function setStackCapture(instance, enabled) {
+	instance.settings = {
+		...instance.settings,
+		stack: {
+			...instance.settings.stack,
+			capture: enabled ? "full" : "auto"
+		}
+	};
+	instance.captureStackForMeta = enabled;
+}
+/** 按当前 debug 模式刷新单个实例的 pretty 模板与栈捕获 */
+function applyDebugMode(instance) {
+	instance.settings = {
+		...instance.settings,
+		pretty: {
+			...instance.settings.pretty,
+			template: debugMode ? DEBUG_PRETTY_TEMPLATE : DEFAULT_PRETTY_TEMPLATE
+		}
+	};
+	setStackCapture(instance, debugMode);
+}
+/**
+* 从环境变量解析日志等级:
+* 1. `LOG_LEVEL`(ubean 约定,友好别名)
+* 2. `TSLOG_LEVEL`(tslog 原生)
+*
+* 返回 undefined 时沿用 tslog 默认 minLevel。
+*/
+function getLogLevelFromEnv() {
+	if (typeof process === "undefined" || !process.env) return void 0;
+	const value = process.env.LOG_LEVEL ?? process.env.TSLOG_LEVEL;
+	if (!value) return void 0;
+	return value;
+}
+/**
+* 创建一个 ubean 命名的 tslog logger(默认 name 为 `ubean`)。
+*
+* - 未显式提供 `minLevel` 时读取 `LOG_LEVEL`/`TSLOG_LEVEL` 环境变量,
+*   都没有则默认 `info`(debug/silly 需显式打开)
+* - pretty 输出默认仅消息(精简模板);debug 模式或显式 `pretty.template` 时按需覆盖,
+*   交互式终端彩色、管道/CI 自动去色
+* - 需要结构化 JSON 时显式 `{ type: 'json' }` 或设 `TSLOG_TYPE=json`
+*
+* @example
+* ```ts
+* const log = createUbeanLogger({ name: 'api' });
+* log.info({ port: 3000 }, 'server started');
+* ```
+*/
+function createUbeanLogger(options = {}) {
+	const minLevel = options.minLevel ?? getLogLevelFromEnv() ?? DEFAULT_MIN_LEVEL;
+	return registerInstance(new Logger({
+		name: DEFAULT_NAME,
+		...options,
+		pretty: {
+			template: debugMode ? DEBUG_PRETTY_TEMPLATE : DEFAULT_PRETTY_TEMPLATE,
+			timeZone: "local",
+			...options.pretty
+		},
+		minLevel
+	}));
+}
+/** ubean 全局默认 logger(供应用侧 `import { logger } from 'ubean'` 使用) */
+const logger = createUbeanLogger();
+/**
+* 获取命名(scope)logger。
+*
+* - 不传 scope 时返回全局默认 `logger`
+* - 传 scope 时返回其子 logger(name 组合为 `ubean:<scope>`,如 `getLogger('cli')` → `ubean:cli`),
+*   继承父 logger 的 settings/minLevel,可通过 `options` 覆盖
+*
+* @example
+* ```ts
+* const cli = getLogger('cli');
+* cli.info('building...');
+* ```
+*/
+function getLogger(scope, options = {}) {
+	if (!scope) return logger;
+	return registerInstance(logger.getSubLogger({
+		name: scope,
+		...options
+	}));
+}
+/**
+* 切换 debug 日志模式,对所有已创建的 logger 实例(含子 logger)即时生效:
+* - `true`:输出详细日志(日期 + 等级 + 调用位置 + logger 名)
+* - `false`:恢复精简输出(仅消息)
+*
+* 供 CLI 在解析 `--debug` 后调用。
+*
+* @example
+* ```ts
+* setDebugLogging(process.argv.includes('--debug'));
+* ```
+*/
+function setDebugLogging(enabled) {
+	if (debugMode === enabled) return;
+	debugMode = enabled;
+	for (const instance of instances) applyDebugMode(instance);
+}
+//#endregion
+export { setDebugLogging as i, getLogger as n, logger as r, createUbeanLogger as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubean/shared",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Shared protocol types, errors, env and universal utilities for ubean",
   "files": [
     "dist"

package/dist/logger-CG0K8cWb.js

@@ -1,61 +0,0 @@
-import { Logger } from "tslog";
-//#region src/logger/logger.ts
-const DEFAULT_NAME = "ubean";
-/**
-* 从环境变量解析日志等级:
-* 1. `LOG_LEVEL`(ubean 约定,友好别名)
-* 2. `TSLOG_LEVEL`(tslog 原生)
-*
-* 返回 undefined 时沿用 tslog 默认 minLevel。
-*/
-function getLogLevelFromEnv() {
-	if (typeof process === "undefined" || !process.env) return void 0;
-	const value = process.env.LOG_LEVEL ?? process.env.TSLOG_LEVEL;
-	if (!value) return void 0;
-	return value;
-}
-/**
-* 创建一个 ubean 命名的 tslog logger(默认 name 为 `ubean`)。
-*
-* - 未显式提供 `minLevel` 时读取 `LOG_LEVEL`/`TSLOG_LEVEL` 环境变量
-* - 输出格式沿用 tslog 默认:交互式终端彩色 pretty,管道/CI 自动去色;需要结构化 JSON 时显式
-*   `{ type: 'json' }` 或设 `TSLOG_TYPE=json`
-*
-* @example
-* ```ts
-* const log = createUbeanLogger({ name: 'api' });
-* log.info({ port: 3000 }, 'server started');
-* ```
-*/
-function createUbeanLogger(options = {}) {
-	const minLevel = options.minLevel ?? getLogLevelFromEnv();
-	return new Logger({
-		name: DEFAULT_NAME,
-		...options,
-		minLevel
-	});
-}
-/** ubean 全局默认 logger(供应用侧 `import { logger } from 'ubean'` 使用) */
-const logger = createUbeanLogger();
-/**
-* 获取命名(scope)logger。
-*
-* - 不传 scope 时返回全局默认 `logger`
-* - 传 scope 时返回其子 logger(name 组合为 `ubean:<scope>`,如 `getLogger('cli')` → `ubean:cli`),
-*   继承父 logger 的 settings/minLevel,可通过 `options` 覆盖
-*
-* @example
-* ```ts
-* const cli = getLogger('cli');
-* cli.info('building...');
-* ```
-*/
-function getLogger(scope, options = {}) {
-	if (!scope) return logger;
-	return logger.getSubLogger({
-		name: scope,
-		...options
-	});
-}
-//#endregion
-export { getLogger as n, logger as r, createUbeanLogger as t };