mm_logger 0.0.0-stage → 1.0.1

package/index.js

@@ -0,0 +1,27 @@
+const Logger = require('./lib/logger');
+const ConsoleLogger = require('./lib/console_logger');
+const Admin = require('mm_corejs').Admin;
+
+let admin = new Admin();
+admin.setClass(Logger);
+
+module.exports = {
+  LEVEL: require('./lib/level'),
+  Logger,
+  // 轻量控制台日志器（自 mm_corejs 迁移，类名避免与 Logger 冲突）
+  ConsoleLogger,
+  // 颜色工具（自 mm_corejs 迁移），结构与 mm_corejs.colors 保持一致
+  colors: require('./lib/colors'),
+  admin,
+  // 获取日志记录器实例（<模块>Admin 范式）
+  loggerAdmin(scope, config) {
+    if (!scope) {
+      scope = 'os';
+    }
+    return admin.get(scope, config);
+  },
+  // 兼容旧调用名
+  getLogger() {
+    return admin.get('os');
+  }
+};

package/jest.config.js

@@ -0,0 +1,18 @@
+'use strict';
+
+/**
+ * Jest 测试配置
+ */
+module.exports = {
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/test/**/*.test.js'],
+  collectCoverageFrom: ['lib/colors.js', 'lib/console_logger.js'],
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  }
+};

package/lib/colors.js

@@ -0,0 +1,200 @@
+// lib/colors.js
+'use strict';
+
+const os = require('os');
+
+/* =============================================================
+ * 1. ANSI 样式表
+ *    每项为 [开启码, 关闭码]
+ *    前景色关闭用 39，背景色关闭用 49，而不是 0（0 会清掉所有样式）
+ * =========================================================== */
+const STYLES = {
+  reset: [0, 0],
+  bold: [1, 22],
+  dim: [2, 22],
+  italic: [3, 23],
+  underline: [4, 24],
+  blink: [5, 25],
+  inverse: [7, 27],
+  hidden: [8, 28],
+  strikethrough: [9, 29],
+
+  black: [30, 39], red: [31, 39], green: [32, 39], yellow: [33, 39],
+  blue: [34, 39], magenta: [35, 39], cyan: [36, 39], white: [37, 39],
+  gray: [90, 39], grey: [90, 39],
+
+  redBright: [91, 39], greenBright: [92, 39], yellowBright: [93, 39],
+  blueBright: [94, 39], magentaBright: [95, 39], cyanBright: [96, 39],
+  whiteBright: [97, 39],
+
+  bgBlack: [40, 49], bgRed: [41, 49], bgGreen: [42, 49], bgYellow: [43, 49],
+  bgBlue: [44, 49], bgMagenta: [45, 49], bgCyan: [46, 49], bgWhite: [47, 49],
+  bgGray: [100, 49], bgGrey: [100, 49],
+};
+
+/* =============================================================
+ * 2. 环境检测
+ * =========================================================== */
+
+// ---- Windows：判断当前终端是否支持 ANSI/VT ----
+let _win_vt = null;
+
+/**
+ * 判断当前终端是否支持 ANSI/VT
+ * @returns {boolean} 是否支持
+ */
+function windowsSupportsVT() {
+  if (_win_vt !== null) return _win_vt;
+
+  // 明确支持 VT 的终端
+  if (process.env.WT_SESSION) return (_win_vt = true); // Windows Terminal
+  if (process.env.ConEmuANSI === 'ON') return (_win_vt = true); // ConEmu / Cmder
+  if (process.env.ANSICON) return (_win_vt = true); // ANSICON
+  if (process.env.TERM_PROGRAM === 'vscode') return (_win_vt = true); // VS Code 终端
+
+  // 系统版本：Windows 10 build 10586 (1511) 起原生支持 VT
+  try {
+    const parts = os.release().split('.').map(Number); // 如 "10.0.19045"
+    const major = parts[0] || 0;
+    const build = parts[2] || 0;
+    _win_vt = major >= 10 && build >= 10586;
+  } catch {
+    _win_vt = false;
+  }
+  return _win_vt;
+}
+
+// ---- 通用检测：对某个流是否应该上色 ----
+/**
+ * 判断指定流是否应启用颜色
+ * @param {Object} stream 输出流（默认 process.stdout）
+ * @returns {boolean} 是否启用颜色
+ */
+function supportsColor(stream) {
+  if (!stream) stream = process.stdout;
+
+  // NO_COLOR 标准：只要设置了该环境变量即禁用（即使值为空串）
+  if (process.env.NO_COLOR !== undefined) return false;
+
+  // FORCE_COLOR 优先级最高，方便 CI / 管道 / 测试场景
+  const fc = process.env.FORCE_COLOR;
+  if (fc !== undefined && fc !== '') {
+    return fc !== '0' && fc !== 'false';
+  }
+
+  // 非 TTY（重定向到文件、管道）——禁用，避免输出垃圾字符
+  if (!stream.isTTY) return false;
+
+  if (process.env.TERM === 'dumb') return false;
+
+  // 常见 CI 大多支持颜色
+  if (process.env.CI) {
+    return Boolean(
+      process.env.GITHUB_ACTIONS ||
+      process.env.GITLAB_CI ||
+      process.env.CIRCLECI ||
+      process.env.TRAVIS ||
+      process.env.BUILDKITE
+    );
+  }
+
+  // Windows 额外判断
+  if (process.platform === 'win32') return windowsSupportsVT();
+
+  // Linux / macOS / *nix：isTTY 为 true 就够了
+  return true;
+}
+
+/* =============================================================
+ * 3. 创建颜色工具
+ * =========================================================== */
+
+/**
+ * 创建颜色工具集
+ * @param {boolean} enabled 是否启用颜色
+ * @returns {Object} 颜色工具对象
+ */
+function createColors(enabled) {
+  const c = { enabled };
+
+  for (const [name, [open, close]] of Object.entries(STYLES)) {
+    c[name] = enabled
+      ? (s) => `\u001b[${open}m${s}\u001b[${close}m`
+      : (s) => String(s);
+  }
+
+  /**
+   * 生成 256 色前景着色器
+   * @param {number} code 颜色码
+   * @returns {Function} 着色函数
+   */
+  c.ansi256 = (code) =>
+    enabled
+      ? (s) => `\u001b[38;5;${code}m${s}\u001b[39m`
+      : (s) => String(s);
+
+  /**
+   * 生成真彩色前景着色器
+   * @param {number} r 红色分量
+   * @param {number} g 绿色分量
+   * @param {number} b 蓝色分量
+   * @returns {Function} 着色函数
+   */
+  c.rgb = (r, g, b) =>
+    enabled
+      ? (s) => `\u001b[38;2;${r};${g};${b}m${s}\u001b[39m`
+      : (s) => String(s);
+
+  /**
+   * 生成真彩色背景着色器
+   * @param {number} r 红色分量
+   * @param {number} g 绿色分量
+   * @param {number} b 蓝色分量
+   * @returns {Function} 着色函数
+   */
+  c.bgRgb = (r, g, b) =>
+    enabled
+      ? (s) => `\u001b[48;2;${r};${g};${b}m${s}\u001b[49m`
+      : (s) => String(s);
+
+  /**
+   * 生成组合样式着色器，如 c.style('bold red')('text')。
+   * 一次写入开启码、一次写入关闭码，避免嵌套重置导致串色。
+   * @param {string|Array<string>} names 样式名或样式名列表
+   * @returns {Function} 着色函数
+   */
+  c.style = (names) => {
+    if (!enabled) return (s) => String(s);
+    const list = Array.isArray(names) ? names : String(names).split(/\s+/);
+    const opens = [];
+    const closes = [];
+    for (const n of list) {
+      const s = STYLES[n];
+      if (s) {
+        opens.push(s[0]);
+        closes.unshift(s[1]); // 反序关闭
+      }
+    }
+    if (!opens.length) return (s) => String(s);
+    const open = `\u001b[${opens.join(';')}m`;
+    const close = `\u001b[${closes.join(';')}m`;
+    return (s) => `${open}${s}${close}`;
+  };
+
+  return c;
+}
+
+/* =============================================================
+ * 4. 导出
+ * =========================================================== */
+module.exports = {
+  STYLES,
+  supportsColor,
+  windowsSupportsVT,
+  createColors,
+
+  // 便捷出口：默认对 stdout 检测
+  colors: createColors(supportsColor(process.stdout)),
+  // 快速创建一个针对任意流的着色器
+  forStream: (stream) => createColors(supportsColor(stream)),
+};

