logixlysia 2.3.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.0.0](https://github.com/PunGrumpy/logixlysia/compare/v2.3.1...v3.0.0) (2024-04-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* **options:** 
+
+### Features
+
+* **options:** add support for custom log format ([acc9380](https://github.com/PunGrumpy/logixlysia/commit/acc9380ea25691e7d7fec175094cb6a9878b6c69))
+
 ## [2.3.1](https://github.com/PunGrumpy/logixlysia/compare/v2.3.0...v2.3.1) (2024-04-07)
 
 

package/README.md

@@ -18,7 +18,13 @@ import { logger } from 'logixlysia'
 
 const app = new Elysia({
   name: 'Logixlysia Example'
-}).use(logger())
+}).use(
+  logger({
+    ip: false,
+    customLogMessage:
+      '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
+  })
+)
 
 app.listen(3000)
 ```
@@ -27,9 +33,10 @@ app.listen(3000)
 
 ### Options
 
-| Option | Type      | Description                                                           | Default |
-| ------ | --------- | --------------------------------------------------------------------- | ------- |
-| `ip`   | `boolean` | Display the incoming IP address based on the `X-Forwarded-For` header | `false` |
+| Option             | Type      | Description                                                           | Default                                                                   |
+| ------------------ | --------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `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}` |
 
 ## `📄` License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",

package/src/logger.ts

@@ -7,17 +7,36 @@ import statusString from './utils/status'
 import { HttpError, RequestInfo } from './types'
 import { LogLevel, LogData, Logger, StoreData, Options } from './types'
 
-async function log(
+/**
+ * Logs a message.
+ *
+ * @param {LogLevel} level The log level.
+ * @param {RequestInfo} request The request.
+ * @param {LogData} data The log data.
+ * @param {StoreData} store The store data.
+ * @param {Options} options The options.
+ */
+function log(
   level: LogLevel,
   request: RequestInfo,
   data: LogData,
   store: StoreData,
   options?: Options
-): Promise<void> {
+): void {
   const logMessage = buildLogMessage(level, request, data, store, options)
   console.log(logMessage)
 }
 
+/**
+ * Builds a log message.
+ *
+ * @param {LogLevel} level The log level.
+ * @param {RequestInfo} request The request.
+ * @param {LogData} data The log data.
+ * @param {StoreData} store The store data.
+ * @param {Options} options The options.
+ * @returns {string} The log message.
+ */
 function buildLogMessage(
   level: LogLevel,
   request: RequestInfo,
@@ -32,24 +51,47 @@ function buildLogMessage(
   const pathnameStr = pathString(request)
   const statusStr = statusString(data.status || 200)
   const messageStr = data.message || ''
+  const ipStr =
+    options?.ip && request.headers.get('x-forwarded-for')
+      ? `IP: ${request.headers.get('x-forwarded-for')}`
+      : ''
 
-  let logMessage = `🦊 ${nowStr} ${levelStr} ${durationStr} ${methodStr} ${pathnameStr} ${statusStr} ${messageStr}`
-
-  if (options?.ip) {
-    const forwardedFor = request.headers.get('x-forwarded-for')
-    if (forwardedFor) {
-      logMessage += ` IP: ${forwardedFor}`
-    }
-  }
+  const logFormat =
+    options?.customLogFormat ||
+    '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
+  const logMessage = logFormat
+    .replace('{now}', nowStr)
+    .replace('{level}', levelStr)
+    .replace('{duration}', durationStr)
+    .replace('{method}', methodStr)
+    .replace('{pathname}', pathnameStr || '')
+    .replace('{status}', statusStr)
+    .replace('{message}', messageStr)
+    .replace('{ip}', ipStr || '')
 
   return logMessage
 }
 
+/**
+ * Creates a logger.
+ *
+ * @param {Options} options The options.
+ * @returns {Logger} The logger.
+ */
 export const createLogger = (options?: Options): Logger => ({
   log: (level, request, data, store) =>
-    log(level, request, data, store, options)
+    log(level, request, data, store, options),
+  customLogFormat: options?.customLogFormat
 })
 
+/**
+ * Handles an HTTP error.
+ *
+ * @param {RequestInfo} request The request.
+ * @param {Error} error The error.
+ * @param {StoreData} store The store data.
+ * @param {Options} options The options.
+ */
 export const handleHttpError = (
   request: RequestInfo,
   error: Error,

package/src/types.ts

@@ -28,6 +28,7 @@ interface Logger {
     data: LogData,
     store: StoreData
   ): void
+  customLogFormat?: string
 }
 
 interface StoreData {
@@ -45,6 +46,7 @@ class HttpError extends Error {
 
 interface Options {
   ip?: boolean
+  customLogFormat?: string
 }
 
 export {

package/test/logixlysia.test.ts

@@ -10,7 +10,13 @@ describe('Logixlysia with IP logging enabled', () => {
 
   beforeAll(() => {
     server = new Elysia()
-      .use(logger({ ip: true }))
+      .use(
+        logger({
+          ip: true,
+          customLogFormat:
+            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+        })
+      )
       .get('/', ctx => {
         const ipAddress = ctx.request.headers.get('x-forwarded-for') || 'null'
         return '🦊 Logixlysia Getting'
@@ -35,7 +41,9 @@ describe('Logixlysia with IP logging enabled', () => {
     }
 
     logs.forEach(log => {
-      expect(log).toMatch(/^IP: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/)
+      expect(log).toMatch(
+        /^🦊 .+ INFO .+ .+ GET \/ .+ IP: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
+      )
     })
   })
 
@@ -47,7 +55,7 @@ describe('Logixlysia with IP logging enabled', () => {
     }
 
     logs.forEach(log => {
-      expect(log).toBe('IP: null')
+      expect(log).toMatch(/^🦊 .+ INFO .+ .+ GET \/ .+ IP: null$/)
     })
   })
 })
@@ -59,7 +67,13 @@ describe('Logixlysia with IP logging disabled', () => {
 
   beforeAll(() => {
     server = new Elysia()
-      .use(logger({ ip: false }))
+      .use(
+        logger({
+          ip: false,
+          customLogFormat:
+            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+        })
+      )
       .get('/', () => '🦊 Logixlysia Getting')
       .post('logixlysia', () => '🦊 Logixlysia Posting')
       .listen(3000)