logixlysia 3.6.2 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [4.0.0](https://github.com/PunGrumpy/logixlysia/compare/v3.7.0...v4.0.0) (2024-10-28)
+
+
+### ⚠ BREAKING CHANGES
+
+* **timestamp:** The timestamp format in logs will now respect the new timestamp configuration options when provided
+
+### Features
+
+* **timestamp:** add customize timestamp formatting ([5a4e2a5](https://github.com/PunGrumpy/logixlysia/commit/5a4e2a5230443761d8c2ca99d9ebc586ff26a8c0)), closes [#69](https://github.com/PunGrumpy/logixlysia/issues/69)
+
+## [3.7.0](https://github.com/PunGrumpy/logixlysia/compare/v3.6.2...v3.7.0) (2024-09-26)
+
+
+### Features
+
+* **optional:** add startup message config ([#66](https://github.com/PunGrumpy/logixlysia/pull/66)) ([c7a76db](https://github.com/PunGrumpy/logixlysia/commit/c7a76dbc0f30f4c9c607b52dedc49979e26b67ec)) by [@n0ky4](https://github.com/n0ky4)
+
 ## [3.6.2](https://github.com/PunGrumpy/logixlysia/compare/v3.6.1...v3.6.2) (2024-09-18)
 
 

package/README.md

@@ -21,7 +21,11 @@ const app = new Elysia({
 }).use(
   logixlysia({
     config: {
-      showBanner: true,
+      showStartupMessage: true,
+      startupMessageFormat: 'simple',
+      timestamp: {
+        translateTime: 'yyyy-mm-dd HH:MM:ss'
+      },
       ip: true,
       logFilePath: './logs/example.log',
       customLogFormat:
@@ -45,13 +49,15 @@ app.listen(3000)
 
 ### Options
 
-| Option             | Type      | Description                                                           | Default                                                                   |
-| ------------------ | --------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `showBanner`       | `boolean` | Display the banner on the console                                     | `true`                                                                    |
-| `ip`               | `boolean` | Display the incoming IP address based on the `X-Forwarded-For` header | `false`                                                                   |
-| `customLogMessage` | `string`  | Custom log message to display                                         | `🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}` |
-| `logFilter`        | `object`  | Filter the logs based on the level, method, and status                | `null`                                                                    |
-| `logFilePath`      | `string`  | Path to the log file                                                  | `./logs/elysia.log`                                                       |
+| Option                 | Type                     | Description                                                           | Default                                                                   |
+| ---------------------- | ------------------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `showStartupMessage`   | `boolean`                | Display the startup message                                           | `true`                                                                    |
+| `startupMessageFormat` | `"banner"` \| `"simple"` | Choose the startup message format                                     | `"banner"`                                                                |
+| `timestamp`            | `object`                 | Display the timestamp in the logs                                     | `{ translateTime: 'yyyy-mm-dd HH:MM:ss' }`                                |
+| `ip`                   | `boolean`                | Display the incoming IP address based on the `X-Forwarded-For` header | `false`                                                                   |
+| `customLogMessage`     | `string`                 | Custom log message to display                                         | `🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}` |
+| `logFilter`            | `object`                 | Filter the logs based on the level, method, and status                | `null`                                                                    |
+| `logFilePath`          | `string`                 | Path to the log file                                                  | `./logs/elysia.log`                                                       |
 
 ### Custom Log Message
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "3.6.2",
+  "version": "4.0.0",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",
@@ -10,6 +10,12 @@
   "maintainers": [
     "PunGrumpy"
   ],
+  "contributors": [
+    {
+      "name": "n0ky4",
+      "url": "https://github.com/n0ky4"
+    }
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -71,24 +77,21 @@
   ],
   "dependencies": {
     "chalk": "^5.3.0",
-    "elysia": "^1.1.4"
+    "elysia": "^1.1.19"
   },
   "devDependencies": {
-    "@elysiajs/eden": "^1.1.1",
-    "@eslint/js": "^9.8.0",
-    "@trunkio/launcher": "^1.3.1",
-    "@typescript-eslint/eslint-plugin": "^8.0.1",
-    "@typescript-eslint/parser": "^8.0.1",
-    "bun-types": "^1.1.20",
-    "commitizen": "^4.3.0",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "9.x",
+    "@elysiajs/eden": "^1.1.3",
+    "@eslint/js": "^9.12.0",
+    "@trunkio/launcher": "^1.3.2",
+    "@typescript-eslint/eslint-plugin": "^8.8.1",
+    "@typescript-eslint/parser": "^8.8.1",
+    "bun-types": "^1.1.30",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "globals": "^15.9.0",
-    "husky": "^9.1.1",
-    "lint-staged": "^15.2.7",
+    "globals": "^15.11.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
     "prettier": "^3.3.3",
-    "typescript-eslint": "^8.0.1"
+    "typescript-eslint": "^8.8.1"
   },
   "peerDependencies": {
     "typescript": "^5.2.2"

package/src/core/buildLogMessage.ts

@@ -10,6 +10,7 @@ import {
 } from '../types'
 import {
   durationString,
+  formatTimestamp,
   logString,
   methodString,
   pathString,
@@ -38,14 +39,16 @@ export function buildLogMessage(
   const now = new Date()
   const components: LogComponents = {
     now: actuallyUseColors
-      ? chalk.bgYellow(chalk.black(now.toLocaleString()))
-      : now.toLocaleString(),
+      ? chalk.bgYellow(
+          chalk.black(formatTimestamp(now, options?.config?.timestamp))
+        )
+      : formatTimestamp(now, options?.config?.timestamp),
     epoch: Math.floor(now.getTime() / 1000).toString(),
-    level: logString(level, actuallyUseColors),
-    duration: durationString(store.beforeTime, actuallyUseColors),
-    method: methodString(request.method, actuallyUseColors),
+    level: logString(level, useColors),
+    duration: durationString(store.beforeTime, useColors),
+    method: methodString(request.method, useColors),
     pathname: pathString(request),
-    status: statusString(data.status || 200, actuallyUseColors),
+    status: statusString(data.status || 200, useColors),
     message: data.message || '',
     ip:
       options?.config?.ip && request.headers.get('x-forwarded-for')

package/src/index.ts

@@ -10,7 +10,10 @@ export default function logixlysia(options?: Options): Elysia {
   return new Elysia({
     name: 'Logixlysia'
   })
-    .onStart(ctx => startServer(ctx.server as Server, options))
+    .onStart(ctx => {
+        const showStartupMessage = options?.config?.showStartupMessage ?? true
+        if (showStartupMessage) startServer(ctx.server as Server, options)}
+    )
     .onRequest(ctx => {
       ctx.store = { beforeTime: process.hrtime.bigint() }
     })
@@ -26,6 +29,6 @@ export default function logixlysia(options?: Options): Elysia {
     })
 }
 
-export { createLogger } from './core'
-export { handleHttpError } from './core'
+export { createLogger, handleHttpError } from './core'
 export { logToTransports } from './transports'
+

package/src/plugins/startServer.ts

@@ -8,7 +8,7 @@ const createBoxText = (text: string, width: number): string => {
 
 export default function startServer(config: Server, options?: Options): void {
   const { hostname, port, protocol } = config
-  const showBanner = options?.config?.showBanner ?? true
+  const showBanner = options?.config?.startupMessageFormat !== 'simple'
 
   if (showBanner) {
     const ELYSIA_VERSION = import.meta.require('elysia/package.json').version

package/src/types/index.ts

@@ -77,6 +77,10 @@ export interface Transport {
   log: TransportFunction
 }
 
+export interface TimestampConfig {
+  translateTime?: boolean | string
+}
+
 export interface Options {
   config?: {
     customLogFormat?: string
@@ -88,7 +92,9 @@ export interface Options {
     } | null
     ip?: boolean
     useColors?: boolean
-    showBanner?: boolean
+    showStartupMessage?: boolean
+    startupMessageFormat?: 'banner' | 'simple'
     transports?: Transport[]
+    timestamp?: TimestampConfig // Add this new option
   }
 }

package/src/utils/index.ts

@@ -4,3 +4,4 @@ export { default as logString } from './log'
 export { default as methodString } from './method'
 export { default as pathString } from './path'
 export { default as statusString } from './status'
+export { formatTimestamp } from './timestamp'

package/src/utils/timestamp.ts

@@ -0,0 +1,48 @@
+import { TimestampConfig } from '../types'
+
+// const DEFAULT_TIMESTAMP_FORMAT = 'yyyy-mm-dd HH:MM:ss'
+const SYS_TIME = 'SYS:STANDARD'
+
+const pad = (n: number): string => n.toString().padStart(2, '0')
+
+function formatSystemTime(date: Date): string {
+  const year = date.getFullYear()
+  const month = pad(date.getMonth() + 1)
+  const day = pad(date.getDate())
+  const hours = pad(date.getHours())
+  const minutes = pad(date.getMinutes())
+  const seconds = pad(date.getSeconds())
+  const ms = date.getMilliseconds().toString().padStart(3, '0')
+
+  return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}.${ms}`
+}
+
+function formatCustomTime(date: Date, format: string): string {
+  const tokens: { [key: string]: string | number } = {
+    yyyy: date.getFullYear(),
+    yy: date.getFullYear().toString().slice(-2),
+    mm: pad(date.getMonth() + 1),
+    dd: pad(date.getDate()),
+    HH: pad(date.getHours()),
+    MM: pad(date.getMinutes()),
+    ss: pad(date.getSeconds()),
+    SSS: pad(date.getMilliseconds()),
+    Z: -date.getTimezoneOffset() / 60
+  }
+
+  return format.replace(/yyyy|yy|mm|dd|HH|MM|ss|SSS|Z/g, match =>
+    (tokens[match] ?? '').toString()
+  )
+}
+
+export function formatTimestamp(date: Date, config?: TimestampConfig): string {
+  if (!config || !config.translateTime) {
+    return date.toISOString()
+  }
+
+  if (config.translateTime === true || config.translateTime === SYS_TIME) {
+    return formatSystemTime(date)
+  }
+
+  return formatCustomTime(date, config.translateTime)
+}

package/tests/utils/timestamp.test.ts

@@ -0,0 +1,35 @@
+import { expect, test } from 'bun:test'
+
+import { formatTimestamp } from '../../src/utils/timestamp'
+
+test('formatTimestamp with different configurations', () => {
+  const testDate = new Date('2024-01-15T14:30:45.123Z')
+
+  // Test default format
+  expect(formatTimestamp(testDate)).toBe(testDate.toISOString())
+
+  // Test system time format
+  expect(formatTimestamp(testDate, { translateTime: true })).toMatch(
+    /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$/
+  )
+
+  // Test custom format
+  expect(
+    formatTimestamp(testDate, {
+      translateTime: 'yyyy-mm-dd HH:MM:ss.SSS'
+    })
+  ).toMatch(/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$/)
+
+  // Test different custom formats
+  expect(
+    formatTimestamp(testDate, {
+      translateTime: 'HH:MM:ss'
+    })
+  ).toMatch(/^\d{2}:\d{2}:\d{2}$/)
+
+  expect(
+    formatTimestamp(testDate, {
+      translateTime: 'yyyy/mm/dd'
+    })
+  ).toMatch(/^\d{4}\/\d{2}\/\d{2}$/)
+})