package/lib/console_logger.js

@@ -0,0 +1,71 @@
+'use strict';
+
+// 轻量控制台日志器（自 mm_corejs/lib/logger.js 迁移）
+// 依赖本目录内的 colors 工具，与 mm_logger 现有完整版 Logger 互不冲突。
+
+const { colors: outColors, forStream } = require('./colors');
+
+/**
+ * 标准错误着色器。
+ * error / warn 输出到 stderr，需按 stderr 的 TTY 能力单独检测，
+ * 否则重定向 stderr 时会残留 ANSI 转义序列。
+ */
+const errColors = forStream(process.stderr);
+
+/**
+ * 轻量控制台日志器
+ * @class ConsoleLogger
+ */
+class ConsoleLogger {
+  /**
+   * 构造函数
+   */
+  constructor() {}
+
+  /**
+   * 信息日志
+   * @param {string} msg 日志消息
+   * @param {...*} args 日志参数列表
+   */
+  info(msg, ...args) {
+    console.info(outColors.blue(msg), ...args);
+  }
+
+  /**
+   * 调试日志
+   * @param {string} msg 日志消息
+   * @param {...*} args 日志参数列表
+   */
+  debug(msg, ...args) {
+    console.debug(outColors.white(msg), ...args);
+  }
+
+  /**
+   * 错误日志
+   * @param {string} msg 日志消息
+   * @param {...*} args 日志参数列表
+   */
+  error(msg, ...args) {
+    console.error(errColors.red(msg), ...args);
+  }
+
+  /**
+   * 成功日志
+   * @param {string} msg 日志消息
+   * @param {...*} args 日志参数列表
+   */
+  success(msg, ...args) {
+    console.log(outColors.green(msg), ...args);
+  }
+
+  /**
+   * 警告日志
+   * @param {string} msg 日志消息
+   * @param {...*} args 日志参数列表
+   */
+  warn(msg, ...args) {
+    console.warn(errColors.yellow(msg), ...args);
+  }
+}
+
+module.exports = ConsoleLogger;

package/lib/level.js

@@ -0,0 +1,15 @@
+/**
+ * 日志级别枚举
+ * @readonly
+ */
+const LEVEL = {
+	debug: 10,
+	info: 20,
+	success: 25,
+	warn: 30,
+	error: 40,
+	fatal: 50
+};
+
+// 导出模块
+module.exports = LEVEL;