logixlysia 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## [2.0.0](https://github.com/PunGrumpy/logixlysia/compare/v1.0.0...v2.0.0) (2023-11-19)
+
+
+### Features
+
+* **ci/cd:** separate deploy workflows from ci workflows ([e0344ae](https://github.com/PunGrumpy/logixlysia/commit/e0344ae32f711d140b1c914164e8eb7a57181558))
+
+## 1.0.0 (2023-11-18)
+
+
+### Features
+
+* add example for test ([8f0f1ee](https://github.com/PunGrumpy/logixlysia/commit/8f0f1ee01de5e5c639687bf0971f0347c3516ed0))
+* add log on start ([f1adeb9](https://github.com/PunGrumpy/logixlysia/commit/f1adeb9c620b42a2639ea6f01fa3e0ebd583ee8f))
+* add logger format and enhance logging functionality ([c0887e8](https://github.com/PunGrumpy/logixlysia/commit/c0887e8eed6142a476d2fd7eb343ef6933e26d31))
+* add new style on logging ([f1d9583](https://github.com/PunGrumpy/logixlysia/commit/f1d95832eacd6528c23454b914c61e09b4c1b83a))
+* **ci:** add google automated workflows ([526e069](https://github.com/PunGrumpy/logixlysia/commit/526e0695029b0235a268445fd1c72b267c030c13))
+* setting environment ([6f5e553](https://github.com/PunGrumpy/logixlysia/commit/6f5e553744999c70de1d8fb1b42a5eb7b75d8798))
+
+
+### Bug Fixes
+
+* change name ([ee0c164](https://github.com/PunGrumpy/logixlysia/commit/ee0c1645be16a582c4df03874fdf0712e27a9e6a))
+* change to use chalk instead piccolors ([b2fe4f5](https://github.com/PunGrumpy/logixlysia/commit/b2fe4f5a8dce51731e1729b9b0f2c7a15d280978))
+* **types:** add types ([38e1f63](https://github.com/PunGrumpy/logixlysia/commit/38e1f63b4b92f4829772d638d45d7bad8182dbdc))
+* update jsdocs and add new banner ([226c7eb](https://github.com/PunGrumpy/logixlysia/commit/226c7ebac504f661e58a9581c54e1937dfbea4a8))
+* **utils:** update jsdocs ([8cab996](https://github.com/PunGrumpy/logixlysia/commit/8cab996e757d997d3a05183e85d4bfe684fdb11d))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 PunGrumpy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+<div align="center">
+  <h1><code>🦊</code> Logixlysia</h1>
+  <strong>Logixlysia is a logging library for ElysiaJS</strong>
+  <img src="./.github/images/screenshot.png" alt="Screenshot of Logixlysia" width="100%" height="auto" />
+</div>
+
+## `📩` Installation
+
+```bash
+bun add logixlysia
+```
+
+## `📝` Usage
+
+```ts
+import { Elysia } from 'elysia'
+import { logger } from 'logixlysia'
+
+const app = new Elysia({
+  name: 'Logixlysia Example'
+}).use(logger())
+
+app.listen(3000)
+```
+
+## `📄` License
+
+Licensed under the [MIT License](LICENSE).

package/lint-staged.config.cjs

@@ -0,0 +1,21 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { existsSync } = require('fs')
+const { join } = require('path')
+
+const isBun = existsSync(join(process.cwd(), 'bun.lockb'))
+const isYarn = existsSync(join(process.cwd(), 'yarn.lock'))
+const isPnpm = existsSync(join(process.cwd(), 'pnpm-lock.yaml'))
+
+const packageManager = isBun ? 'bun' : isYarn ? 'yarn' : isPnpm ? 'pnpm' : 'npm'
+
+const options = {
+  '**/*.(ts|tsx)': () => `${packageManager} tsc --noEmit`,
+  '**/*.(ts|tsx|js)': filenames => [
+    `${packageManager} eslint --fix ${filenames.join(' ')}`,
+    `${packageManager} prettier --write ${filenames.join(' ')}`
+  ],
+  '**/*.(md|json)': filenames =>
+    `${packageManager} prettier --write ${filenames.join(' ')}`
+}
+
+module.exports = options

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "logixlysia",
+  "version": "2.0.0",
+  "description": "🦊 Logixlysia is a logger for Elysia",
+  "type": "module",
+  "module": "src/index.ts",
+  "main": "src/index.ts",
+  "author": "PunGrumpy",
+  "publisher": "PunGrumpy",
+  "maintainers": [
+    "PunGrumpy"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "bun run --watch example/basic.ts",
+    "prepare": "husky install",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "lint:staged": "lint-staged",
+    "prettier": "prettier --write ."
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "badges": [
+    {
+      "name": "npm",
+      "url": "https://img.shields.io/npm/v/logixlysia.svg",
+      "description": "npm version",
+      "href": "https://www.npmjs.com/package/logixlysia"
+    },
+    {
+      "name": "npm",
+      "url": "https://img.shields.io/npm/dt/logixlysia.svg",
+      "description": "npm downloads",
+      "href": "https://www.npmjs.com/package/logixlysia"
+    },
+    {
+      "name": "GitHub issues",
+      "url": "https://img.shields.io/github/issues/PunGrumpy/logixlysia.svg",
+      "description": "GitHub issues",
+      "href": "https://github.com/PunGrumpy/logixlysia/issues"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PunGrumpy/logixlysia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/PunGrumpy/logixlysia/issues"
+  },
+  "homepage": "https://github.com/PunGrumpy/logixlysia#readme",
+  "keywords": [
+    "web",
+    "logging",
+    "logger",
+    "elysia",
+    "elysiajs",
+    "logixlysia",
+    "middleware",
+    "middleware"
+  ],
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "chalk": "^5.3.0",
+    "elysia": "^0.7.21",
+    "eslint": "^8.53.0"
+  },
+  "devDependencies": {
+    "bun-types": "^1.0.8",
+    "husky": "^8.0.3",
+    "lint-staged": "^15.0.2",
+    "prettier": "^3.0.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package/prettier.config.cjs

@@ -0,0 +1,11 @@
+const options = {
+  arrowParens: 'avoid',
+  singleQuote: true,
+  bracketSpacing: true,
+  endOfLine: 'lf',
+  semi: false,
+  tabWidth: 2,
+  trailingComma: 'none'
+}
+
+module.exports = options

package/src/index.ts

@@ -0,0 +1,48 @@
+import Elysia from 'elysia'
+import { createLogger } from './logger'
+import startString from './utils/start'
+import { Server } from 'bun'
+
+/**
+ * Creates a logger.
+ *
+ * @export {Function} The logger.
+ * @module logger
+ * @category Logger
+ * @subcategory Functions
+ *
+ * @name Logixlysia
+ * @description Logixlysia is a logger plugin for ElysiaJS.
+ * @author PunGrumpy
+ * @license MIT
+ *
+ * @returns {Elysia} The logger.
+ */
+export const logger = (): Elysia => {
+  const log = createLogger()
+
+  const elysia = new Elysia({
+    name: 'Logixlysia'
+  })
+    .onStart(ctx => {
+      startString(ctx.app.server as Server)
+    })
+    .onRequest(ctx => {
+      ctx.store = { beforeTime: process.hrtime.bigint() } as {
+        beforeTime: bigint
+      }
+    })
+    .onBeforeHandle(ctx => {
+      ctx.store = { beforeTime: process.hrtime.bigint() } as {
+        beforeTime: bigint
+      }
+    })
+    .onAfterHandle(({ request, store }) => {
+      log.info(request, {}, store as { beforeTime: bigint })
+    })
+    .onError(({ request, error, store }) => {
+      log.error(request, error, store as { beforeTime: bigint })
+    })
+
+  return elysia
+}

package/src/logger.ts

@@ -0,0 +1,57 @@
+import chalk from 'chalk'
+import durationString from './utils/duration'
+import methodString from './utils/method'
+import logString from './utils/log'
+import pathString from './utils/path'
+import statusString from './utils/status'
+import { RequestInfo } from './types/RequestInfo'
+import { LogData, LogLevel, Logger } from './types/Logger'
+import { StoreData } from './types/StoreData'
+
+/**
+ * Logs a message to the console.
+ *
+ * @param {LogLevel} level The log level.
+ * @param {RequestInfo} request The request information.
+ * @param {LogData} data The log data.
+ * @param {StoreData} store The store data.
+ *
+ * @returns {void} The log message.
+ */
+function log(
+  level: LogLevel,
+  request: RequestInfo,
+  data: LogData,
+  store: StoreData
+): void {
+  const logStr: string[] = []
+  const nowStr = chalk.bgYellow(
+    chalk.black(
+      new Date().toISOString().replace('T', ' ').replace('Z', '').slice(0, -4)
+    )
+  )
+  const levelStr = logString(level)
+  const durationStr = durationString(store.beforeTime)
+  const methodStr = methodString(request.method)
+  const pathnameStr = pathString(request)
+  const statusStr = statusString(data.status || 200)
+  const messageStr = data.message || ''
+
+  logStr.push(
+    `🦊 ${nowStr} ${levelStr} ${durationStr} ${methodStr} ${pathnameStr} ${statusStr} ${messageStr}`
+  )
+
+  console.log(logStr.join(' '))
+}
+
+/**
+ * Creates a formatted logger.
+ *
+ * @returns {Logger} The formatted logger.
+ */
+export const createLogger = (): Logger => ({
+  info: (request, data, store) => log(LogLevel.INFO, request, data, store),
+  warning: (request, data, store) =>
+    log(LogLevel.WARNING, request, data, store),
+  error: (request, data, store) => log(LogLevel.ERROR, request, data, store)
+})

package/src/types/ColorMap.ts

@@ -0,0 +1,12 @@
+/**
+ * The color map interface.
+ *
+ * @interface ColorMap
+ *
+ * @property {string} key The color function.
+ */
+interface ColorMap {
+  [key: string]: (str: string) => string
+}
+
+export { ColorMap }

package/src/types/Logger.ts

@@ -0,0 +1,47 @@
+import { RequestInfo } from './RequestInfo'
+import { StoreData } from './StoreData'
+
+/**
+ * The log level.
+ *
+ * @enum {string}
+ *
+ * @property {string} INFO - The info log level.
+ * @property {string} WARNING - The warning log level.
+ * @property {string} ERROR - The error log level.
+ */
+enum LogLevel {
+  INFO = 'INFO',
+  WARNING = 'WARNING',
+  ERROR = 'ERROR'
+}
+
+/**
+ * The log data interface.
+ *
+ * @interface LogData
+ *
+ * @property {number} status The status code.
+ * @property {string} message The message.
+ */
+interface LogData {
+  status?: number
+  message?: string
+}
+
+/**
+ * The logger interface.
+ *
+ * @interface Logger
+ *
+ * @property {Function} info Logs an info message.
+ * @property {Function} warning Logs a warning message.
+ * @property {Function} error Logs an error message.
+ */
+interface Logger {
+  info(request: RequestInfo, data: LogData, store: StoreData): void
+  warning(request: RequestInfo, data: LogData, store: StoreData): void
+  error(request: RequestInfo, data: LogData, store: StoreData): void
+}
+
+export { LogLevel, LogData, Logger }

package/src/types/RequestInfo.ts

@@ -0,0 +1,16 @@
+/**
+ * The request info.
+ *
+ * @interface RequestInfo
+ *
+ * @property {Object} headers The request headers.
+ * @property {string} method The request method.
+ * @property {string} url The request URL.
+ */
+interface RequestInfo {
+  headers: { get: (key: string) => any }
+  method: string
+  url: string
+}
+
+export { RequestInfo }

package/src/types/Server.ts

@@ -0,0 +1,16 @@
+/**
+ * The server information.
+ *
+ * @interface Server
+ *
+ * @property {string} hostname The server hostname.
+ * @property {number} port The server port.
+ * @property {string} protocol The server protocol.
+ */
+interface Server {
+  hostname?: string
+  port?: number
+  protocol?: string
+}
+
+export { Server }

package/src/types/StoreData.ts

@@ -0,0 +1,12 @@
+/**
+ * The store data interface.
+ *
+ * @interface StoreData
+ *
+ * @property {bigint} beforeTime The time before the request.
+ */
+interface StoreData {
+  beforeTime: bigint
+}
+
+export { StoreData }

package/src/utils/duration.ts

@@ -0,0 +1,38 @@
+import chalk from 'chalk'
+
+/**
+ * Converts the time difference between the start of the request and the end of the request to a formatted string.
+ *
+ * @param {bigint} beforeTime The timestamp taken before the request.
+ *
+ * @returns {string} A formatted duration string with a time unit.
+ */
+function durationString(beforeTime: bigint): string {
+  const now = process.hrtime.bigint()
+  const timeDifference = now - beforeTime
+  const nanoseconds = Number(timeDifference)
+
+  const durationInMicroseconds = (nanoseconds / 1e3).toFixed(0)
+  const durationInMilliseconds = (nanoseconds / 1e6).toFixed(0)
+
+  let timeMessage: string = ''
+
+  if (nanoseconds >= 1e9) {
+    const seconds = (nanoseconds / 1e9).toFixed(2)
+    timeMessage = `${seconds}s`
+  } else if (nanoseconds >= 1e6) {
+    timeMessage = `${durationInMilliseconds}ms`
+  } else if (nanoseconds >= 1e3) {
+    timeMessage = `${durationInMicroseconds}µs`
+  } else {
+    timeMessage = `${nanoseconds}ns`
+  }
+
+  if (timeMessage) {
+    timeMessage = chalk.gray(timeMessage).padStart(8).padEnd(16)
+  }
+
+  return timeMessage
+}
+
+export default durationString

package/src/utils/log.ts

@@ -0,0 +1,27 @@
+import chalk from 'chalk'
+import { ColorMap } from '~/types/ColorMap'
+
+/**
+ * Converts a log level to a colored string representation.
+ *
+ * @param {string} log The log level (e.g., 'INFO', 'WARNING').
+ *
+ * @returns {string} A colored string representing the log level.
+ */
+function logString(log: string): string {
+  const colorMap: ColorMap = {
+    INFO: chalk.bgGreen,
+    WARNING: chalk.bgYellow,
+    ERROR: chalk.bgRed
+  }
+
+  const colorFunction = colorMap[log]
+
+  if (colorFunction) {
+    return colorFunction(chalk.black(log.padEnd(7)))
+  }
+
+  return log
+}
+
+export default logString

package/src/utils/method.ts

@@ -0,0 +1,31 @@
+import chalk from 'chalk'
+import { ColorMap } from '~/types/ColorMap'
+
+/**
+ * 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.
+ */
+function methodString(method: string): string {
+  const colorMap: ColorMap = {
+    GET: chalk.white,
+    POST: chalk.yellow,
+    PUT: chalk.blue,
+    DELETE: chalk.red,
+    PATCH: chalk.green,
+    OPTIONS: chalk.cyan,
+    HEAD: chalk.magenta
+  }
+
+  const colorFunction = colorMap[method]
+
+  if (colorFunction) {
+    return colorFunction(method.padEnd(7))
+  }
+
+  return method
+}
+
+export default methodString

package/src/utils/path.ts

@@ -0,0 +1,15 @@
+import { RequestInfo } from '~/types/RequestInfo'
+
+/**
+ * Returns the path string.
+ *
+ * @param {RequestInfo} path The request information.
+ *
+ * @returns {string} The path string.
+ */
+function pathString(path: RequestInfo): string {
+  const url = new URL(path?.url).pathname
+  return url
+}
+
+export default pathString

package/src/utils/start.ts

@@ -0,0 +1,45 @@
+import { Server } from '~/types/Server'
+
+/**
+ * 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 {
+  const padding = ' '.repeat((width - text.length) / 2)
+  return `${padding}${text}${padding}`
+}
+
+/**
+ * Starts the server string.
+ *
+ * @param {Server} config The server configuration.
+ *
+ * @returns {void} The server string.
+ */
+function startString(config: Server): 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 messageWidth = message.length
+  const boxWidth = Math.max(title.length, messageWidth) + 4
+  const border = '─'.repeat(boxWidth)
+
+  process.stdout.write('\x1Bc')
+
+  console.log(`
+      ┌${border}┐
+      │${createBoxText('', boxWidth)} │
+      │${createBoxText(title, boxWidth)} │
+      │${createBoxText('', boxWidth)} │
+      │${createBoxText(message, boxWidth)}│
+      │${createBoxText('', boxWidth)} │
+      └${border}┘
+    `)
+}
+
+export default startString

package/src/utils/status.ts

@@ -0,0 +1,27 @@
+import chalk from 'chalk'
+
+/**
+ * Returns the status string.
+ *
+ * @param {number} status The status code.
+ *
+ * @returns {string} The status string.
+ */
+function statusString(status: number): string {
+  if (status >= 500) {
+    return chalk.red(status.toString())
+  }
+  if (status >= 400) {
+    return chalk.yellow(status.toString())
+  }
+  if (status >= 300) {
+    return chalk.cyan(status.toString())
+  }
+  if (status >= 200) {
+    return chalk.green(status.toString())
+  }
+
+  return status.toString()
+}
+
+export default statusString

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "noUncheckedIndexedAccess": true,
+    "strict": true,
+    "allowImportingTsExtensions": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "paths": {
+      "~/*": ["./src/*"]
+    },
+    "resolveJsonModule": true,
+    "types": ["bun-types"],
+    "downlevelIteration": true,
+    "noEmit": true,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "jsxFactory": "ElysiaJSX",
+    "jsxFragmentFactory": "ElysiaJSX.Fragment",
+    "lib": ["ESNext"],
+    "moduleDetection": "force",
+    "target": "ESNext",
+    "composite": true,
+    "skipLibCheck": true
+  }
+}