Add optional startup message config

PunGrumpy · Sep 25, 2024 · 4184544 · 4184544
1 parent ea27836
commit 4184544
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -45,13 +45,14 @@ app.listen(3000)
 
 ### 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`                                                       |
+| Option                 | Type                     | Description                                                           | Default                                                                   |
+| ---------------------- | ------------------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `showStartupMessage`   | `boolean`                | Display the startup message                                           | `true`                                                                    |
+| `startupMessageFormat` | `"banner"` \| `"simple"` | Choose the startup message format                                     | `"banner"`                                                                  |
+| `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
 

diff --git a/src/index.ts b/src/index.ts
@@ -10,7 +10,10 @@ export default function logixlysia(options?: Options): Elysia {
   return new Elysia({
     name: 'Logixlysia'
   })
-    .onStart(ctx => startServer(ctx.server as Server, options))
+    .onStart(ctx => {
+        const showStartupMessage = options?.config?.showStartupMessage ?? true
+        if (showStartupMessage) startServer(ctx.server as Server, options)}
+    )
     .onRequest(ctx => {
       ctx.store = { beforeTime: process.hrtime.bigint() }
     })
@@ -26,6 +29,6 @@ export default function logixlysia(options?: Options): Elysia {
     })
 }
 
-export { createLogger } from './core'
-export { handleHttpError } from './core'
+export { createLogger, handleHttpError } from './core'
 export { logToTransports } from './transports'
+
diff --git a/src/plugins/startServer.ts b/src/plugins/startServer.ts
@@ -8,7 +8,7 @@ const createBoxText = (text: string, width: number): string => {
 
 export default function startServer(config: Server, options?: Options): void {
   const { hostname, port, protocol } = config
-  const showBanner = options?.config?.showBanner ?? true
+  const showBanner = options?.config?.startupMessageFormat !== 'simple'
 
   if (showBanner) {
     const ELYSIA_VERSION = import.meta.require('elysia/package.json').version

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -88,7 +88,8 @@ export interface Options {
     } | null
     ip?: boolean
     useColors?: boolean
-    showBanner?: boolean
+    showStartupMessage?: boolean
+    startupMessageFormat?: 'banner' | 'simple'
     transports?: Transport[]
   }
 }