@athenna/logger 1.1.7 → 1.2.0

package/LICENSE.md

@@ -2,20 +2,8 @@ MIT License
 
 Copyright (c) 2022 The Athenna Framework
 
-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:
+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 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.
+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

@@ -1,18 +1,18 @@
-# Logger 🔍
+# Template 📔
 
-> The Athenna logging solution. Log in stdout, files and buckets
+> Template for new projects
 
 [![GitHub followers](https://img.shields.io/github/followers/athennaio.svg?style=social&label=Follow&maxAge=2592000)](https://github.com/athennaio?tab=followers)
-[![GitHub stars](https://img.shields.io/github/stars/athennaio/logger.svg?style=social&label=Star&maxAge=2592000)](https://github.com/athennaio/logger/stargazers/)
+[![GitHub stars](https://img.shields.io/github/stars/AthennaIO/Logger.svg?style=social&label=Star&maxAge=2592000)](https://github.com/AthennaIO/Logger/stargazers/)
 
 <p>
     <a href="https://www.buymeacoffee.com/athenna" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
 </p>
 
 <p>
-  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/athennaio/logger?style=for-the-badge&logo=appveyor">
+  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/AthennaIO/Logger?style=for-the-badge&logo=appveyor">
 
-  <img alt="Repository size" src="https://img.shields.io/github/repo-size/athennaio/logger?style=for-the-badge&logo=appveyor">
+  <img alt="Repository size" src="https://img.shields.io/github/repo-size/AthennaIO/Logger?style=for-the-badge&logo=appveyor">
 
   <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?style=for-the-badge&logo=appveyor">
 
@@ -27,7 +27,7 @@
 
 ## Contributing
 
-> If you want to contribute to this project, first read the [CONTRIBUTING.MD](https://github.com/athennaio/logger/blob/develop/CONTRIBUTING.md) file. It will be a pleasure to receive your help.
+> If you want to contribute to this project, first read the [CONTRIBUTING.MD](https://github.com/AthennaIO/Logger/blob/develop/CONTRIBUTING.md) file. It will be a pleasure to receive your help.
 
 ---
 

package/package.json

@@ -1,49 +1,92 @@
 {
   "name": "@athenna/logger",
-  "version": "1.1.7",
-  "description": "",
+  "version": "1.2.0",
+  "description": "Template for new projects.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
-  "repository": "https://github.com/AthennaIO/Logger.git",
   "bugs": "https://github.com/AthennaIO/Logger/issues",
+  "repository": "https://github.com/AthennaIO/Logger.git",
   "homepage": "https://github.com/AthennaIO/Logger#readme",
+  "keywords": [],
   "scripts": {
-    "build": "tsc --project tsconfig.json && tscpaths -p tsconfig.json -s . -o .",
-    "test": "npm run lint:fix && cross-env NODE_TS=true cross-env NODE_ENV=testing jest --verbose",
-    "test:debug": "npm run lint:fix && cross-env NODE_TS=true cross-env NODE_ENV=testing cross-env DEBUG=api:* jest --verbose",
-    "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix"
+    "lint:fix": "eslint \"{src,tests}/**/*.js\" --fix",
+    "test": "npm run --silent lint:fix && node ./tests/index.js",
+    "test:debug": "cross-env DEBUG=api:* && npm run --silent test",
+    "test:coverage": "c8 npm run --silent test",
+    "gen:types": "tsc src/*.js --declaration --allowJs --emitDeclarationOnly --out src/index.js"
   },
-  "keywords": [
-    "nodejs",
-    "athenna",
-    "typescript"
+  "files": [
+    "src/*.js",
+    "src/*.d.ts",
+    "src/**/*.js",
+    "src/**/*.d.ts"
   ],
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "imports": {
+    "#src/*": "./src/*.js",
+    "#tests/*": "./tests/*.js"
+  },
+  "exports": {
+    ".": "./src/index.js",
+    "./facades/Log": "./src/Facades/Log.js",
+    "./providers/LoggerProvider": "./src/Providers/LoggerProvider.js"
+  },
+  "dependencies": {
+    "@athenna/ioc": "1.1.7",
+    "@secjs/utils": "1.9.3",
+    "awilix": "7.0.3",
+    "axios": "0.26.1",
+    "chalk": "5.0.1",
+    "debug": "4.3.4",
+    "pino": "7.10.0",
+    "pino-pretty": "7.6.1",
+    "telegraf": "4.7.0"
+  },
   "devDependencies": {
-    "@types/jest": "27.0.1",
-    "@types/node": "14.17.0",
-    "@typescript-eslint/eslint-plugin": "4.31.0",
-    "@typescript-eslint/parser": "4.31.0",
+    "@japa/assert": "1.3.4",
+    "@japa/run-failed-tests": "1.0.7",
+    "@japa/runner": "2.0.7",
+    "@japa/spec-reporter": "1.1.12",
+    "c8": "7.11.2",
     "commitizen": "4.2.4",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "7.32.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-config-standard": "16.0.3",
-    "eslint-import-resolver-typescript": "2.4.0",
-    "eslint-plugin-import": "2.24.2",
-    "eslint-plugin-node": "11.1.0",
+    "eslint": "8.14.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-config-standard": "17.0.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-n": "15.2.0",
     "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-promise": "5.1.0",
-    "eslint-plugin-standard": "5.0.0",
+    "eslint-plugin-promise": "6.0.0",
     "husky": "3.0.9",
-    "jest": "27.1.0",
-    "lint-staged": "9.4.3",
-    "prettier": "2.0.5",
-    "ts-jest": "27.0.5",
-    "ts-loader": "9.2.3",
-    "ts-node": "10.0.0",
-    "tsconfig-paths": "3.9.0",
-    "typescript": "4.3.5"
+    "lint-staged": "12.4.1",
+    "minimist": "1.2.6",
+    "prettier": "2.6.2",
+    "rimraf": "3.0.2",
+    "typescript": "4.6.4"
+  },
+  "c8": {
+    "all": true,
+    "include": [
+      "src/**/*.js"
+    ],
+    "reporter": [
+      "text-summary",
+      "html"
+    ],
+    "report-dir": "./tests/Coverage",
+    "check-coverage": true,
+    "statements": "80",
+    "branches": "80",
+    "functions": "50",
+    "lines": "80"
+  },
+  "husky": {
+    "hooks": {
+      "prepare-commit-msg": "lint-staged && exec < /dev/tty && git cz --hook || true"
+    }
   },
   "lint-staged": {
     "*.js": [
@@ -55,30 +98,11 @@
       "git add"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged",
-      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
     }
   },
-  "jest": {
-    "modulePaths": [
-      "<rootDir>"
-    ],
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": ".",
-    "testRegex": "Test.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "coverageDirectory": "./coverage",
-    "preset": "ts-jest",
-    "testEnvironment": "node"
-  },
   "prettier": {
     "singleQuote": true,
     "trailingComma": "all",
@@ -97,66 +121,29 @@
   },
   "eslintConfig": {
     "env": {
-      "es6": true,
+      "es2021": true,
       "node": true
     },
+    "plugins": [
+      "prettier"
+    ],
     "extends": [
       "standard",
-      "plugin:@typescript-eslint/recommended",
+      "eslint:recommended",
       "plugin:prettier/recommended"
     ],
-    "globals": {
-      "Atomics": "readonly",
-      "SharedArrayBuffer": "readonly"
-    },
-    "parser": "@typescript-eslint/parser",
+    "ignorePatterns": [
+      "**/*.d.ts"
+    ],
     "parserOptions": {
-      "ecmaVersion": 2018,
+      "ecmaVersion": "latest",
       "sourceType": "module"
     },
-    "plugins": [
-      "@typescript-eslint",
-      "prettier"
-    ],
     "rules": {
-      "dot-notation": "off",
       "camelcase": "off",
-      "no-undef": "off",
-      "@typescript-eslint/no-var-requires": "off",
-      "no-useless-constructor": "off",
-      "@typescript-eslint/no-useless-constructor": "off",
-      "@typescript-eslint/camelcase": "off",
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "@typescript-eslint/interface-name-prefix": "off",
-      "@typescript-eslint/no-explicit-any": "off",
+      "dot-notation": "off",
       "prettier/prettier": "error",
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          "argsIgnorePattern": "_"
-        }
-      ]
+      "no-useless-constructor": "off"
     }
-  },
-  "files": [
-    "src/*.js",
-    "src/*.d.ts",
-    "src/**/*.js",
-    "src/**/*.d.ts",
-    "*.js",
-    "*.d.ts"
-  ],
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
-  "dependencies": {
-    "@athenna/ioc": "1.1.3",
-    "@secjs/utils": "1.8.3",
-    "chalk": "4.1.1",
-    "reflect-metadata": "0.1.13",
-    "tscpaths": "0.0.9"
   }
 }

package/src/Drivers/ConsoleDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,25 +6,47 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConsoleDriver = void 0;
-const utils_1 = require("@secjs/utils");
-const FormatterFactory_1 = require("../Factories/FormatterFactory");
-class ConsoleDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this._formatter = configs.formatter || channelConfig.formatter;
-        this._streamType = configs.streamType || channelConfig.streamType;
-        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
-    }
-    transport(message, options) {
-        options = Object.assign({}, {
-            formatter: this._formatter,
-            streamType: this._streamType,
-        }, options);
-        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
-        process[options.streamType].write(`${message}\n`);
-    }
+
+import { Config } from '@secjs/utils'
+
+import { FactoryHelper, FormatterFactory } from '#src/index'
+
+export class ConsoleDriver {
+  /**
+   * Holds the configuration set of ConsoleDriver.
+   *
+   * @type {{ streamType?: 'stdout' | 'stderr', formatter?: any, formatterConfig?: any }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of ConsoleDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {ConsoleDriver}
+   */
+  constructor(channel, configs) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ streamType?: 'stdout' | 'stderr', formatter?: any, formatterConfig?: any }} [options]
+   * @return {void}
+   */
+  transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    process[configs.streamType].write(`${message}\n`)
+  }
 }
-exports.ConsoleDriver = ConsoleDriver;

package/src/Drivers/DebugDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,26 +6,49 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DebugDriver = void 0;
-const debug_1 = require("debug");
-const utils_1 = require("@secjs/utils");
-const FormatterFactory_1 = require("../Factories/FormatterFactory");
-class DebugDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this._formatter = configs.formatter || channelConfig.formatter;
-        this._namespace = configs.namespace || channelConfig.namespace;
-        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
-    }
-    transport(message, options) {
-        options = Object.assign({}, {
-            formatter: this._formatter,
-            namespace: this._namespace,
-        }, options);
-        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
-        debug_1.debug(options.namespace)(message);
-    }
+
+import debug from 'debug'
+
+import { Config } from '@secjs/utils'
+
+import { FactoryHelper, FormatterFactory } from '#src/index'
+
+export class DebugDriver {
+  /**
+   * Holds the configuration set of DebugDriver.
+   *
+   * @type {{ namespace?: string, formatter?: any, formatterConfig?: any }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of DebugDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {DebugDriver}
+   */
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ namespace?: string, formatter?: any, formatterConfig?: any }} [options]
+   * @return {void}
+   */
+  transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    debug(configs.namespace)(message)
+  }
 }
