logixlysia 3.3.2 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* **logger:** add file logging capability ([6d913a3](https://github.com/PunGrumpy/logixlysia/commit/6d913a3dcc6cbba40bcaa4b6c4c4a4b474a90969))
+
+
+### Bug Fixes
+
+* **logger:** remove ANSI color codes from log files ([df42315](https://github.com/PunGrumpy/logixlysia/commit/df423151399f9436121b0d5d4a9b0424befdc835))
+
 ## [3.3.2](https://github.com/PunGrumpy/logixlysia/compare/v3.3.1...v3.3.2) (2024-06-06)
 
 

package/README.md

@@ -14,14 +14,16 @@ bun add logixlysia
 
 ```ts
 import { Elysia } from 'elysia'
-import { logixlysia } from 'logixlysia'
+import logixlysia from 'logixlysia'
 
 const app = new Elysia({
   name: 'Logixlysia Example'
 }).use(
   logixlysia({
     config: {
+      showBanner: true,
       ip: true,
+      logFilePath: './logs/example.log',
       customLogFormat:
         '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}',
       logFilter: {
@@ -42,9 +44,11 @@ app.listen(3000)
 
 | 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`                                                       |
 
 ## `📄` License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "3.3.2",
+  "version": "3.5.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,23 +71,23 @@
   ],
   "dependencies": {
     "chalk": "^5.3.0",
-    "elysia": "^1.0.21"
+    "elysia": "^1.0.24"
   },
   "devDependencies": {
-    "@elysiajs/eden": "^1.0.13",
-    "@eslint/js": "^9.3.0",
+    "@elysiajs/eden": "^1.0.14",
+    "@eslint/js": "^9.5.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.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
+    "bun-types": "^1.1.13",
     "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"
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.2",
+    "typescript-eslint": "^7.13.1"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"

package/src/index.ts

@@ -1,8 +1,7 @@
 import { Server } from 'bun'
 import Elysia from 'elysia'
 
-import { createLogger } from './logger/createLogger'
-import { handleHttpError } from './logger/handleHttpError'
+import { createLogger, handleHttpError } from './logger'
 import { HttpError, Options } from './types'
 import startServer from './utils/start'
 
@@ -16,9 +15,6 @@ import startServer from './utils/start'
  *
  * @name Logixlysia
  * @description Logixlysia is a logger plugin for ElysiaJS.
- * @author PunGrumpy
- * @license MIT
- *
  * @param {Options} [options] Configuration options for the logger.
  *
  * @returns {Elysia} The logger plugin for ElysiaJS.
@@ -26,12 +22,10 @@ import startServer from './utils/start'
 export default function logixlysia(options?: Options): Elysia {
   const log = createLogger(options)
 
-  const elysia = new 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() }
     })
@@ -46,6 +40,4 @@ export default function logixlysia(options?: Options): Elysia {
         options
       )
     })
-
-  return elysia
 }

package/src/logger/buildLogMessage.ts

@@ -15,6 +15,7 @@ import statusString from '~/utils/status'
  * @param {LogData} data The log data.
  * @param {StoreData} store The store data.
  * @param {Options} options The logger options.
