logixlysia 3.4.0 → 3.6.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [3.6.0](https://github.com/PunGrumpy/logixlysia/compare/v3.5.0...v3.6.0) (2024-07-24)
+
+
+### Features
+
+* **custom-log:** add unix epoch timestamp option on `customLogFormat` configuration ([58d3e5b](https://github.com/PunGrumpy/logixlysia/commit/58d3e5b89bfef86aed1f5daa70d9a39982750073)), closes [#56](https://github.com/PunGrumpy/logixlysia/issues/56)
+* **transports:** add custom tranporter support for flexible logging ([69e1b89](https://github.com/PunGrumpy/logixlysia/commit/69e1b8991d323d8463fb81cf5bf1b441f678318b)), closes [#51](https://github.com/PunGrumpy/logixlysia/issues/51)
+
+## [3.5.0](https://github.com/PunGrumpy/logixlysia/compare/v3.4.0...v3.5.0) (2024-07-11)
+
+
+### Features
+
+* **config:** add option to toggle server start banner display ([c975cd6](https://github.com/PunGrumpy/logixlysia/commit/c975cd6da94e39d055cdf7bc43cc1ed1eec4971e)), closes [#52](https://github.com/PunGrumpy/logixlysia/issues/52)
+
 ## [3.4.0](https://github.com/PunGrumpy/logixlysia/compare/v3.3.2...v3.4.0) (2024-06-17)
 
 

package/README.md

@@ -21,9 +21,11 @@ const app = new Elysia({
 }).use(
   logixlysia({
     config: {
+      showBanner: true,
       ip: true,
+      logFilePath: './logs/example.log',
       customLogFormat:
-        '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}',
+        '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip} {epoch}',
       logFilter: {
         level: ['ERROR', 'WARNING'],
         status: [500, 404],
@@ -36,15 +38,34 @@ const app = new Elysia({
 app.listen(3000)
 ```
 
+> [!NOTE]
+> You can discover more about example in the [example](example) directory.
+
 ## `📚` Documentation
 
 ### 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`                                                       |
+
+### Custom Log Message
+
+| Placeholder  | Description                                                                 |
+| ------------ | --------------------------------------------------------------------------- |
+| `{now}`      | Current date and time in `YYYY-MM-DD HH:mm:ss` format                       |
+| `{level}`    | Log level (`INFO`, `WARNING`, `ERROR`)                                      |
+| `{duration}` | Request duration in milliseconds                                            |
+| `{method}`   | Request method (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS`) |
+| `{pathname}` | Request pathname                                                            |
+| `{status}`   | Response status code                                                        |
+| `{message}`  | Custom message                                                              |
+| `{ip}`       | Incoming IP address                                                         |
+| `{epoch}`    | Current date and time in Unix epoch format (seconds since January 1, 1970   |
 
 ## `📄` License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",
@@ -23,7 +23,7 @@
     "dev": "bun run --watch example/basic.ts",
     "prepare": "husky",
     "lint:staged": "lint-staged",
-    "prettier": "prettier --write --config .trunk/configs/.prettierrc.yaml .",
+    "format": "prettier --write --config .trunk/configs/.prettierrc.yaml .",
     "trunk:check": "trunk check",
     "trunk:fmt": "trunk fmt"
   },
@@ -71,25 +71,25 @@
   ],
   "dependencies": {
     "chalk": "^5.3.0",
-    "elysia": "^1.0.21"
+    "elysia": "^1.1.4"
   },
   "devDependencies": {
-    "@elysiajs/eden": "^1.0.13",
-    "@eslint/js": "^9.3.0",
+    "@elysiajs/eden": "^1.1.1",
+    "@eslint/js": "^9.7.0",
     "@trunkio/launcher": "^1.3.1",
-    "@typescript-eslint/eslint-plugin": "^7.10.0",
-    "@typescript-eslint/parser": "^7.10.0",
-    "bun-types": "^1.1.9",
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.17.0",
+    "bun-types": "^1.1.20",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "9.x",
-    "eslint-plugin-simple-import-sort": "^12.1.0",
-    "husky": "^9.0.11",
-    "lint-staged": "^15.2.4",
-    "prettier": "^3.2.5",
-    "typescript-eslint": "^7.10.0"
+    "eslint": "^9.7.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "husky": "^9.1.1",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.3",
+    "typescript-eslint": "^7.17.0"
   },
   "peerDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.2.2"
   }
 }

package/src/index.ts

@@ -25,7 +25,7 @@ export default function logixlysia(options?: Options): Elysia {
   return new Elysia({
     name: 'Logixlysia'
   })
-    .onStart(ctx => startServer(ctx.server as Server))
+    .onStart(ctx => startServer(ctx.server as Server, options))
     .onRequest(ctx => {
       ctx.store = { beforeTime: process.hrtime.bigint() }
     })

package/src/logger/buildLogMessage.ts

@@ -26,9 +26,11 @@ export function buildLogMessage(
   options?: Options,
   useColors: boolean = true
 ): string {
+  const now = new Date()
   const nowStr = useColors
-    ? chalk.bgYellow(chalk.black(new Date().toLocaleString()))
-    : new Date().toLocaleString()
+    ? chalk.bgYellow(chalk.black(now.toLocaleString()))
+    : now.toLocaleString()
+  const epochStr = Math.floor(now.getTime() / 1000).toString()
   const levelStr = logString(level, useColors)
   const durationStr = durationString(store.beforeTime, useColors)
   const methodStr = methodString(request.method, useColors)
@@ -46,6 +48,7 @@ export function buildLogMessage(
 
   return logFormat
     .replace('{now}', nowStr)
+    .replace('{epoch}', epochStr)
     .replace('{level}', levelStr)
     .replace('{duration}', durationStr)
     .replace('{method}', methodStr)

package/src/logger/createLogger.ts

@@ -1,3 +1,4 @@
+import { logToTransports } from '~/transports'
 import {
   LogData,
   Logger,
@@ -42,6 +43,8 @@ async function log(
       options
     )
   }
+
+  await logToTransports(level, request, data, store, options)
 }
 
 /**

package/src/transports/index.ts

@@ -0,0 +1,22 @@
+import { buildLogMessage } from '~/logger/buildLogMessage'
+import { LogData, LogLevel, Options, RequestInfo, StoreData } from '~/types'
+
+export async function logToTransports(
+  level: LogLevel,
+  request: RequestInfo,
+  data: LogData,
+  store: StoreData,
+  options?: Options
+): Promise<void> {
+  if (!options?.config?.transports || options.config.transports.length === 0) {
+    return
+  }
+
+  const message = buildLogMessage(level, request, data, store, options, false)
+
+  const promises = options.config.transports.map(transport =>
+    transport.log(level, message, { request, data, store })
+  )
+
+  await Promise.all(promises)
+}

package/src/types.ts

@@ -44,9 +44,24 @@ class HttpError extends Error {
   }
 }
 
+interface TransportFunction {
+  (
+    level: LogLevel,
+    message: string,
+    meta: {
+      request: RequestInfo
+      data: LogData
+      store: StoreData
+    }
+  ): Promise<void> | void
+}
+
+interface Transport {
+  log: TransportFunction
+}
+
 interface Options {
   config?: {
-    ip?: boolean
     customLogFormat?: string
     logFilePath?: string
     logFilter?: {
@@ -54,6 +69,9 @@ interface Options {
       method?: string | string[]
       status?: number | number[]
     } | null
+    ip?: boolean
+    showBanner?: boolean
+    transports?: Transport[]
   }
 }
 
@@ -66,5 +84,7 @@ export {
   Options,
   RequestInfo,
   Server,
-  StoreData
+  StoreData,
+  Transport,
+  TransportFunction
 }

package/src/utils/start.ts

@@ -1,4 +1,4 @@
-import { Server } from '~/types'
+import { Options, Server } from '~/types'
 
 /**
  * Creates a box text.
@@ -19,15 +19,18 @@ function createBoxText(text: string, width: number): string {
  * @param {Server} config The server configuration.
  * @returns {void} The server string.
  */
-function startServer(config: Server): void {
+function startServer(config: Server, options?: Options): void {
   const { hostname, port, protocol } = config
-  const ELYSIA_VERSION = import.meta.require('elysia/package.json').version
-  const title = `Elysia v${ELYSIA_VERSION}`
-  const message = `🦊 Elysia is running at ${protocol}://${hostname}:${port}`
-  const boxWidth = Math.max(title.length, message.length) + 4
-  const border = '─'.repeat(boxWidth)
+  const showBanner = options?.config?.showBanner ?? true
 
-  console.log(`
+  if (showBanner) {
+    const ELYSIA_VERSION = import.meta.require('elysia/package.json').version
+    const title = `Elysia v${ELYSIA_VERSION}`
+    const message = `🦊 Elysia is running at ${protocol}://${hostname}:${port}`
+    const boxWidth = Math.max(title.length, message.length) + 4
+    const border = '─'.repeat(boxWidth)
+
+    console.log(`
       ┌${border}┐
       │${createBoxText('', boxWidth)}│
       │${createBoxText(title, boxWidth)}│
@@ -36,6 +39,9 @@ function startServer(config: Server): void {
       │${createBoxText('', boxWidth)}│
       └${border}┘
     `)
+  } else {
+    console.log(`🦊 Elysia is running at ${protocol}://${hostname}:${port}`)
+  }
 }
 
 export default startServer