logxpert 2.0.3 → 2.1.2

package/main.js

@@ -1,277 +1,40 @@
 const fs = require('fs');
 const path = require('path');
-const dayjs = require('dayjs');
-const { createLogger, format, transports } = require('winston');
-require('winston-daily-rotate-file');
-
-const VALID_LEVELS = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
-const DEFAULT_CONSOLE_FORMAT = 'YYYY-MM-DD HH:mm:ss';
-
-function pad2(n) {
-  return String(n).padStart(2, '0');
-}
-
-function formatDefaultTimestamp(d = new Date()) {
-  return `${d.getFullYear()}-${pad2(d.getMonth() + 1)}-${pad2(d.getDate())} ${pad2(d.getHours())}:${pad2(d.getMinutes())}:${pad2(d.getSeconds())}`;
-}
-
-function splitBrackets(fmt) {
-  const parts = [];
-  let current = '';
-  let i = 0;
-  while (i < fmt.length) {
-    if (fmt[i] === '[') {
-      const close = fmt.indexOf(']', i + 1);
-      if (close === -1) {
-        current += fmt.slice(i);
-        break;
-      }
-      if (current) {
-        parts.push(current);
-        current = '';
-      }
-      parts.push(fmt.slice(i, close + 1));
-      i = close + 1;
-    } else {
-      current += fmt[i];
-      i++;
-    }
-  }
-  if (current) parts.push(current);
-  return parts;
-}
-
-function compileTimestampFormatter(fmt) {
-  if (typeof fmt !== 'string' || !fmt) return formatDefaultTimestamp;
-  if (fmt === DEFAULT_CONSOLE_FORMAT) return formatDefaultTimestamp;
-  if (!fmt.includes('[') || !fmt.includes(']')) return () => dayjs().format(fmt);
-  const parts = splitBrackets(fmt).map((part) => {
-    if (part.startsWith('[') && part.endsWith(']')) {
-      const inner = part.slice(1, -1);
-      return inner ? () => '[' + dayjs().format(inner) + ']' : () => '[]';
-    }
-    return () => part;
-  });
-  return () => parts.map((f) => f()).join('');
-}
-
-function formatCustomTimestamp(fmt) {
-  return compileTimestampFormatter(fmt)();
-}
-
-function formatExtra(meta) {
-  const keys = Object.keys(meta).filter((k) => k !== 'splat' && k !== 'ms');
-  if (!keys.length) return '';
-  try {
-    const picked = {};
-    for (const k of keys) picked[k] = meta[k];
-    return JSON.stringify(picked);
-  } catch {
-    return '';
-  }
-}
-
-const prettyFormat = format.printf(({ timestamp, level, message, ...meta }) => {
-  const msg = typeof message === 'string' ? message : message == null ? '' : JSON.stringify(message);
-  const extra = formatExtra(meta);
-  const body = [msg, extra].filter(Boolean).join(' ');
-  return timestamp ? `${timestamp} [${level}]: ${body}` : `[${level}]: ${body}`;
-});
-
-function assertLevel(level) {
-  if (!VALID_LEVELS.includes(level)) throw new Error(`Invalid log level "${level}". Use one of: ${VALID_LEVELS.join(', ')}`);
-}
-
-function stripAnsi(str) {
-  let out = '';
-  let i = 0;
-  while (i < str.length) {
-    if (str[i] !== '\x1b') {
-      out += str[i];
-      i++;
-      continue;
-    }
-    const next = str[i + 1];
-    if (next === ']') {
-      let j = i + 2;
-      while (j < str.length) {
-        if (str[j] === '\x07') { j++; break; }
-        if (str[j] === '\x1b' && str[j + 1] === '\\') { j += 2; break; }
-        j++;
-      }
-      i = j;
-    } else if (next === '[') {
-      let j = i + 2;
-      while (j < str.length && str[j] >= ' ' && str[j] <= '?') j++;
-      if (j < str.length) j++;
-      i = j;
-    } else if (next === '(' || next === ')') {
-      i += 3;
-    } else {
-      i += next === undefined ? 1 : 2;
-    }
-  }
-  return out;
-}
-const CONTROL_RE = /[\x00-\x08\x0b\x0c\x0d\x0e-\x1f\x7f]/g;
-
-function sanitizeMessage(msg) {
-  if (typeof msg !== 'string') return msg;
-  return stripAnsi(msg).replace(CONTROL_RE, '');
-}
-
-function assertFilenameSafe(filename) {
-  if (typeof filename !== 'string' || !filename.trim() || filename.includes('\0')) {
-    throw new Error('files.filename must be a non-empty string');
-  }
-  if (path.isAbsolute(filename) || filename.split(/[\\/]/).includes('..')) {
-    throw new Error('files.filename must not escape the log folder (.. and absolute paths are rejected)');
-  }
-}
-
-function isSafeChar(c) {
-  return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c === '.' || c === '_' || c === '-';
-}
-
-function isPadChar(c) {
-  return c === '-' || c === '_' || c === '.';
-}
-
-function sanitizeAppName(name) {
-  if (typeof name !== 'string' || !name.trim()) return null;
-  const base = name.trim().slice(0, 200).split('/').pop();
-  let out = '';
-  for (let i = 0; i < base.length; i++) {
-    out += isSafeChar(base[i]) ? base[i] : '-';
-  }
-  let start = 0;
-  while (start < out.length && isPadChar(out[start])) start++;
-  let end = out.length;
-  while (end > start && isPadChar(out[end - 1])) end--;
-  const safe = out.slice(start, end);
-  return safe || null;
-}
-
-let cachedAppName = null;
-function getDefaultAppName() {
-  if (cachedAppName) return cachedAppName;
-  try {
-    const pkgPath = path.resolve(process.cwd(), 'package.json');
-    const raw = fs.readFileSync(pkgPath, 'utf8');
-    cachedAppName = sanitizeAppName(JSON.parse(raw)?.name) ?? 'application';
-  } catch {
-    cachedAppName = 'application';
-  }
-  return cachedAppName;
-}
-
-function resolveRunNumber(folder, prefix, opt) {
-  let enabled = false;
-  let separator = '-';
-  let padding = 0;
-  let startAt = 1;
-  if (opt === true) {
-    enabled = true;
-  } else if (opt && typeof opt === 'object') {
-    enabled = opt.enabled ?? true;
-    if (opt.separator !== undefined) {
-      if (typeof opt.separator !== 'string' || !opt.separator) throw new Error('files.runNumber.separator must be a non-empty string');
-      separator = opt.separator;
-    }
-    if (opt.padding !== undefined) {
-      if (!Number.isInteger(opt.padding) || opt.padding < 0) throw new Error('files.runNumber.padding must be a non-negative integer');
-      padding = opt.padding;
-    }
-    if (opt.startAt !== undefined) {
-      if (!Number.isInteger(opt.startAt) || opt.startAt < 0) throw new Error('files.runNumber.startAt must be a non-negative integer');
-      startAt = opt.startAt;
-    }
-  } else if (opt !== undefined && opt !== false) {
-    throw new Error('files.runNumber must be a boolean or an object');
-  }
-  if (!enabled) return null;
-  const counterFile = path.join(folder, `.${prefix}.run`);
-  let next = startAt;
-  try {
-    const raw = fs.readFileSync(counterFile, 'utf8').trim();
-    const prev = parseInt(raw, 10);
-    next = Number.isInteger(prev) ? prev + 1 : startAt;
-  } catch {}
-  try {
-    fs.writeFileSync(counterFile, String(next), 'utf8');
-  } catch {}
-  return separator + String(next).padStart(padding, '0');
-}
-
-function normalizeFilesOptions(files = {}) {
-  const rawFolder = files.folder ?? 'logs';
-  if (typeof rawFolder !== 'string' || !rawFolder.trim() || rawFolder.includes('\0')) {
-    throw new Error('files.folder must be a non-empty string');
-  }
-  const folder = path.normalize(rawFolder);
-  const datePattern = files.datePattern ?? files.dateFormat ?? files.filesName ?? 'YYYY_MM_DD';
-  if (typeof datePattern !== 'string' || !datePattern.trim()) {
-    throw new Error('files.datePattern must be a non-empty string');
-  }
-  const explicitPattern = files.filePattern ?? files.pattern ?? files.filename;
-  const explicitPrefix = files.prefix ?? files.appName;
-  if (explicitPattern !== undefined && explicitPrefix !== undefined) {
-    throw new Error('Do not combine "prefix" with "filePattern", pick one: prefix builds "<prefix>-%DATE%.log" for you, filePattern takes full control');
-  }
-  let filename = explicitPattern ?? `${sanitizeAppName(explicitPrefix) ?? getDefaultAppName()}-%DATE%.log`;
-  filename = filename.split('%datePattern%').join('%DATE%');
-  assertFilenameSafe(filename);
-  if (!filename.includes('%DATE%')) {
-    const ext = path.extname(filename) || '.log';
-    const base = path.basename(filename, ext);
-    filename = `${base}-%DATE%${ext}`;
-  }
-  assertFilenameSafe(filename);
-  if (!fs.existsSync(folder)) fs.mkdirSync(folder, { recursive: true });
-  const rawPrefix = path.basename(filename).split('%DATE%')[0];
-  let prefixEnd = rawPrefix.length;
-  while (prefixEnd > 0 && isPadChar(rawPrefix[prefixEnd - 1])) prefixEnd--;
-  const prefix = rawPrefix.slice(0, prefixEnd) || 'application';
-  const runSuffix = resolveRunNumber(folder, sanitizeAppName(prefix) ?? 'application', files.runNumber ?? false);
-  if (runSuffix) {
-    const ext = path.extname(filename) || '.log';
-    const base = filename.slice(0, -ext.length);
-    filename = `${base}${runSuffix}${ext}`;
-  }
-  return {
-    folder,
-    datePattern,
-    filename,
-    maxFiles: files.maxFile ?? files.maxFiles ?? '14d',
-    maxSize: files.maxSize ?? '20m',
-    zippedArchive: files.zippedArchive ?? false,
-    level: files.level,
+const { MiniLogger, ConsoleTransport, NullTransport, colorizeLevel, resolveLevelColors } = require('./lib/mini');
+const { FileTransport } = require('./lib/rotate');
+const { DEFAULT_CONSOLE_FORMAT, compileTimestampFormatter } = require('./lib/time');
+const { buildLine } = require('./lib/format');
+const { assertLevel, sanitizeMessage } = require('./lib/sanitize');
+const { normalizeFilesOptions } = require('./lib/files');
+
+function normalizeConsoleOpts(input) {
+  if (input === false) return { enabled: false };
+  return input || {};
+}
+
+function buildConsoleTransport({ enabled = true, enableTimestamp = true, timestampFormat = DEFAULT_CONSOLE_FORMAT, timestampPrefix = '', timestampSuffix = '', colorize = true, colors, level } = {}) {
+  if (!enabled) return new NullTransport();
+  const stamp = enableTimestamp ? compileTimestampFormatter(timestampFormat) : null;
+  const palette = resolveLevelColors(colors);
+  const render = ({ level, message, meta }) => {
+    const timestamp = stamp ? `${timestampPrefix}${stamp()}${timestampSuffix}` : '';
+    const tag = colorize ? colorizeLevel(level, `[${level}]`, palette) : `[${level}]`;
+    return buildLine(timestamp, level, message, meta, tag);
   };
-}
-
-function buildConsoleTransport({ enableTimestamp = true, timestampFormat = DEFAULT_CONSOLE_FORMAT, timestampPrefix = '', timestampSuffix = '', colorize = true, level } = {}) {
-  const parts = [];
-  if (colorize) parts.push(format.colorize());
-  if (enableTimestamp) {
-    const stamp = compileTimestampFormatter(timestampFormat);
-    parts.push(format.timestamp({ format: () => `${timestampPrefix}${stamp()}${timestampSuffix}` }));
-  } else {
-    parts.push(format((info) => { delete info.timestamp; return info; })());
-  }
-  parts.push(format.errors({ stack: true }), format.splat(), prettyFormat);
-  return new transports.Console({ format: format.combine(...parts), level });
+  return new ConsoleTransport({ level, render });
 }
 
 function buildFileTransport({ folder, datePattern, filename, maxFiles, maxSize, zippedArchive, level }) {
   if (!fs.existsSync(folder)) fs.mkdirSync(folder, { recursive: true });
-  return new transports.DailyRotateFile({
-    filename: path.join(folder, filename),
+  return new FileTransport({
+    folder: path.normalize(folder),
+    filename,
     datePattern,
     zippedArchive,
     maxSize,
     maxFiles,
     level,
-    format: format.combine(format.errors({ stack: true }), format.splat(), format.timestamp(), prettyFormat),
+    render: ({ level, message, meta }) => buildLine(new Date().toISOString(), level, message, meta),
   });
 }
 
@@ -279,27 +42,30 @@ function createLoggerInstance(initial = {}) {
   const globalLevel = process.env.LOG_LEVEL || initial.level || 'debug';
   assertLevel(globalLevel);
 
-  const logger = createLogger({
-    level: globalLevel,
-    format: format.combine(format.errors({ stack: true }), format.splat()),
-  });
+  const logger = new MiniLogger({ level: globalLevel });
 
-  let consoleTransport = buildConsoleTransport(initial.console);
-  consoleTransport.level = initial.console?.level;
+  let consoleTransport = buildConsoleTransport(normalizeConsoleOpts(initial.console));
+  consoleTransport.level = normalizeConsoleOpts(initial.console).level;
   logger.add(consoleTransport);
 
   let fileTransport = null;
-  let consoleOpts = { ...(initial.console || {}) };
+  let consoleOpts = { ...normalizeConsoleOpts(initial.console) };
   let filesOpts = null;
+  let sanitizeEnabled = initial.sanitize ?? true;
 
   function applySettings(options = {}) {
     if (options.level !== undefined) {
       assertLevel(options.level);
       logger.level = options.level;
     }
-    if (options.console) {
-      if (options.console.level !== undefined && options.console.level !== null) assertLevel(options.console.level);
-      consoleOpts = { ...consoleOpts, ...options.console };
+    if (options.sanitize !== undefined) {
+      if (typeof options.sanitize !== 'boolean') throw new Error('log.settings sanitize must be a boolean');
+      sanitizeEnabled = options.sanitize;
+    }
+    if (options.console !== undefined) {
+      const next = normalizeConsoleOpts(options.console);
+      if (next.level !== undefined && next.level !== null) assertLevel(next.level);
+      consoleOpts = { ...consoleOpts, ...next };
       logger.remove(consoleTransport);
       consoleTransport = buildConsoleTransport(consoleOpts);
       consoleTransport.level = consoleOpts.level;
@@ -327,10 +93,11 @@ function createLoggerInstance(initial = {}) {
       message = message();
     }
     if (message instanceof Error) {
-      logger.log(level, sanitizeMessage(message.message), { stack: message.stack, ...meta[0] });
+      const text = sanitizeEnabled ? sanitizeMessage(message.message) : message.message;
+      logger.log(level, text, { stack: message.stack, ...meta[0] });
       return;
     }
-    logger.log(level, sanitizeMessage(message), ...meta);
+    logger.log(level, sanitizeEnabled ? sanitizeMessage(message) : message, ...meta);
   }
 
   function callable(message, ...meta) {
@@ -366,7 +133,9 @@ function createLoggerInstance(initial = {}) {
   callable._winston = logger;
 
   if (initial.files) applySettings({ files: initial.files });
-  if (initial.console || initial.level) applySettings({ console: initial.console, level: initial.level });
+  if (initial.console || initial.level || initial.sanitize !== undefined) {
+    applySettings({ console: initial.console, level: initial.level, sanitize: initial.sanitize });
+  }
 
   return callable;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logxpert",
-  "version": "2.0.3",
+  "version": "2.1.2",
   "description": "A powerful logging library for Node.js with colorful output and daily file rotation",
   "main": "main.js",
   "types": "index.d.ts",
@@ -22,6 +22,7 @@
     "main.mjs",
     "index.d.ts",
     "index.d.mts",
+    "lib/",
     "README.md",
     "LICENSE",
     "CHANGELOG.md"
@@ -47,14 +48,13 @@
     "node": ">=18"
   },
   "scripts": {
-    "test": "node --test test/logger.test.js",
-    "check:types": "tsc -p test-d --noEmit",
+    "test": "node --test --test-reporter=./test/reporter.js test/logger.test.js test/console.test.js test/files.test.js test/lib.test.js",
+    "test:demo": "node --test --test-reporter=./test/reporter.js demo/reporter.demo.test.js",
+    "check:types": "tsc -p test-d --noEmit && echo TYPES-OK",
     "attw": "attw --pack"
   },
   "dependencies": {
-    "dayjs": "^1.11.23",
-    "winston": "^3.19.0",
-    "winston-daily-rotate-file": "^5.0.0"
+    "dayjs": "^1.11.23"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",