+ * @param {boolean} useColors Whether to apply colors to the log message.
  * @returns {string} The formatted log message.
  */
 export function buildLogMessage(
@@ -22,14 +23,17 @@ export function buildLogMessage(
   request: RequestInfo,
   data: LogData,
   store: StoreData,
-  options?: Options
+  options?: Options,
+  useColors: boolean = true
 ): string {
-  const nowStr = chalk.bgYellow(chalk.black(new Date().toLocaleString()))
-  const levelStr = logString(level)
-  const durationStr = durationString(store.beforeTime)
-  const methodStr = methodString(request.method)
+  const nowStr = useColors
+    ? chalk.bgYellow(chalk.black(new Date().toLocaleString()))
+    : new Date().toLocaleString()
+  const levelStr = logString(level, useColors)
+  const durationStr = durationString(store.beforeTime, useColors)
+  const methodStr = methodString(request.method, useColors)
   const pathnameStr = pathString(request)
-  const statusStr = statusString(data.status || 200)
+  const statusStr = statusString(data.status || 200, useColors)
   const messageStr = data.message || ''
   const ipStr =
     options?.config?.ip && request.headers.get('x-forwarded-for')
@@ -39,7 +43,8 @@ export function buildLogMessage(
   const logFormat =
     options?.config?.customLogFormat ||
     '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
-  const logMessage = logFormat
+
+  return logFormat
     .replace('{now}', nowStr)
     .replace('{level}', levelStr)
     .replace('{duration}', durationStr)
@@ -48,6 +53,4 @@ export function buildLogMessage(
     .replace('{status}', statusStr)
     .replace('{message}', messageStr)
     .replace('{ip}', ipStr || '')
-
-  return logMessage
 }

package/src/logger/createLogger.ts

@@ -9,9 +9,10 @@ import {
 
 import { buildLogMessage } from './buildLogMessage'
 import { filterLog } from './filter'
+import { logToFile } from './logToFile'
 
 /**
- * Logs a message to the console.
+ * Logs a message to the console and optionally to a file.
  *
  * @param {LogLevel} level The log level.
  * @param {RequestInfo} request The request information.
@@ -26,12 +27,21 @@ async function log(
   store: StoreData,
   options?: Options
 ): Promise<void> {
-  if (!filterLog(level, data.status || 200, request.method, options)) {
-    return
-  }
+  if (!filterLog(level, data.status || 200, request.method, options)) return
 
-  const logMessage = buildLogMessage(level, request, data, store, options)
+  const logMessage = buildLogMessage(level, request, data, store, options, true)
   console.log(logMessage)
+
+  if (options?.config?.logFilePath) {
+    await logToFile(
+      options.config.logFilePath,
+      level,
+      request,
+      data,
+      store,
+      options
+    )
+  }
 }
 
 /**

package/src/logger/filter.ts

@@ -9,41 +9,23 @@ import { LogLevel, Options } from '~/types'
  * @param {Options} options The options.
  * @returns {boolean} `true` if the log message should be logged, otherwise `false`.
  */
-function filterLog(
+export function filterLog(
   logLevel: LogLevel,
   status: number,
   method: string,
   options?: Options
 ): boolean {
   const filter = options?.config?.logFilter
-
   if (!filter) return true
 
-  if (filter.level) {
-    if (Array.isArray(filter.level)) {
-      if (!filter.level.includes(logLevel)) return false
-    } else {
-      if (filter.level !== logLevel) return false
-    }
-  }
-
-  if (filter.status) {
-    if (Array.isArray(filter.status)) {
-      if (!filter.status.includes(status)) return false
-    } else {
-      if (filter.status !== status) return false
-    }
-  }
+  const checkFilter = (filterValue: any, value: any) =>
+    Array.isArray(filterValue)
+      ? filterValue.includes(value)
+      : filterValue === value
 
-  if (filter.method) {
-    if (Array.isArray(filter.method)) {
-      if (!filter.method.includes(method)) return false
-    } else {
-      if (filter.method !== method) return false
-    }
-  }
-
-  return true
+  return (
+    (!filter.level || checkFilter(filter.level, logLevel)) &&
+    (!filter.status || checkFilter(filter.status, status)) &&
+    (!filter.method || checkFilter(filter.method, method))
+  )
 }
-
-export { filterLog }

package/src/logger/index.ts

@@ -0,0 +1,2 @@
+export { createLogger } from './createLogger'
+export { handleHttpError } from './handleHttpError'

package/src/logger/logToFile.ts

@@ -0,0 +1,40 @@
+import { promises as fs } from 'fs'
+import { dirname } from 'path'
+
+import { LogData, LogLevel, Options, RequestInfo, StoreData } from '~/types'
+
+import { buildLogMessage } from './buildLogMessage'
+
+/**
+ * Ensures that the directory exists. If not, it creates the directory.
+ *
+ * @param {string} filePath The path to the log file.
+ */
+async function ensureDirectoryExists(filePath: string): Promise<void> {
+  const dir = dirname(filePath)
+  await fs.mkdir(dir, { recursive: true })
+}
+
+/**
+ * Logs a message to a file.
+ *
+ * @param {string} filePath The path to the log file.
+ * @param {LogLevel} level The log level.
+ * @param {RequestInfo} request The request information.
+ * @param {LogData} data The log data.
+ * @param {StoreData} store The store data.
+ * @param {Options} options The logger options.
+ */
+export async function logToFile(
+  filePath: string,
+  level: LogLevel,
+  request: RequestInfo,
+  data: LogData,
+  store: StoreData,
+  options?: Options
+): Promise<void> {
+  await ensureDirectoryExists(filePath)
+  const logMessage =
+    buildLogMessage(level, request, data, store, options, false) + '\n'
+  await fs.appendFile(filePath, logMessage)
+}

package/src/types.ts

@@ -48,11 +48,13 @@ interface Options {
   config?: {
     ip?: boolean
     customLogFormat?: string
+    logFilePath?: string
     logFilter?: {
       level?: LogLevel | LogLevel[]
       method?: string | string[]
       status?: number | number[]
     } | null
+    showBanner?: boolean
   }
 }
 

package/src/utils/colorMapping.ts

@@ -6,9 +6,6 @@ import { ColorMap } from '~/types'
  * The color map for the log levels.
  *
  * @type {ColorMap}
- * @property {chalk.Chalk} INFO The color for the INFO log level.
- * @property {chalk.Chalk} WARNING The color for the WARNING log level.
- * @property {chalk.Chalk} ERROR The color for the ERROR log level.
  */
 const LogLevelColorMap: ColorMap = {
   INFO: chalk.bgGreen.black,
@@ -20,13 +17,6 @@ const LogLevelColorMap: ColorMap = {
  * The color map for the HTTP methods.
  *
  * @type {ColorMap}
- * @property {chalk.Chalk} GET The color for the GET HTTP method.
- * @property {chalk.Chalk} POST The color for the POST HTTP method.
- * @property {chalk.Chalk} PUT The color for the PUT HTTP method.
- * @property {chalk.Chalk} PATCH The color for the PATCH HTTP method.
- * @property {chalk.Chalk} DELETE The color for the DELETE HTTP method.
- * @property {chalk.Chalk} HEAD The color for the HEAD HTTP method.
- * @property {chalk.Chalk} OPTIONS The color for the OPTIONS HTTP method.
  */
 const HttpMethodColorMap: ColorMap = {
   GET: chalk.green,

package/src/utils/duration.ts

@@ -2,13 +2,12 @@ import chalk from 'chalk'
 
 /**
  * Converts a time difference into a formatted string with the most appropriate time unit.
- * Units used are seconds (s), milliseconds (ms), microseconds (µs), and nanoseconds (ns).
  *
  * @param {bigint} beforeTime - The timestamp taken before the request.
- *
+ * @param {boolean} useColors - Whether to apply colors to the output.
  * @returns {string} A formatted duration string including the time unit.
  */
-function durationString(beforeTime: bigint): string {
+function durationString(beforeTime: bigint, useColors: boolean): string {
   const currentTime = process.hrtime.bigint()
   const nanoseconds = Number(currentTime - beforeTime)
 
@@ -21,11 +20,11 @@ function durationString(beforeTime: bigint): string {
   for (const { unit, threshold, decimalPlaces } of timeUnits) {
     if (nanoseconds >= threshold) {
       const value = (nanoseconds / threshold).toFixed(decimalPlaces)
-      return formatTime(value, unit)
+      return formatTime(value, unit, useColors)
     }
   }
 
-  return formatTime(nanoseconds.toString(), 'ns')
+  return formatTime(nanoseconds.toString(), 'ns', useColors)
 }
 
 /**
@@ -33,11 +32,14 @@ function durationString(beforeTime: bigint): string {
  *
  * @param {string} value - The time value.
  * @param {string} unit - The time unit.
- *
+ * @param {boolean} useColors - Whether to apply colors to the output.
  * @returns {string} Styled time string.
  */
-function formatTime(value: string, unit: string): string {
-  return chalk.gray(`${value}${unit}`).padStart(8).padEnd(16)
+function formatTime(value: string, unit: string, useColors: boolean): string {
+  const timeStr = `${value}${unit}`
+  return useColors
+    ? chalk.gray(timeStr).padStart(8).padEnd(16)
+    : timeStr.padStart(8).padEnd(16)
 }
 
 export default durationString

package/src/utils/log.ts

@@ -6,11 +6,14 @@ import { LogLevelColorMap } from './colorMapping'
  * Converts the log level to a string.
  *
  * @param {LogLevel} level The log level.
+ * @param {boolean} useColors - Whether to apply colors to the output.
  * @returns {string} The log level as a string.
  */
-function logString(level: LogLevel): string {
+function logString(level: LogLevel, useColors: boolean): string {
   const levelStr = level.toUpperCase()
-  return LogLevelColorMap[levelStr]?.(levelStr.padEnd(7)) || levelStr
+  return useColors
+    ? LogLevelColorMap[levelStr]?.(levelStr.padEnd(7)) || levelStr
+    : levelStr.padEnd(7)
 }
 
 export default logString

package/src/utils/method.ts

@@ -4,17 +4,14 @@ import { HttpMethodColorMap } from './colorMapping'
  * Converts an HTTP request method to a colored string representation.
  *
  * @param {string} method The HTTP request method (e.g., 'GET', 'POST').
- *
- * @returns {string} A colored string representing the method.
+ * @param {boolean} useColors - Whether to apply colors to the output.
+ * @returns {string} A string representing the method.
  */
-function methodString(method: string): string {
+function methodString(method: string, useColors: boolean): string {
   const colorFunction = HttpMethodColorMap[method]
-
-  if (colorFunction) {
-    return colorFunction(method.padEnd(7))
-  }
-
-  return method
+  return useColors && colorFunction
+    ? colorFunction(method.padEnd(7))
+    : method.padEnd(7)
 }
 
 export default methodString

package/src/utils/path.ts

@@ -4,10 +4,8 @@ import { RequestInfo } from '~/types'
  * Returns the path string.
  *
  * @param {RequestInfo} requestInfo The request info.
- *
  * @returns {string | undefined} The path string.
  */
-
 function pathString(requestInfo: RequestInfo): string | undefined {
   try {
     return new URL(requestInfo.url).pathname

package/src/utils/start.ts

@@ -1,11 +1,10 @@
-import { Server } from '~/types'
+import { Options, Server } from '~/types'
 
 /**
  * Creates a box text.
  *
  * @param {string} text The text.
  * @param {number} width The box width.
- *
  * @returns {string} The box text.
  */
 function createBoxText(text: string, width: number): string {
@@ -18,18 +17,20 @@ function createBoxText(text: string, width: number): string {
  * Starts the server 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
+
+  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(`
+    console.log(`
       ┌${border}┐
       │${createBoxText('', boxWidth)}│
       │${createBoxText(title, boxWidth)}│
@@ -38,6 +39,9 @@ function startServer(config: Server): void {
       │${createBoxText('', boxWidth)}│
       └${border}┘
     `)
+  } else {
+    console.log(`🦊 Elysia is running at ${protocol}://${hostname}:${port}`)
+  }
 }
 
 export default startServer

package/src/utils/status.ts

@@ -4,10 +4,10 @@ import chalk from 'chalk'
  * Converts the status code to a string.
  *
  * @param {number} status The status code.
- *
+ * @param {boolean} useColors - Whether to apply colors to the output.
  * @returns {string} The status code as a string.
  */
-function statusString(status: number): string {
+function statusString(status: number, useColors: boolean): string {
   const color =
     status >= 500
       ? 'red'
@@ -18,7 +18,7 @@ function statusString(status: number): string {
           : status >= 200
             ? 'green'
             : 'white'
-  return chalk[color](status.toString())
+  return useColors ? chalk[color](status.toString()) : status.toString()
 }
 
 export default statusString

package/.trunk/trunk.yaml

@@ -1,26 +0,0 @@
----
-version: 0.1
-cli:
-  version: 1.22.1
-plugins:
-  sources:
-    - id: trunk
-      ref: v1.5.0
-      uri: https://github.com/trunk-io/plugins
-runtimes:
-  enabled:
-    - node@22.2.0
-lint:
-  enabled:
-    - oxipng@9.1.1
-    - shfmt@3.6.0
-    - eslint@9.3.0
-    - actionlint@1.7.0
-    - git-diff-check
-    - markdownlint@0.40.0
-    - prettier@3.2.5
-    - trufflehog@3.76.3
-    - yamllint@1.35.1
-actions:
-  enabled:
-    - npm-check

package/lint-staged.config.cjs

@@ -1,8 +0,0 @@
-module.exports = {
-  '**/*.(ts)': () => `bun tsc --noEmit`,
-  '**/*.(ts|js|cjs)': filenames => [
-    `bun eslint --fix ${filenames.join(' ')}`,
-    `bun prettier --write ${filenames.join(' ')}`
-  ],
-  '**/*.(md|json)': filenames => `bun prettier --write ${filenames.join(' ')}`
-}