@athenna/logger 3.0.6 → 3.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.0.6",
+  "version": "3.0.8",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -51,9 +51,9 @@
     "telegraf": "4.7.0"
   },
   "devDependencies": {
-    "@athenna/common": "3.0.1",
-    "@athenna/config": "3.0.3",
-    "@athenna/ioc": "3.0.1",
+    "@athenna/common": "3.0.2",
+    "@athenna/config": "3.0.4",
+    "@athenna/ioc": "3.0.2",
     "@japa/assert": "1.3.4",
     "@japa/run-failed-tests": "1.0.7",
     "@japa/runner": "2.0.7",
@@ -135,8 +135,10 @@
       "node": true
     },
     "globals": {
+      "ioc": true,
       "Env": true,
-      "ioc": true
+      "Path": true,
+      "Config": true
     },
     "plugins": [
       "prettier"

package/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)
   }
 
   /**

package/src/Helpers/{ConsoleLogger.js → 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

package/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,17 +636,25 @@ export class ConsoleLogger {
    * @return {any | Promise<any>}
    */
   error(...args: string[] | any[]): any | Promise<any>
-}
 
-export class Logger {
   /**
-   * 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>}
    */
-  static getConsoleLogger(runtimeConfigs?: any): ConsoleLogger
+  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 {
   /**
    * Set runtime configurations for drivers and
    * formatters.
@@ -742,4 +767,31 @@ export class Logger {
    * @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>
+
+  /**
+   * 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} [configs]
+   * @return {VanillaLogger}
+   */
+  static getVanillaLogger(configs?: any): VanillaLogger
 }

package/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'
@@ -24,16 +24,6 @@ export * from './Factories/DriverFactory.js'
 export * from './Factories/FormatterFactory.js'
 
 export class Logger {
-  /**
-   * Get a new instance of the ConsoleLogger.
-   *
-   * @param {any} [runtimeConfigs]
-   * @return {ConsoleLogger}
-   */
-  static getConsoleLogger(runtimeConfigs) {
-    return new ConsoleLogger(runtimeConfigs)
-  }
-
   /**
    * The driver responsible for transporting the logs.
    *
@@ -54,6 +44,10 @@ export class Logger {
    * @return {Logger}
    */
   constructor() {
+    if (!Config.exists(`logging.channels.${Config.get('logging.default')}`)) {
+      return this
+    }
+
     this.#drivers.push(DriverFactory.fabricate('default', this.#runtimeConfigs))
   }
 
@@ -170,4 +164,17 @@ export class Logger {
   fatal(...args) {
     return this.#log('fatal', ...args)
   }
+
+  /**
+   * 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} [configs]
+   * @return {VanillaLogger}
+   */
+  static getVanillaLogger(configs = {}) {
+    return new VanillaLogger(configs)
+  }
 }