Merge pull request #54 from AthennaIO/develop

fix(types): add missing types

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

src/Factories/DriverFactory.js

@@ -20,6 +20,7 @@ import { TelegramDriver } from '#src/Drivers/TelegramDriver'
 import { DriverExistException } from '#src/Exceptions/DriverExistException'
 import { NotFoundDriverException } from '#src/Exceptions/NotFoundDriverException'
 import { NotImplementedConfigException } from '#src/Exceptions/NotImplementedConfigException'
+import { Options } from '@athenna/common'
 
 export class DriverFactory {
   /**
@@ -70,17 +71,21 @@ export class DriverFactory {
   }
 
   /**
-   * Fabricate a new instance of a driver without
+   * Fabricate a new instance of a driver with vanilla
    * configurations.
    *
-   * @param {string} driverName
-   * @param {any} runtimeConfig
+   * @param {any} configs
    * @return {any}
    */
-  static fabricateOnly(driverName, runtimeConfig = {}) {
-    const { Driver } = this.#drivers.get(driverName)
+  static fabricateVanilla(configs = {}) {
+    configs = Options.create(configs, {
+      driver: 'console',
+      formatter: 'none',
+    })
+
+    const { Driver } = this.#drivers.get(configs.driver)
 
-    return new Driver(runtimeConfig)
+    return new Driver(configs)
   }
 
   /**

src/Helpers/ConsoleLogger.js → src/Helpers/VanillaLogger.js

@@ -10,7 +10,7 @@
 import { ColorHelper } from '#src/index'
 import { DriverFactory } from '#src/Factories/DriverFactory'
 
-export class ConsoleLogger {
+export class VanillaLogger {
   /**
    * The driver responsible for transporting the logs.
    *
@@ -21,18 +21,18 @@ export class ConsoleLogger {
   /**
    * Creates a new instance of ConsoleLogger.
    *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
+   * @param {any} [configs]
+   * @return {VanillaLogger}
    */
-  constructor(runtimeConfigs) {
-    this.#drivers.push(DriverFactory.fabricateOnly('console', runtimeConfigs))
+  constructor(configs) {
+    this.#drivers.push(DriverFactory.fabricateVanilla(configs))
   }
 
   /**
    * Set runtime configurations for drivers and
    * formatters.
    *
-   * @return {ConsoleLogger}
+   * @return {VanillaLogger}
    */
   config() {
     return this
@@ -41,7 +41,7 @@ export class ConsoleLogger {
   /**
    * Change the log channel.
    *
-   * @return {ConsoleLogger}
+   * @return {VanillaLogger}
    */
   channel() {
     return this

src/index.d.ts

@@ -523,7 +523,24 @@ export class FormatterFactory {
   static createFormatter(name: string, formatter: () => any): void
 }
 
-export class ConsoleLogger {
+export class VanillaLogger {
+  /**
+   * Set runtime configurations for drivers and
+   * formatters.
+   *
+   * @param {any} runtimeConfig
+   * @return {VanillaLogger}
+   */
+  config(runtimeConfig: any): VanillaLogger
+
+  /**
+   * Change the log channel.
+   *
+   * @param {string[]} channels
+   * @return {VanillaLogger}
+   */
+  channel(...channels: string[]): VanillaLogger
+
   /**
    * Creates a log of type trace in channel.
    *
@@ -619,6 +636,22 @@ export class ConsoleLogger {
    * @return {any | Promise<any>}
    */
   error(...args: string[] | any[]): any | Promise<any>
+
+  /**
+   * Creates a log of type fatal in channel.
+   *
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  fatal(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type fatal in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
+   */
+  fatal(...args: string[] | any[]): any | Promise<any>
 }
 
 export class Logger {
@@ -736,18 +769,29 @@ export class Logger {
   error(...args: string[] | any[]): any | Promise<any>
 
   /**
-   * Get a new instance of the ConsoleLogger.
+   * Creates a log of type fatal in channel.
    *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
+   * @param {string|any} message
+   * @return {any | Promise<any>}
+   */
+  fatal(message: string | any): any | Promise<any>
+
+  /**
+   * Creates a log of type fatal in channel.
+   *
+   * @param {string[]|any[]} args
+   * @return {any | Promise<any>}
    */
-  getConsoleLogger(runtimeConfigs?: any): ConsoleLogger
+  fatal(...args: string[] | any[]): any | Promise<any>
 
   /**
-   * Get a new instance of the ConsoleLogger.
+   * Get a new instance of any log driver
+   * with vanilla configurations. By default,
+   * vanilla logger will use the "console" driver
+   * and "none" formatter.
    *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
+   * @param {any} [configs]
+   * @return {VanillaLogger}
    */
-  static getConsoleLogger(runtimeConfigs?: any): ConsoleLogger
+  static getVanillaLogger(configs?: any): VanillaLogger
 }

src/index.js

@@ -8,13 +8,13 @@
  */
 
 import { ColorHelper } from '#src/index'
-import { ConsoleLogger } from '#src/Helpers/ConsoleLogger'
+import { VanillaLogger } from '#src/Helpers/VanillaLogger'
 import { DriverFactory } from '#src/Factories/DriverFactory'
 
 export * from './Facades/Log.js'
 
 export * from './Helpers/ColorHelper.js'
-export * from './Helpers/ConsoleLogger.js'
+export * from './Helpers/VanillaLogger.js'
 export * from './Helpers/FactoryHelper.js'
 
 export * from './Drivers/Driver.js'
@@ -166,22 +166,15 @@ export class Logger {
   }
 
   /**
-   * Get a new instance of the ConsoleLogger.
+   * Get a new instance of any log driver
+   * with vanilla configurations. By default,
+   * vanilla logger will use the "console" driver
+   * and "none" formatter.
    *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
+   * @param {any} [configs]
+   * @return {VanillaLogger}
    */
-  getConsoleLogger(runtimeConfigs) {
-    return Logger.getConsoleLogger(runtimeConfigs)
-  }
-
-  /**
-   * Get a new instance of the ConsoleLogger.
-   *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
-   */
-  static getConsoleLogger(runtimeConfigs) {
-    return new ConsoleLogger(runtimeConfigs)
+  static getVanillaLogger(configs = {}) {
+    return new VanillaLogger(configs)
   }
 }

tests/Stubs/transporters/vanillaLogger.js

@@ -0,0 +1,12 @@
+import { Logger } from '#src/index'
+
+// Just testing the drivers behavior without loading configurations.
+const vanillaLogger = new Logger().constructor.getVanillaLogger()
+
+vanillaLogger.trace('hello')
+vanillaLogger.debug('%s', 'hello')
+vanillaLogger.info('hello')
+vanillaLogger.success('%s', 'hello')
+vanillaLogger.warn('({yellow,notFound,bold} hello) hello')
+vanillaLogger.error('%s', 'hello')
+vanillaLogger.fatal('hello')

tests/Unit/Helpers/ConsoleLoggerTest.js → tests/Unit/Helpers/VanillaLoggerTest.js

@@ -12,9 +12,9 @@ import { exec } from 'node:child_process'
 import { test } from '@japa/runner'
 import { File, Path } from '@athenna/common'
 
-test.group('ConsoleLoggerTest', group => {
+test.group('VanillaLoggerTest', group => {
   test('should be able to log in console using console logger', async ({ assert }) => {
-    const file = await new File(Path.stubs('transporters/consoleLogger.js')).load()
+    const file = await new File(Path.stubs('transporters/vanillaLogger.js')).load()
 
     await exec(`node --input-type=module --eval="${file.getContentSync().toString()}"`, (_, stdout, stderr) => {
       const logs = [...stdout.split('\n').filter(l => l !== ''), ...stderr.split('\n').filter(l => l !== '')]