logixlysia 3.4.0 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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)
 
 

package/README.md

@@ -21,7 +21,9 @@ const app = new Elysia({
 }).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.4.0",
+  "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

@@ -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/types.ts

@@ -54,6 +54,7 @@ interface Options {
       method?: string | string[]
       status?: number | number[]
     } | null
+    showBanner?: boolean
   }
 }
 

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