@feizk/logger 1.5.0 → 1.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feizk/logger",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A simple logger package with colored outputs and timestamps",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,6 +14,10 @@
     "@types/node": "^20.0.0",
     "vitest": "^1.6.1"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "keywords": [
     "logger",
     "console",

package/CHANGELOG.md

@@ -1,45 +0,0 @@
-# @feizk/logger
-
-## 1.5.0
-
-### Minor Changes
-
-- f3f8525: - Renamed `timestampFormat` to `formatTimestamp` and changed it to always be a function returning `[TimestampType, string]`
-  - Renamed `logFormat` to `formatLog`
-  - Renamed `logLevel` to `level`
-  - Renamed `setLogLevel` method to `setLevel`
-  - Added `TimestampTypes` interface and `TimestampType` union type for type safety
-  - Exported `TIMESTAMP_TYPES` constant and new types from the package index
-  - Updated `LoggerOptions` interface with new option names and types
-  - Modified `formatTimestamp` utility function to accept and call the user-provided function
-  - Updated all test cases to use the new option formats
-  - Updated README.md documentation, examples, and API reference
-
-## 1.4.0
-
-### Minor Changes
-
-- 2b7b1eb: - Added `LogLevel` type ('debug' | 'info' | 'warn' | 'error') and `logLevel` option to `LoggerOptions` in `types.ts`
-  - Updated `logger.ts` to implement log level filtering with a `LOG_LEVEL_PRIORITIES` constant, `shouldLog` private method, and checks before each log call
-  - Added `setLogLevel` method to `logger.ts` for dynamic runtime level changes
-  - Exported `LogLevel` type from `index.ts` for external use
-  - Added comprehensive test cases in `logger.test.ts` for filtering behavior at different levels, dynamic level changes, and default behavior
-  - Updated `README.md` with `logLevel` option documentation, usage examples, and API details for the new method
-
-## 1.3.0
-
-### Minor Changes
-
-- 6e3d7e5: - Created `src/types.ts` with `LoggerOptions` interface for `enableColors`, `timestampFormat`, and `logFormat` options\n- Created `src/utils.ts` with utility functions: `formatTimestamp`, `getColor`, and `formatLog`\n- Moved `Logger` class to `src/logger.ts` and made it configurable via constructor options with defaults\n- Updated `src/index.ts` to export `Logger` class and `LoggerOptions` type instead of containing the class\n- Removed the `success` method from `Logger` class (per user feedback)\n- Removed `[SUCCESS]` color mapping from `utils.ts`\n- Added tests in `tests/logger.test.ts` for disabling colors, locale timestamp, custom timestamp function, and custom log format\n- Removed success-related test from `tests/logger.test.ts`\n- Updated `README.md` with usage examples for new options and removed success method documentation\n- Ensured backward compatibility: existing `new Logger()` usage remains unchanged\n- All tests pass (10 tests) and build succeeds
-
-## 1.2.0
-
-### Minor Changes
-
-- 4b70f01: Accept multiple arguments and Any type of arguments on all Logger methods
-
-## 1.1.0
-
-### Minor Changes
-
-- ebc4e0b: Add success logging method to Logger class

package/src/index.ts

@@ -1,8 +0,0 @@
-export { Logger } from './logger';
-export { TIMESTAMP_TYPES } from './utils';
-export type {
-  LoggerOptions,
-  LogLevel,
-  TimestampTypes,
-  TimestampType,
-} from './types';

package/src/logger.ts

@@ -1,102 +0,0 @@
-import type { LoggerOptions, LogLevel, TimestampTypes } from './types';
-import { formatTimestamp, formatLog, TIMESTAMP_TYPES } from './utils';
-
-import type { TimestampType } from './types';
-
-const defaultFormatTimestamp = (
-  types: TimestampTypes,
-  date: Date = new Date(),
-): [TimestampType, string] => [types.ISO, date.toISOString()];
-
-const LOG_LEVEL_PRIORITIES: Record<LogLevel, number> = {
-  debug: 0,
-  info: 1,
-  warn: 2,
-  error: 3,
-};
-
-/**
- * A simple logger with colored outputs and timestamps.
- */
-export class Logger {
-  private options: LoggerOptions;
-  private level: LogLevel;
-
-  constructor(options: LoggerOptions = {}) {
-    this.options = {
-      enableColors: options.enableColors ?? true,
-      formatTimestamp: options.formatTimestamp ?? defaultFormatTimestamp,
-      formatLog: options.formatLog,
-    };
-    this.level = options.level ?? 'debug';
-  }
-
-  /**
-   * Sets the minimum log level for filtering messages.
-   * @param level - The log level to set.
-   */
-  setLevel(level: LogLevel): void {
-    this.level = level;
-  }
-
-  /**
-   * Checks if a log level should be output based on the current log level.
-   * @param level - The log level to check.
-   * @returns True if the message should be logged.
-   */
-  private shouldLog(level: LogLevel): boolean {
-    return LOG_LEVEL_PRIORITIES[level] >= LOG_LEVEL_PRIORITIES[this.level];
-  }
-
-  /**
-   * Logs an info message.
-   * @param args - The arguments to log.
-   */
-  info(...args: unknown[]): void {
-    if (!this.shouldLog('info')) return;
-    const timestamp = formatTimestamp(
-      this.options.formatTimestamp!,
-      TIMESTAMP_TYPES,
-    );
-    console.log(...formatLog('[INFO]', timestamp, args, this.options));
-  }
-
-  /**
-   * Logs a warning message.
-   * @param args - The arguments to log.
-   */
-  warn(...args: unknown[]): void {
-    if (!this.shouldLog('warn')) return;
-    const timestamp = formatTimestamp(
-      this.options.formatTimestamp!,
-      TIMESTAMP_TYPES,
-    );
-    console.log(...formatLog('[WARN]', timestamp, args, this.options));
-  }
-
-  /**
-   * Logs an error message.
-   * @param args - The arguments to log.
-   */
-  error(...args: unknown[]): void {
-    if (!this.shouldLog('error')) return;
-    const timestamp = formatTimestamp(
-      this.options.formatTimestamp!,
-      TIMESTAMP_TYPES,
-    );
-    console.log(...formatLog('[ERROR]', timestamp, args, this.options));
-  }
-
-  /**
-   * Logs a debug message.
-   * @param args - The arguments to log.
-   */
-  debug(...args: unknown[]): void {
-    if (!this.shouldLog('debug')) return;
-    const timestamp = formatTimestamp(
-      this.options.formatTimestamp!,
-      TIMESTAMP_TYPES,
-    );
-    console.log(...formatLog('[DEBUG]', timestamp, args, this.options));
-  }
-}

package/src/types.ts

@@ -1,19 +0,0 @@
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-
-export type TimestampType = 'iso' | 'locale' | 'custom';
-
-export interface TimestampTypes {
-  ISO: 'iso';
-  Locale: 'locale';
-  Custom: 'custom';
-}
-
-export interface LoggerOptions {
-  enableColors?: boolean;
-  formatTimestamp?: (
-    types: TimestampTypes,
-    date?: Date,
-  ) => [TimestampType, string];
-  formatLog?: (level: string, timestamp: string, args: unknown[]) => string;
-  level?: LogLevel;
-}

package/src/utils.ts

@@ -1,42 +0,0 @@
-import chalk from 'chalk';
-import type { LoggerOptions, TimestampTypes } from './types';
-
-export const TIMESTAMP_TYPES: TimestampTypes = {
-  ISO: 'iso',
-  Locale: 'locale',
-  Custom: 'custom',
-};
-
-export function formatTimestamp(
-  formatTimestampFn: NonNullable<LoggerOptions['formatTimestamp']>,
-  types: TimestampTypes,
-  date: Date = new Date(),
-): string {
-  const [, timestamp] = formatTimestampFn(types, date);
-  return timestamp;
-}
-
-export function getColor(level: string, enableColors: boolean): string {
-  if (!enableColors) return level;
-  const colors: Record<string, string> = {
-    '[INFO]': chalk.blue(level),
-    '[WARN]': chalk.yellow(level),
-    '[ERROR]': chalk.red(level),
-    '[DEBUG]': chalk.gray(level),
-  };
-  return colors[level] || level;
-}
-
-export function formatLog(
-  level: string,
-  timestamp: string,
-  args: unknown[],
-  options: LoggerOptions,
-): [string, ...unknown[]] {
-  const { formatLog, enableColors = true } = options;
-  const coloredLevel = getColor(level, enableColors);
-  if (formatLog) {
-    return [formatLog(coloredLevel, timestamp, args)];
-  }
-  return [`${coloredLevel} ${timestamp}`, ...args];
-}

package/tests/logger.test.ts

@@ -1,182 +0,0 @@
-import {
-  describe,
-  it,
-  expect,
-  vi,
-  beforeEach,
-  afterEach,
-  type MockInstance,
-} from 'vitest';
-import { Logger, TIMESTAMP_TYPES } from '../src/index';
-
-describe('Logger', () => {
-  let logger: Logger;
-  let consoleSpy: MockInstance<
-    [message?: unknown, ...optionalParams: unknown[]],
-    void
-  >;
-
-  beforeEach(() => {
-    logger = new Logger();
-    consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-  });
-
-  afterEach(() => {
-    consoleSpy.mockRestore();
-  });
-
-  it('should have info method', () => {
-    logger.info('test message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[INFO]'),
-      'test message',
-    );
-  });
-
-  it('should have warn method', () => {
-    logger.warn('test message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[WARN]'),
-      'test message',
-    );
-  });
-
-  it('should have error method', () => {
-    logger.error('test message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[ERROR]'),
-      'test message',
-    );
-  });
-
-  it('should have debug method', () => {
-    logger.debug('test message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[DEBUG]'),
-      'test message',
-    );
-  });
-
-  it('should include timestamp in logs', () => {
-    logger.info('test');
-    const callArgs = consoleSpy.mock.calls[0][0];
-    expect(callArgs).toMatch(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z/);
-  });
-
-  it('should handle multiple arguments', () => {
-    logger.info('hello', 'world', 42, { key: 'value' });
-    const calls = consoleSpy.mock.calls[0];
-    expect(calls[0]).toMatch(/\[INFO\]/);
-    expect(calls[1]).toBe('hello');
-    expect(calls[2]).toBe('world');
-    expect(calls[3]).toBe(42);
-    expect(calls[4]).toEqual({ key: 'value' });
-  });
-
-  it('should disable colors when enableColors is false', () => {
-    const noColorLogger = new Logger({ enableColors: false });
-    noColorLogger.info('test message');
-    const callArgs = consoleSpy.mock.calls[0][0];
-    expect(callArgs).toContain('[INFO]'); // Should not have ANSI codes
-    expect(callArgs).not.toContain('\u001b['); // ANSI escape code
-  });
-
-  it('should use locale timestamp format', () => {
-    const localeLogger = new Logger({
-      formatTimestamp: (types) => [types.Locale, new Date().toLocaleString()],
-    });
-    localeLogger.info('test');
-    const callArgs = consoleSpy.mock.calls[0][0];
-    expect(callArgs).toMatch(/\d{1,2}\/\d{1,2}\/\d{4}/); // Basic locale date check
-  });
-
-  it('should use custom timestamp function', () => {
-    const customLogger = new Logger({
-      formatTimestamp: () => [TIMESTAMP_TYPES.Custom, 'custom-time'],
-    });
-    customLogger.info('test');
-    const callArgs = consoleSpy.mock.calls[0][0];
-    expect(callArgs).toContain('custom-time');
-  });
-
-  it('should use custom log format', () => {
-    const customLogger = new Logger({
-      formatLog: (level, timestamp, args) =>
-        `${timestamp} ${level}: ${args.join(' ')}`,
-    });
-    customLogger.warn('hello', 'world');
-    const callArgs = consoleSpy.mock.calls[0][0];
-    expect(callArgs).toMatch(
-      /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z \[WARN\]: hello world/,
-    );
-  });
-
-  it('should default to debug log level', () => {
-    const defaultLogger = new Logger();
-    defaultLogger.debug('debug message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[DEBUG]'),
-      'debug message',
-    );
-  });
-
-  it('should filter logs below the set level', () => {
-    const infoLogger = new Logger({ level: 'info' });
-    infoLogger.debug('debug message');
-    expect(consoleSpy).not.toHaveBeenCalled();
-
-    infoLogger.info('info message');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[INFO]'),
-      'info message',
-    );
-  });
-
-  it('should allow all levels when set to debug', () => {
-    const debugLogger = new Logger({ level: 'debug' });
-    debugLogger.debug('debug');
-    debugLogger.info('info');
-    debugLogger.warn('warn');
-    debugLogger.error('error');
-    expect(consoleSpy).toHaveBeenCalledTimes(4);
-  });
-
-  it('should filter debug and info when set to warn', () => {
-    const warnLogger = new Logger({ level: 'warn' });
-    warnLogger.debug('debug');
-    warnLogger.info('info');
-    expect(consoleSpy).not.toHaveBeenCalled();
-
-    warnLogger.warn('warn');
-    warnLogger.error('error');
-    expect(consoleSpy).toHaveBeenCalledTimes(2);
-  });
-
-  it('should only log errors when set to error', () => {
-    const errorLogger = new Logger({ level: 'error' });
-    errorLogger.debug('debug');
-    errorLogger.info('info');
-    errorLogger.warn('warn');
-    expect(consoleSpy).not.toHaveBeenCalled();
-
-    errorLogger.error('error');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[ERROR]'),
-      'error',
-    );
-  });
-
-  it('should allow changing log level dynamically', () => {
-    const logger = new Logger();
-    logger.setLevel('error');
-    logger.debug('debug');
-    expect(consoleSpy).not.toHaveBeenCalled();
-
-    logger.setLevel('debug');
-    logger.debug('debug');
-    expect(consoleSpy).toHaveBeenCalledWith(
-      expect.stringContaining('[DEBUG]'),
-      'debug',
-    );
-  });
-});

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  dts: true,
-  splitting: false,
-  sourcemap: true,
-  clean: true,
-});