logxpert 2.0.0 → 2.1.0

package/README.md

@@ -1,6 +1,11 @@
 # LogXpert
 
-LogXpert is a powerful logging library for Node.js that provides easy-to-use logging methods with colorful formatted output and optional file logging support.
+Colorful console logging for Node.js with optional daily file rotation.
+
+- Zero heavy dependencies — built-in engine.
+- Daily file rotation with retention, size limits and gzip.
+- Per-level colors, lazy messages, child loggers, isolated instances.
+- Works from JS and TS, CommonJS and ESM.
 
 ## Installation
 
@@ -8,90 +13,106 @@ LogXpert is a powerful logging library for Node.js that provides easy-to-use log
 npm install logxpert
 ```
 
-## Usage
+Requires Node.js `>=18`. Recommended minimum: Node.js 22 LTS. See [NODE_SUPPORT.md](NODE_SUPPORT.md) for the full support policy.
 
-CommonJS:
+## Quick start
 
 ```js
 const log = require('logxpert');
+// or: import log from 'logxpert';
+
+log('general message');          // shortcut for info
+log.info('hello', { user: 1 });  // with metadata
+log.error(new Error('boom'));    // Errors print message + stack
+log.debug(() => JSON.stringify(hugeObject)); // lazy: skipped if level disabled
+```
 
-log('general message');
-log.error('error message');
-log.warn('warn message');
-log.info('info with meta', { user: 1 });
-log.debug({ structured: 'object' });
-log.error(new Error('boom'));
+Levels: `error → warn → info → http → verbose → debug → silly` (default `debug`).
+
+```js
+log.setLevel('info'); // or via LOG_LEVEL env variable
 ```
 
-ESM:
+## File logging
 
 ```js
-import log from 'logxpert';
+log.settings({ files: { folder: 'logs' } });
+// → logs/logxpert-2026_10_08.log (prefix defaults to your package.json name)
+
+log.settings({ files: { folder: 'logs', prefix: 'api' } });
+// → logs/api-2026_10_08.log
 
-log.info('hello');
+// Full control (omit prefix when used):
+log.settings({ files: { folder: 'logs', filePattern: 'app-%datePattern%.log' } });
 ```
 
-Set level (`LOG_LEVEL` env also respected):
+`%datePattern%` is replaced by the date (`datePattern` defaults to `YYYY_MM_DD`). Combining `prefix` with `filePattern` throws — pick one.
 
 ```js
-log.setLevel('info');
-console.log(log.getLevel());
+log.settings({
+  files: {
+    folder: 'logs',
+    runNumber: true,    // off by default → app-2026_10_08-1.log, -2.log, ...
+    maxFile: '14d',     // retention
+    maxSize: '20m',     // rotate above this size
+    zippedArchive: true,
+  },
+});
+log.close(); // call on shutdown
 ```
 
-Isolated instances and child loggers:
+## Console & instances
 
 ```js
+log.settings({
+  console: {
+    enableTimestamp: true,
+    timestampFormat: 'YYYY-MM-DD HH:mm:ss',
+    colorize: true,
+    colors: { info: 'blue', error: false }, // names, ANSI 0-255, or false per level
+  },
+});
+
+// Default colors: error red, warn yellow, info green, http magenta,
+// verbose cyan, debug blue, silly gray. Only the [level] tag is colored.
+
 const { createLogger } = require('logxpert');
-const apiLog = createLogger({ level: 'info' });
-apiLog.info('isolated');
+const apiLog = createLogger({ level: 'info' }); // independent instance
 