-exports.DebugDriver = DebugDriver;

package/src/Drivers/DiscordDriver.js

@@ -0,0 +1,57 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import axios from 'axios'
+
+import { Config } from '@secjs/utils'
+
+import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
+
+export class DiscordDriver {
+  /**
+   * Holds the configuration set of DiscordDriver.
+   *
+   * @type {{ url?: string, username?: string, formatter?: any, formatterConfig?: any }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of DiscordDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {DiscordDriver}
+   */
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ url?: string, username?: string, formatter?: any, formatterConfig?: any }} [options]
+   * @return {Promise<void>}
+   */
+  async transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    await axios.post(configs.url, {
+      username: configs.username,
+      content: ColorHelper.removeColors(message),
+    })
+  }
+}

package/src/Drivers/FileDriver.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/logger
  *
@@ -7,38 +6,56 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileDriver = void 0;
-const path_1 = require("path");
-const utils_1 = require("@secjs/utils");
-const Color_1 = require("../Utils/Color");
-const fs_1 = require("fs");
-const FormatterFactory_1 = require("../Factories/FormatterFactory");
-class FileDriver {
-    constructor(channel, configs = {}) {
-        const channelConfig = utils_1.Config.get(`logging.channels.${channel}`);
-        this._filePath = configs.filePath || channelConfig.filePath;
-        this._formatter = configs.formatter || channelConfig.formatter;
-        this._formatterConfig = Object.assign({}, channelConfig.formatterConfig, configs.formatterConfig);
-    }
-    async transport(message, options) {
-        options = Object.assign({}, {
-            filePath: this._filePath,
-            formatter: this._formatter,
-        }, options);
-        const filePath = options.filePath;
-        const { dir } = path_1.parse(filePath);
-        if (!fs_1.existsSync(dir)) {
-            fs_1.mkdirSync(dir, { recursive: true });
-        }
-        const formatterOptions = Object.assign({}, this._formatterConfig, options.formatterConfig);
-        message = FormatterFactory_1.FormatterFactory.fabricate(options.formatter).format(message, formatterOptions);
-        return new Promise((resolve, reject) => {
-            const stream = fs_1.createWriteStream(filePath, { flags: 'a' });
-            stream.write(`${Color_1.Color.removeColors(message)}` + '\n');
-            stream.on('error', reject);
-            stream.end(resolve);
-        });
+
+import { Config, File } from '@secjs/utils'
+
+import { ColorHelper, FactoryHelper, FormatterFactory } from '#src/index'
+
+export class FileDriver {
+  /**
+   * Holds the configuration set of FileDriver.
+   *
+   * @type {{ filePath?: string, formatter?: any, formatterConfig?: any }}
+   */
+  configs
+
+  /**
+   * Creates a new instance of FileDriver.
+   *
+   * @param {string} channel
+   * @param {any} [configs]
+   * @return {FileDriver}
+   */
+  constructor(channel, configs = {}) {
+    const channelConfig = Config.get(`logging.channels.${channel}`)
+
+    this.configs = FactoryHelper.groupConfigs(configs, channelConfig)
+  }
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} message
+   * @param {{ filePath?: string, formatter?: any, formatterConfig?: any }} [options]
+   * @return {Promise<void>}
+   */
+  async transport(message, options = {}) {
+    const configs = FactoryHelper.groupConfigs(options, this.configs)
+
+    message = FormatterFactory.fabricate(configs.formatter).format(
+      message,
+      configs.formatterConfig,
+    )
+
+    const messageBuffer = Buffer.from(`${ColorHelper.removeColors(message)}\n`)
+
+    const file = new File(configs.filePath, messageBuffer)
+    const fileExists = await File.exists(configs.filePath)
+
+    if (!fileExists) {
+      return file.load()
     }
+
+    return file.append(messageBuffer)
+  }
 }
-exports.FileDriver = FileDriver;

package/src/Drivers/NullDriver.js

@@ -0,0 +1,28 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export class NullDriver {
+  /**
+   * Creates a new instance of NullDriver.
+   *
+   * @param {string} _channel
+   * @param {any} [_configs]
+   * @return {NullDriver}
+   */
+  constructor(_channel, _configs = {}) {}
+
+  /**
+   * Transport the log.
+   *
+   * @param {string} _message
+   * @param {any} [_options]
+   * @return {void}
+   */
+  transport(_message, _options) {}
+}