Development

eslint.config.js

@@ -18,8 +18,8 @@ export default [
       'no-undef': 'off',
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/no-unused-vars': 'off',
-      'simple-import-sort/imports': 'error',
-      'simple-import-sort/exports': 'error'
+      'simple-import-sort/imports': 'warn',
+      'simple-import-sort/exports': 'warn'
     }
   }
 ]

example/basic.ts

@@ -1,6 +1,6 @@
 import { Elysia } from 'elysia'
 
-import logixlysia from '~/index'
+import logixlysia from '../src/index'
 
 const app = new Elysia({
   name: 'Basic Example'

example/transports/index.ts

@@ -1,7 +1,6 @@
 import { Elysia } from 'elysia'
 
-import logixlysia from '~/index'
-
+import logixlysia from '../../src/index'
 import MyCustomTransport from './myCustomTransport'
 
 const app = new Elysia()

example/transports/myCustomTransport.ts

@@ -1,4 +1,10 @@
-import { LogData, LogLevel, RequestInfo, StoreData, Transport } from '~/types'
+import {
+  LogData,
+  LogLevel,
+  RequestInfo,
+  StoreData,
+  Transport
+} from '../../src/types'
 
 class MyCustomTransport implements Transport {
   async log(

src/logger/buildLogMessage.ts → src/core/buildLogMessage.ts

@@ -7,27 +7,18 @@ import {
   Options,
   RequestInfo,
   StoreData
-} from '~/types'
-import durationString from '~/utils/duration'
-import logString from '~/utils/log'
-import methodString from '~/utils/method'
-import pathString from '~/utils/path'
-import statusString from '~/utils/status'
+} from '../types'
+import {
+  durationString,
+  logString,
+  methodString,
+  pathString,
+  statusString
+} from '../utils'
 
 const defaultLogFormat =
   '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
 
-/**
- * Builds a log message.
- *
- * @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.
- * @param {boolean} useColors Whether to apply colors to the log message.
- * @returns {string} The formatted log message.
- */
 export function buildLogMessage(
   level: LogLevel,
   request: RequestInfo,

src/logger/createLogger.ts → src/core/createLogger.ts

@@ -1,25 +1,17 @@
-import { buildLogMessage } from '~/logger/buildLogMessage'
-import { filterLog } from '~/logger/filter'
-import { logToFile } from '~/logger/logToFile'
-import { logToTransports } from '~/transports'
+import { logToTransports } from '../transports'
+import { logToFile } from '../transports'
 import {
   LogData,
   Logger,
   LogLevel,
   Options,
   RequestInfo,
   StoreData
-} from '~/types'
+} from '../types'
+import { buildLogMessage } from './buildLogMessage'
+import { filterLog } from './filter'
+import { handleHttpError } from './handleHttpError'
 
-/**
- * Logs a message to the console and optionally to a 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.
- */
 async function log(
   level: LogLevel,
   request: RequestInfo,
@@ -54,16 +46,12 @@ async function log(
   await Promise.all(promises)
 }
 
-/**
- * Creates a logger instance.
- *
- * @param {Options} options The logger options.
- * @returns {Logger} The logger instance.
- */
 export function createLogger(options?: Options): Logger {
   return {
     log: (level, request, data, store) =>
       log(level, request, data, store, options),
+    handleHttpError: (request, error, store) =>
+      handleHttpError(request, error, store, options),
     customLogFormat: options?.config?.customLogFormat
   }
 }

src/logger/filter.ts → src/core/filter.ts

@@ -1,19 +1,10 @@
-import { LogLevel, Options } from '~/types'
+import { LogLevel, Options } from '../types'
 
 const checkFilter = (filterValue: any, value: any) =>
   Array.isArray(filterValue)
     ? filterValue.includes(value)
     : filterValue === value
 
-/**
- * Filters log messages.
- *
- * @param {LogLevel} logLevel The log level.
- * @param {number} status The status code.
- * @param {string} method The method.
- * @param {Options} options The options.
- * @returns {boolean} `true` if the log message should be logged, otherwise `false`.
- */
 export function filterLog(
   logLevel: LogLevel,
   status: number,

src/core/handleHttpError.ts

@@ -0,0 +1,30 @@
+import { logToFile } from '../transports'
+import { HttpError, Options, RequestInfo, StoreData } from '../types'
+import { buildLogMessage } from './buildLogMessage'
+
+export function handleHttpError(
+  request: RequestInfo,
+  error: HttpError,
+  store: StoreData,
+  options?: Options
+): void {
+  const statusCode = error.status || 500
+  console.error(
+    buildLogMessage('ERROR', request, { status: statusCode }, store, options)
+  )
+
+  const promises = []
+
+  if (options?.config?.logFilePath) {
+    promises.push(
+      logToFile(
+        options.config.logFilePath,
+        'ERROR',
+        request,
+        { status: statusCode },
+        store,
+        options
+      )
+    )
+  }
+}

src/core/index.ts

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

src/index.ts

@@ -1,24 +1,9 @@
-import { Server } from 'bun'
-import Elysia from 'elysia'
+import { Elysia } from 'elysia'
 
-import { createLogger, handleHttpError } from '~/logger'
-import { HttpError, Options } from '~/types'
-import startServer from '~/utils/start'
+import { createLogger } from './core'
+import { startServer } from './plugins'
+import { HttpError, Options, Server } from './types'
 
-/**
- * Creates a logger plugin for ElysiaJS.
- *
- * @export
- * @module logger
- * @category Logger
- * @subcategory Functions
- *
- * @name Logixlysia
- * @description Logixlysia is a logger plugin for ElysiaJS.
- * @param {Options} [options] Configuration options for the logger.
- *
- * @returns {Elysia} The logger plugin for ElysiaJS.
- */
 export default function logixlysia(options?: Options): Elysia {
   const log = createLogger(options)
 
@@ -33,14 +18,14 @@ export default function logixlysia(options?: Options): Elysia {
       log.log('INFO', request, { status: 200 }, store as { beforeTime: bigint })
     })
     .onError({ as: 'global' }, ({ request, error, store }) => {
-      handleHttpError(
+      log.handleHttpError(
         request,
         error as HttpError,
-        store as { beforeTime: bigint },
-        options
+        store as { beforeTime: bigint }
       )
     })
 }
 
-export { createLogger } from '~/logger'
-export { handleHttpError } from '~/logger'
+export { createLogger } from './core'
+export { handleHttpError } from './core'
+export { logToTransports } from './transports'

src/plugins/index.ts

@@ -0,0 +1 @@
+export { default as startServer } from './startServer'

src/utils/start.ts → src/plugins/startServer.ts

@@ -1,25 +1,12 @@
-import { Options, 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.
- */
 const createBoxText = (text: string, width: number): string => {
   const paddingLength = Math.max(0, (width - text.length) / 2)
   const padding = ' '.repeat(paddingLength)
   return `${padding}${text}${padding}`.padEnd(width)
 }
 
-/**
- * Starts the server string.
- *
- * @param {Server} config The server configuration.
- * @returns {void} The server string.
- */
-function startServer(config: Server, options?: Options): void {
+export default function startServer(config: Server, options?: Options): void {
   const { hostname, port, protocol } = config
   const showBanner = options?.config?.showBanner ?? true
 
@@ -44,5 +31,3 @@ function startServer(config: Server, options?: Options): void {
     console.log(`🦊 Elysia is running at ${protocol}://${hostname}:${port}`)
   }
 }
-
-export default startServer

src/transports/console.ts

@@ -0,0 +1,22 @@
+import { buildLogMessage } from '../core/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)
+}

src/logger/logToFile.ts → src/transports/file.ts

@@ -1,16 +1,11 @@
 import { promises as fs } from 'fs'
 import { dirname } from 'path'
 
-import { buildLogMessage } from '~/logger/buildLogMessage'
-import { LogData, LogLevel, Options, RequestInfo, StoreData } from '~/types'
+import { buildLogMessage } from '../core/buildLogMessage'
+import { LogData, LogLevel, Options, RequestInfo, StoreData } from '../types'
 
 const dirCache = new Set<string>()
 
-/**
- * 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)
   if (!dirCache.has(dir)) {
@@ -19,16 +14,6 @@ async function ensureDirectoryExists(filePath: string): Promise<void> {
   }
 }
 
-/**
- * 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,

src/transports/index.ts

@@ -1,22 +1,2 @@
-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)
-}
+export { logToTransports } from './console'
+export { logToFile } from './file'