@stacksjs/logging 0.58.57 → 0.58.59

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/logging",
   "type": "module",
-  "version": "0.58.57",
+  "version": "0.58.59",
   "description": "The Stacks logging system.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/index.ts

@@ -1,9 +1,39 @@
 import process from 'node:process'
-import consola from 'consola'
+import { consola, createConsola } from 'consola'
 import { ExitCode } from '@stacksjs/types'
+import { logger as logConfig } from '@stacksjs/config'
 import { logsPath } from '@stacksjs/path'
+import type { Prompt } from '@stacksjs/cli'
+import { buddyOptions, prompt as getPrompt } from '@stacksjs/cli'
 
-export const logger = consola
+export function logLevel() {
+  /**
+   * This regex checks for:
+   *   - --verbose true or --verbose=true exactly at the end of the string ($ denotes the end of the string).
+   *   - --verbose - followed by optional spaces at the end.
+   *   - --verbose followed by optional spaces at the end.
+   *
+   * .trim() is used on options to ensure any trailing spaces in the entire options string do not affect the regex match.
+   */
+  const verboseRegex = /--verbose(?!(\s*=\s*false|\s+false))(\s+|=true)?($|\s)/
+
+  if (verboseRegex.test(buddyOptions().trim()))
+    return 4
+  return logConfig.level
+}
+
+export const logger = createConsola({
+  level: logLevel(),
+  // fancy: true,
+  // formatOptions: {
+  //     columns: 80,
+  //     colors: false,
+  //     compact: false,
+  //     date: false,
+  // },
+})
+
+export { consola }
 
 export const logFilePath = logsPath('console.log')
 
@@ -27,35 +57,66 @@ async function writeToLogFile(message: string) {
   }
 }
 
-export const log = {
-  info: async (...arg: any) => {
-    consola.info(...arg)
+export interface Log {
+  info: (...args: any[]) => void
+  success: (msg: string) => void
+  error: (err: string | Error, options?: any) => void
+  warn: (arg: string) => void
+  debug: (...args: any[]) => void
+  // start: logger.Start
+  // box: logger.Box
+  start: any
+  box: any
+  prompt: Prompt
+  dump: (...args: any[]) => void
+  dd: (...args: any[]) => void
+  echo: (...args: any[]) => void
+}
+
+export const log: Log = {
+  async info(...arg: any) {
+    // @ts-expect-error intentional
+    logger.info(...arg)
     await writeToLogFile(`INFO: ${arg}`)
   },
 
-  success: async (msg: string) => {
-    consola.success(msg)
+  async success(msg: string) {
+    logger.success(msg)
     await writeToLogFile(`SUCCESS: ${msg}`)
   },
 
-  error: async (err: string, options?: any) => {
+  async error(err: string | Error, options?: any) {
     handleError(err, options) // Assuming handleError logs the error
     await writeToLogFile(`ERROR: ${err}`)
   },
 
-  warn: async (arg: string) => {
-    consola.warn(arg)
+  async warn(arg: string) {
+    logger.warn(arg)
     await writeToLogFile(`WARN: ${arg}`)
   },
 
-  debug: async (arg: string) => {
-    consola.debug(arg)
+  async debug(...arg: any) {
+    if (process.env.APP_ENV === 'production' || process.env.APP_ENV === 'prod')
+      return await writeToLogFile(`DEBUG: ${arg}`)
+
+    logger.debug(arg)
     await writeToLogFile(`DEBUG: ${arg}`)
   },
 
-  // prompt,
+  async start(...arg: any) {
+    logger.start(arg)
+    await writeToLogFile(`START: ${arg}`)
+  },
+
+  box: logger.box,
+
+  get prompt() {
+    return getPrompt()
+  },
+
   dump,
   dd,
+  echo,
 }
 
 export function dump(...args: any[]) {
@@ -68,3 +129,8 @@ export function dd(...args: any[]) {
   // e.g. if used in a CDK script, we want it to fail the deployment
   process.exit(ExitCode.FatalError)
 }
+
+export function echo(...args: any[]) {
+  // eslint-disable-next-line no-console
+  console.log(...args)
+}