@anjianshi/utils 3.7.0 → 3.7.3

package/env-node/logging/handlers.d.ts

@@ -1,4 +1,4 @@
-import { type LogInfo, LogHandler } from '../../logging/index.js';
+import { type LogInfo, LogLevel, LogHandler } from '../../logging/index.js';
 /**
  * 向 console 输出日志
  */
@@ -22,12 +22,8 @@ export declare class ConsoleHandler extends LogHandler {
             (message?: any, ...optionalParams: any[]): void;
         };
     };
-    static readonly levelColors: {
-        1: import("chalk").ChalkInstance;
-        2: import("chalk").ChalkInstance;
-        3: import("chalk").ChalkInstance;
-        4: import("chalk").ChalkInstance;
-    };
+    /** 注意：这里的颜色必须是 chalk 支持的有效颜色 */
+    static readonly levelColors: Record<LogLevel, string>;
     private static readonly loggerColors;
     private static readonly loggerColorMap;
     static getLoggerColor(logger: string): "green" | "yellow" | "blue" | "cyan" | "magenta" | "greenBright" | "yellowBright" | "blueBright" | "cyanBright" | "magentaBright";

package/env-node/logging/handlers.js

@@ -12,7 +12,8 @@ export class ConsoleHandler extends LogHandler {
     log(info) {
         const { logger, level, args } = info;
         const method = ConsoleHandler.consoleMethods[level];
-        const levelColor = ConsoleHandler.levelColors[level];
+        const levelColorName = ConsoleHandler.levelColors[level];
+        const levelColor = chalk[levelColorName] ?? chalk.white;
         const levelName = formatters.level(info);
         const loggerColor = chalk[ConsoleHandler.getLoggerColor(logger)];
         const prefix = [
@@ -28,11 +29,12 @@ export class ConsoleHandler extends LogHandler {
         [LogLevel.Warning]: console.warn.bind(console),
         [LogLevel.Error]: console.error.bind(console),
     };
+    /** 注意：这里的颜色必须是 chalk 支持的有效颜色 */
     static levelColors = {
-        [LogLevel.Debug]: chalk.whiteBright,
-        [LogLevel.Info]: chalk.white,
-        [LogLevel.Warning]: chalk.yellowBright,
-        [LogLevel.Error]: chalk.redBright,
+        [LogLevel.Debug]: 'whiteBright',
+        [LogLevel.Info]: 'white',
+        [LogLevel.Warning]: 'yellowBright',
+        [LogLevel.Error]: 'redBright',
     };
     // 可供 logger 选择的颜色
     static loggerColors = [

package/env-node/logging/index.d.ts

@@ -2,7 +2,7 @@
  * 针对 Node.js 环境定制 logging
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  */
 import { type Logger } from '../../logging/index.js';
 export * from './handlers.js';

package/env-node/logging/index.js

@@ -2,7 +2,7 @@
  * 针对 Node.js 环境定制 logging
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  */
 import { logger as defaultLogger } from '../../logging/index.js';
 import { ConsoleHandler } from './handlers.js';

package/env-service/prisma/adapt-logging.d.ts

@@ -25,8 +25,13 @@ export declare function getPrismaLoggingOptions(level: 'debug' | 'info' | 'warn'
         level: "error";
     })[];
 };
-/** 把 Prisma 日志重定向到 logger 中 */
-export declare function adaptPrismaLogging(prisma: Pick<PrismalClient, '$on'>, logger: Logger, enableDebugLog?: boolean): void;
-/** 开启调试日志，并改为通过 logger 记录日志内容 */
+/** 把 Prisma 日常日志重定向到 logger 中 */
+export declare function adaptPrismaLogging(prisma: Pick<PrismalClient, '$on'>, logger: Logger): void;
+/**
+ * 开启调试日志，并改为通过 logger 记录日志内容
+ *
+ * 注意：
+ * 因为 Prisma 在代码被引入时就会开始输出日志，若要记录下最完整的日志内容，应在初始化 Prisma Client 前调用此函数
+ */
 export declare function adaptPrismaDebugLogging(logger: Logger): void;
 export {};

package/env-service/prisma/adapt-logging.js

@@ -2,7 +2,7 @@
  * 对接 Prisma 的日志记录
  *
  * 使用前提：
- * - 安装 chalk 依赖
+ * - 依赖 chalk 库
  *
  * Prisma 输出的日志分两部分：
  * 1. 日常运行日志，可通过 PrismaClient 的 log 选项控制。
@@ -50,8 +50,8 @@ export function getPrismaLoggingOptions(level) {
         ],
     };
 }
-/** 把 Prisma 日志重定向到 logger 中 */
-export function adaptPrismaLogging(prisma, logger, enableDebugLog = false) {
+/** 把 Prisma 日常日志重定向到 logger 中 */
+export function adaptPrismaLogging(prisma, logger) {
     const queryLogger = logger.getChild('query');
     prisma.$on('query', e => {
         queryLogger.debug(e.query, chalk.green(nodeUtil.format(e.params) + ` +${e.duration}ms`));
@@ -59,10 +59,13 @@ export function adaptPrismaLogging(prisma, logger, enableDebugLog = false) {
     prisma.$on('info', e => logger.info(e.message));
     prisma.$on('warn', e => logger.warn(e.message));
     prisma.$on('error', e => logger.error(e.message));
-    if (enableDebugLog)
-        adaptPrismaDebugLogging(logger);
 }
-/** 开启调试日志，并改为通过 logger 记录日志内容 */
+/**
+ * 开启调试日志，并改为通过 logger 记录日志内容
+ *
+ * 注意：
+ * 因为 Prisma 在代码被引入时就会开始输出日志，若要记录下最完整的日志内容，应在初始化 Prisma Client 前调用此函数
+ */
 export function adaptPrismaDebugLogging(logger) {
     ;
     globalThis.DEBUG = '*';

package/logging/adapt.js

@@ -34,9 +34,6 @@ export function adaptDebugLib(debugLib, enable = '', logger) {
     logger ??= getLogger('3rd-library');
     debugLib.log = logger.debug.bind(logger);
     if (enable) {
-        // 有些库（例如 prisma）重新实现了自己的 debug 库，且模仿 debug 也读取 DEBUG 环境变量。
-        // 这里除了设置 debug 库，顺便也适配这些遵循 debug 库模式的自定义库。
-        process.env.DEBUG = enable;
         debugLib.enable(enable);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "3.7.0",
+  "version": "3.7.3",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -41,9 +41,9 @@
     "@anjianshi/presets-eslint-base": "6.1.2",
     "@anjianshi/presets-eslint-node": "6.1.2",
     "@anjianshi/presets-eslint-react": "6.1.3",
-    "@anjianshi/presets-eslint-typescript": "6.1.2",
     "@anjianshi/presets-prettier": "3.2.0",
-    "@anjianshi/presets-typescript": "3.2.5"
+    "@anjianshi/presets-typescript": "3.2.5",
+    "@anjianshi/presets-eslint-typescript": "6.1.2"
   },
   "prettier": "@anjianshi/presets-prettier/prettierrc"
 }