-const child = log.child({ service: 'api' });
-child.info('child message');
+const child = log.child({ service: 'api' }); // bound context
 ```
 
-### File output & console timestamp
+## Full configuration (copy-paste)
 
 ```js
 log.settings({
-  level: 'debug',
+  level: 'debug', // or process.env.LOG_LEVEL
   console: {
     enableTimestamp: true,
     timestampFormat: 'YYYY-MM-DD HH:mm:ss',
     timestampPrefix: '',
     timestampSuffix: '',
-    colorize: true
+    colorize: true,
+    colors: { info: 'blue', warn: 208, error: false }
+    // enabled: false, // file-only logging: silence the console
   },
   files: {
     folder: 'logs',
-    filename: 'application-%DATE%.log',
-    filesName: 'YYYY-MM-DD',
+    prefix: undefined, // defaults to your package.json name
+    // filePattern: 'app-%datePattern%.log', // full control (omit prefix if used)
+    datePattern: 'YYYY_MM_DD',
+    runNumber: false, // or true, or { separator: '-', padding: 0, startAt: 1 }
     maxFile: '14d',
     maxSize: '20m',
-    zippedArchive: false
+    zippedArchive: false,
   }
 });
 ```
 
-Close file transports on shutdown:
-
-```js
-log.close();
-```
-
-## API Reference
-
-- **log(message, ...meta):** info level.
-- **log.error/warn/info/debug/http/verbose/silly(message, ...meta)**
-- **log.log(level, message, ...meta)**
-- **log.settings({ console, files, level })**
-- **log.setLevel(level) / log.getLevel()**
-- **log.createLogger(options):** independent instance.
-- **log.child(meta):** child logger with bound context.
-- **log.close():** remove file transport.
+Legacy aliases: `appName` (= `prefix`), `filename`/`pattern` (= `filePattern`), `filesName`/`dateFormat` (= `datePattern`).
 
-Console options: `enableTimestamp`, `timestampFormat`, `timestampPrefix`, `timestampSuffix`, `colorize`, `level`.
-Files options: `folder`, `filename`, `filesName`/`datePattern`, `maxFile`/`maxFiles`, `maxSize`, `zippedArchive`, `level`.
+Security: messages are stripped of ANSI escapes and control characters (except `\n`, `\t`); file patterns escaping the log folder (`..`, absolute paths) are rejected.
 
 ## License
 
-GPL-3.0-only. See [LICENSE](LICENSE).
+Apache-2.0. See [LICENSE](LICENSE).

package/index.d.mts

@@ -0,0 +1,23 @@
+import log from './index.js';
+
+export default log;
+
+export const settings: typeof log.settings;
+export const setLevel: typeof log.setLevel;
+export const getLevel: typeof log.getLevel;
+export const child: typeof log.child;
+export const close: typeof log.close;
+export const createLogger: typeof log.createLogger;
+export const error: typeof log.error;
+export const warn: typeof log.warn;
+export const info: typeof log.info;
+export const debug: typeof log.debug;
+
+export type LogLevel = log.LogLevel;
+export type LevelColor = log.LevelColor;
+export type ConsoleOptions = log.ConsoleOptions;
+export type FilesOptions = log.FilesOptions;
+export type RunNumberOptions = log.RunNumberOptions;
+export type LogSettingsOptions = log.LogSettingsOptions;
+export type ChildLogger = log.ChildLogger;
+export type LogXpert = log.LogXpert;

package/index.d.ts

@@ -1,57 +1,83 @@
-export type LogLevel = 'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly';
-
-export interface ConsoleOptions {
-  enableTimestamp?: boolean;
-  timestampFormat?: string;
-  timestampPrefix?: string;
-  timestampSuffix?: string;
-  colorize?: boolean;
-  level?: LogLevel;
-}
+declare namespace log {
+  export type LogLevel = 'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly';
 
-export interface FilesOptions {
-  folder?: string;
-  filesName?: string;
-  datePattern?: string;
-  filename?: string;
-  maxFile?: string;
-  maxFiles?: string;
-  maxSize?: string;
-  zippedArchive?: boolean;
-  level?: LogLevel;
-}
+  export type LevelColor = string | number | false | null;
 
-export interface LogSettingsOptions {
-  console?: ConsoleOptions;
-  files?: FilesOptions;
-  level?: LogLevel;
-}
+  export interface ConsoleOptions {
+    enabled?: boolean;
+    enableTimestamp?: boolean;
+    timestampFormat?: string;
+    timestampPrefix?: string;
+    timestampSuffix?: string;
+    colorize?: boolean;
+    colors?: Partial<Record<LogLevel, LevelColor>>;
+    level?: LogLevel;
+  }
 
-export interface ChildLogger {
-  error(message: unknown, ...meta: unknown[]): void;
-  warn(message: unknown, ...meta: unknown[]): void;
-  info(message: unknown, ...meta: unknown[]): void;
-  debug(message: unknown, ...meta: unknown[]): void;
-  log(level: LogLevel, message: unknown, ...meta: unknown[]): void;
-}
+  export interface RunNumberOptions {
+    enabled?: boolean;
+    separator?: string;
+    padding?: number;
+    startAt?: number;
+  }
 
-export interface LogXpert {
-  (message: unknown, ...meta: unknown[]): void;
-  error(message: unknown, ...meta: unknown[]): void;
-  warn(message: unknown, ...meta: unknown[]): void;
-  info(message: unknown, ...meta: unknown[]): void;
-  debug(message: unknown, ...meta: unknown[]): void;
-  http(message: unknown, ...meta: unknown[]): void;
-  verbose(message: unknown, ...meta: unknown[]): void;
-  silly(message: unknown, ...meta: unknown[]): void;
-  log(level: LogLevel, message: unknown, ...meta: unknown[]): void;
-  settings(options?: LogSettingsOptions): void;
-  setLevel(level: LogLevel): void;
-  getLevel(): string;
-  child(meta?: Record<string, unknown>): ChildLogger;
-  close(): void;
-  createLogger(options?: LogSettingsOptions): LogXpert;
+  export interface FilesOptions {
+    folder?: string;
+    /** Preferred: date format for %DATE%. */
+    datePattern?: string;
+    /** @deprecated Use datePattern. */
+    filesName?: string;
+    dateFormat?: string;
+    /** Preferred: filename template containing %DATE%. */
+    filePattern?: string;
+    pattern?: string;
+    /** @deprecated Use filePattern. */
+    filename?: string;
+    /** Preferred: filename prefix used when no pattern is given. */
+    prefix?: string;
+    /** @deprecated Use prefix. */
+    appName?: string;
+    runNumber?: boolean | RunNumberOptions;
+    maxFile?: string;
+    maxFiles?: string;
+    maxSize?: string;
+    zippedArchive?: boolean;
+    level?: LogLevel;
+  }
+
+  export interface LogSettingsOptions {
+    console?: ConsoleOptions | false;
+    files?: FilesOptions;
+    level?: LogLevel;
+  }
+
+  export interface ChildLogger {
+    error(message: unknown, ...meta: unknown[]): void;
+    warn(message: unknown, ...meta: unknown[]): void;
+    info(message: unknown, ...meta: unknown[]): void;
+    debug(message: unknown, ...meta: unknown[]): void;
+    log(level: LogLevel, message: unknown, ...meta: unknown[]): void;
+  }
+
+  export interface LogXpert {
+    (message: unknown, ...meta: unknown[]): void;
+    error(message: unknown, ...meta: unknown[]): void;
+    warn(message: unknown, ...meta: unknown[]): void;
+    info(message: unknown, ...meta: unknown[]): void;
+    debug(message: unknown, ...meta: unknown[]): void;
+    http(message: unknown, ...meta: unknown[]): void;
+    verbose(message: unknown, ...meta: unknown[]): void;
+    silly(message: unknown, ...meta: unknown[]): void;
+    log(level: LogLevel, message: unknown, ...meta: unknown[]): void;
+    settings(options?: LogSettingsOptions): void;
+    setLevel(level: LogLevel): void;
+    getLevel(): string;
+    child(meta?: Record<string, unknown>): ChildLogger;
+    close(): void;
+    createLogger(options?: LogSettingsOptions): LogXpert;
+  }
 }
 
-declare const log: LogXpert;
-export default log;
+declare const log: log.LogXpert;
+
+export = log;

package/lib/files.js

@@ -0,0 +1,102 @@
+const fs = require('fs');
+const path = require('path');
+const { sanitizeAppName, isPadChar, assertFilenameSafe } = require('./sanitize');
+
+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,
+  };
+}
+
+module.exports = { getDefaultAppName, resolveRunNumber, normalizeFilesOptions };

package/lib/format.js

@@ -0,0 +1,38 @@
+const util = require('util');
+
+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 '';
+  }
+}
+
+function mergeMeta(meta) {
+  const out = {};
+  for (const m of meta) {
+    if (m && typeof m === 'object') Object.assign(out, m);
+  }
+  return out;
+}
+
+function renderBody(message, meta) {
+  if (typeof message === 'string' && meta.length && /%[sdifoO%]/.test(message)) {
+    return util.format(message, ...meta);
+  }
+  const msg = typeof message === 'string' ? message : message == null ? '' : JSON.stringify(message);
+  const extra = formatExtra(mergeMeta(meta));
+  return [msg, extra].filter(Boolean).join(' ');
+}
+
+function buildLine(timestamp, level, message, meta, tag) {
+  const body = renderBody(message, meta);
+  const label = tag ?? `[${level}]`;
+  return timestamp ? `${timestamp} ${label}: ${body}` : `${label}: ${body}`;
+}
+
+module.exports = { formatExtra, mergeMeta, renderBody, buildLine };

package/lib/mini.js

@@ -0,0 +1,134 @@
+const LEVELS = {
+  error: 0,
+  warn: 1,
+  info: 2,
+  http: 3,
+  verbose: 4,
+  debug: 5,
+  silly: 6,
+};
+
+const COLORS = {
+  error: 31,
+  warn: 33,
+  info: 32,
+  http: 35,
+  verbose: 36,
+  debug: 34,
+  silly: 90,
+};
+
+const NAMED_COLORS = {
+  black: 30,
+  red: 31,
+  green: 32,
+  yellow: 33,
+  blue: 34,
+  magenta: 35,
+  cyan: 36,
+  white: 37,
+  gray: 90,
+  grey: 90,
+};
+
+function resolveColorCode(value, level) {
+  if (value === undefined || value === null || value === false) return null;
+  if (typeof value === 'number' && Number.isInteger(value) && value >= 0 && value <= 255) return value;
+  if (typeof value === 'string' && NAMED_COLORS[value.toLowerCase()] !== undefined) return NAMED_COLORS[value.toLowerCase()];
+  throw new Error(`Unknown color "${value}" for level "${level}". Use one of: ${Object.keys(NAMED_COLORS).join(', ')}, an ANSI code 0-255, or false to disable`);
+}
+
+function resolveLevelColors(custom = {}) {
+  if (custom === null || typeof custom !== 'object' || Array.isArray(custom)) {
+    throw new Error('console.colors must be an object mapping level names to colors');
+  }
+  const map = {};
+  for (const level of Object.keys(COLORS)) {
+    if (custom[level] !== undefined) {
+      const code = resolveColorCode(custom[level], level);
+      if (code !== null) map[level] = code;
+    } else {
+      map[level] = COLORS[level];
+    }
+  }
+  return map;
+}
+
+function colorizeLevel(level, text, colors = COLORS) {
+  const code = colors[level] ?? 0;
+  if (!code) return text;
+  return `\x1b[${code}m${text}\x1b[0m`;
+}
+
+class NullTransport {
+  constructor() {
+    this.level = 'off';
+  }
+
+  write() {}
+
+  close() {}
+}
+
+class ConsoleTransport {
+  constructor({ level, render } = {}) {
+    this.level = level;
+    this.render = render;
+  }
+
+  write(entry) {
+    const line = this.render(entry);
+    const stream = entry.level === 'error' || entry.level === 'warn' ? process.stderr : process.stdout;
+    stream.write(line + '\n');
+  }
+
+  close() {}
+}
+
+class MiniLogger {
+  constructor({ level = 'debug' } = {}) {
+    this.level = level;
+    this.levels = LEVELS;
+    this.transports = [];
+  }
+
+  add(transport) {
+    this.transports.push(transport);
+    return this;
+  }
+
+  remove(transport) {
+    const i = this.transports.indexOf(transport);
+    if (i >= 0) this.transports.splice(i, 1);
+    try {
+      transport.close?.();
+    } catch {}
+    return this;
+  }
+
+  enabled(level, transportLevel) {
+    const want = LEVELS[level];
+    const current = LEVELS[transportLevel ?? this.level];
+    return want !== undefined && current !== undefined && want <= current;
+  }
+
+  log(level, message, ...meta) {
+    for (const t of [...this.transports]) {
+      if (this.enabled(level, t.level)) t.write({ level, message, meta });
+    }
+  }
+
+  child(meta = {}) {
+    const self = this;
+    const make = (level) => (message, ...args) => self.log(level, message, meta, ...args);
+    return {
+      error: make('error'),
+      warn: make('warn'),
+      info: make('info'),
+      debug: make('debug'),
+      log: (level, message, ...args) => self.log(level, message, meta, ...args),
+    };
+  }
+}
+
+module.exports = { LEVELS, ConsoleTransport, NullTransport, MiniLogger, colorizeLevel, resolveLevelColors, NAMED_COLORS };