npm - @vvlad1973/simple-logger - Versions diffs - 1.2.0 - Mend

@vvlad1973/simple-logger 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

package/.vscode/launch.json +21 -0
package/LICENSE +19 -0
package/README.md +97 -0
package/dist/__test__/simple-logger.test.d.ts +1 -0
package/dist/__test__/simple-logger.test.js +113 -0
package/dist/__test__/simple-logger.test.js.map +1 -0
package/dist/index.d.ts +2 -0
package/dist/index.js +3 -0
package/dist/index.js.map +1 -0
package/dist/simple-logger.d.ts +80 -0
package/dist/simple-logger.js +152 -0
package/dist/simple-logger.js.map +1 -0
package/docs/index.html +129 -0
package/docs/module-SimpleLogger.SimpleLogger.html +1000 -0
package/docs/module-SimpleLogger.html +238 -0
package/docs/scripts/app.min.js +1 -0
package/docs/scripts/linenumber.js +26 -0
package/docs/scripts/search.js +39 -0
package/docs/simple-logger.ts.html +303 -0
package/docs/styles/app.min.css +1 -0
package/docs/styles/iframe.css +13 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/docs/styles/reset.css +44 -0
package/jsdoc.json +14 -0
package/package.json +25 -0
package/src/__test__/simple-logger.test.ts +188 -0
package/src/index.ts +2 -0
package/src/simple-logger.ts +188 -0
package/tsconfig.json +23 -0

package/docs/module-SimpleLogger.html ADDED Viewed

@@ -0,0 +1,238 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> SimpleLogger</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-SimpleLogger.html">SimpleLogger</a></li></ul><h3>Classes</h3><ul><li><a href="module-SimpleLogger.SimpleLogger.html">SimpleLogger</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Module</p>
+                    <h1>SimpleLogger</h1>
+                </header>
+<section>
+<header>
+</header>
+<article>
+    <div class="container-overview">
+            <div class="description">A module for simple logging with various logging levels.</div>
+<dl class="details">
+        <p class="tag-source">
+            <a href="simple-logger.ts.html" class="button">View Source</a>
+            <span>
+                <a href="simple-logger.ts.html">simple-logger.ts</a>, <a href="simple-logger.ts.html#line2">line 2</a>
+            </span>
+        </p>
+</dl>
+    </div>
+        <h3 class="subsection-title">Classes</h3>
+        <dl>
+            <dt><a href="module-SimpleLogger.SimpleLogger.html">SimpleLogger</a></dt>
+            <dd></dd>
+        </dl>
+</article>
+</section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

package/docs/scripts/app.min.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";$().ready(function(){});var sidebarIsVisible=!1,toggleSidebar=function(e){var a=!(0<arguments.length&&void 0!==e)||e;$("#sidebarNav").toggleClass("sticky",a),$("#stickyNavbarOverlay").toggleClass("active",a),$("#hamburger").toggleClass("is-active"),sidebarIsVisible=a};$().ready(function(){$("#hamburger").click(function(){toggleSidebar(!sidebarIsVisible)}),$("#stickyNavbarOverlay").click(function(){sidebarIsVisible&&toggleSidebar(!1)})});var OFFSET=150;$().ready(function(){var o=$("#side-nav"),c=[];if($(".vertical-section").length||o.hide(),$(".vertical-section").each(function(e,a){var i=$(a),t=i.find("> h1").text();if(t){o.append($("<h3/>").text(t));var s=$("<ul></ul>");i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);s.append($("<li></li>").append(r)),c.push({link:r,offset:i.offset().top})}),o.append(s)}else i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);o.append(r),c.push({link:r,offset:i.offset().top})})}),!$.trim(o.text()))return o.hide();function e(){for(var e=n.scrollTop(),a=!1,i=c.length-1;0<=i;i--){var t=c[i];t.link.removeClass("is-active"),e+OFFSET>=t.offset?a?t.link.addClass("is-past"):(t.link.addClass("is-active"),a=!0):t.link.removeClass("is-past")}}var n=$("#main-content-wrapper");n.on("scroll",e),e(),c.forEach(function(e){e.link.click(function(){n.animate({scrollTop:e.offset-OFFSET+1},500)})})}),$().ready(function(){$("#sidebarNav a").each(function(e,a){var i=$(a).attr("href");window.location.pathname.match("/"+i)&&($(a).addClass("active"),$("#sidebarNav").scrollTop($(a).offset().top-150))})});

package/docs/scripts/linenumber.js ADDED Viewed

@@ -0,0 +1,26 @@
+/*global document */
+(function() {
+    var source = document.getElementsByClassName('prettyprint source linenums');
+    var i = 0;
+    var lineNumber = 0;
+    var lineId;
+    var lines;
+    var totalLines;
+    var anchorHash;
+    if (source && source[0]) {
+        anchorHash = document.location.hash.substring(1);
+        lines = source[0].getElementsByTagName('li');
+        totalLines = lines.length;
+        for (; i < totalLines; i++) {
+            lineNumber++;
+            lineId = 'line' + lineNumber;
+            lines[i].id = lineId;
+            if (lineId === anchorHash) {
+                lines[i].className += ' selected';
+            }
+        }
+    }
+})();

package/docs/scripts/search.js ADDED Viewed

@@ -0,0 +1,39 @@
+(function() {
+  const input = document.querySelector('#search')
+  const targets = [ ...document.querySelectorAll('#sidebarNav li')]
+  input.addEventListener('keyup', () => {
+    // loop over each targets and hide the not corresponding ones
+    targets.forEach(target => {
+      if (!target.innerText.toLowerCase().includes(input.value.toLowerCase())) {
+        target.style.display = 'none'
+        /**
+         * Detects an empty list
+         * Remove the list and the list's title if the list is not displayed
+         */
+        const list = [...target.parentNode.childNodes].filter( elem => elem.style.display !== 'none')
+        if (!list.length) {
+          target.parentNode.style.display = 'none'
+          target.parentNode.previousSibling.style.display = 'none'
+        }
+        /**
+         * Detects empty category
+         * Remove the entire category if no item is displayed
+         */
+        const category = [...target.parentNode.parentNode.childNodes]
+          .filter( elem => elem.tagName !== 'H2' && elem.style.display !== 'none')
+        if (!category.length) {
+          target.parentNode.parentNode.style.display = 'none'
+        }
+      } else {
+        target.parentNode.style.display = 'block'
+        target.parentNode.previousSibling.style.display = 'block'
+        target.parentNode.parentNode.style.display = 'block'
+        target.style.display = 'block'
+      }
+    })
+  })
+})()

package/docs/simple-logger.ts.html ADDED Viewed

@@ -0,0 +1,303 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> simple-logger.ts</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-SimpleLogger.html">SimpleLogger</a></li></ul><h3>Classes</h3><ul><li><a href="module-SimpleLogger.SimpleLogger.html">SimpleLogger</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>simple-logger.ts</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * A module for simple logging with various logging levels.
+ * @module SimpleLogger
+ */
+import { getCallerName } from 'vvlad1973-utils';
+export type ExternalLogger = {
+  trace?: LogFn;
+  debug?: LogFn;
+  info?: LogFn;
+  warn?: LogFn;
+  error?: LogFn;
+  fatal?: LogFn;
+  silent?: LogFn;
+  level?: string;
+};
+interface LogFn {
+  &lt;T extends object>(obj: T, msg?: string, ...args: any[]): void;
+  (obj: unknown, msg?: string, ...args: any[]): void;
+  (msg: string, ...args: any[]): void;
+}
+const loggerLevels = [
+  'trace',
+  'debug',
+  'info',
+  'warn',
+  'error',
+  'fatal',
+  'silent',
+] as const;
+type LoggerLevel = (typeof loggerLevels)[number];
+/**
+ * A simple logger class with various logging levels.
+ * @class
+ * @param {string} [level='info'] - Initial logging level.
+ * @param {ExternalLogger | undefined | null} [externalLogger=null] - Optional external logger to use.
+ */
+export class SimpleLogger {
+  #levels = loggerLevels;
+  #currentLevel: number = 2;
+  #logger: ExternalLogger | Console;
+  constructor(
+    level: LoggerLevel = 'info',
+    externalLogger: ExternalLogger | undefined | null = null
+  ) {
+    this.#logger =
+      externalLogger &amp;&amp; this.isValidLogger(externalLogger)
+        ? externalLogger
+        : (console as ExternalLogger);
+    this.setLevel(level);
+  }
+  trace: LogFn = (...args: any[]) => {};
+  debug: LogFn = (...args: any[]) => {};
+  info: LogFn = (...args: any[]) => {};
+  warn: LogFn = (...args: any[]) => {};
+  error: LogFn = (...args: any[]) => {};
+  fatal: LogFn = (...args: any[]) => {};
+  silent: LogFn = (...args: any[]) => {};
+  /**
+   * Updates the logging methods based on the current logging level.
+   * @private
+   */
+  private updateLoggingMethods() {
+    try {
+      const noop = (...args: any[]) => {};
+      this.trace =
+        this.#currentLevel &lt;= 0 ? this.getExternalLoggerMethod('trace') : noop;
+      this.debug =
+        this.#currentLevel &lt;= 1 ? this.getExternalLoggerMethod('debug') : noop;
+      this.info =
+        this.#currentLevel &lt;= 2 ? this.getExternalLoggerMethod('info') : noop;
+      this.warn =
+        this.#currentLevel &lt;= 3 ? this.getExternalLoggerMethod('warn') : noop;
+      this.error =
+        this.#currentLevel &lt;= 4 ? this.getExternalLoggerMethod('error') : noop;
+      this.fatal =
+        this.#currentLevel &lt;= 5
+          ? this.getExternalLoggerMethod('fatal', 'error')
+          : noop;
+      this.silent = noop;
+    } catch (error) {
+      console.error(error);
+    }
+  }
+  /**
+   * Checks if the provided logger is valid.
+   * @private
+   * @param {any} logger - The logger to check.
+   * @returns {boolean} - True if the logger is valid, otherwise false.
+   */
+  private isValidLogger(logger: any): boolean {
+    return loggerLevels.every((method) => {
+      return typeof logger[method] === 'function';
+    });
+  }
+  /**
+   * Gets the external logger method for a specific level.
+   * @param {string} method - The logger method to get.
+   * @param {string} [fallbackMethod] - The fallback logger method to get.
+   * @returns {LoggerMethod} - The logger method or a no-op function.
+   * @private
+   */
+  private getExternalLoggerMethod(
+    method: keyof ExternalLogger,
+    fallbackMethod?: keyof ExternalLogger
+  ): LogFn {
+    try {
+      const loggerMethod = (this.#logger as ExternalLogger)[method];
+      if (typeof loggerMethod === 'function') {
+        return loggerMethod.bind(this.#logger);
+      } else if (typeof fallbackMethod !== 'undefined') {
+        const fallbackLoggerMethod = (this.#logger as ExternalLogger)[
+          fallbackMethod
+        ];
+        if (typeof fallbackLoggerMethod === 'function') {
+          return fallbackLoggerMethod.bind(this.#logger);
+        }
+      }
+      return () => {};
+    } catch (error) {
+      console.error(error);
+      return () => {};
+    }
+  }
+  /**
+   * Sets the logging level.
+   * @param {string} level - The logging level to set.
+   */
+  public setLevel(level: string) {
+    const index = this.#levels.indexOf(level.toLowerCase() as LoggerLevel);
+    if (index !== -1) {
+      this.#currentLevel = index;
+      if (typeof (this.#logger as ExternalLogger).level === 'string') {
+        (this.#logger as ExternalLogger).level = level;
+      }
+      this.updateLoggingMethods();
+    }
+  }
+  /**
+   * Sets an external logger to be used.
+   * @param {ExternalLogger | undefined | null} logger - The external logger to set.
+   */
+  public setExternalLogger(logger: ExternalLogger | undefined | null) {
+    if (logger &amp;&amp; this.isValidLogger(logger)) {
+      this.#logger = logger;
+      // this.setLevel(this.#levels[this.#currentLevel]);
+      this.updateLoggingMethods();
+    } else if (!logger) {
+      this.#logger = console;
+      this.updateLoggingMethods();
+    }
+  }
+  /**
+   * Logs the start of a function.
+   * @param {string} [functionName] - Optional function name to log.
+   */
+  public logFunctionStart(functionName?: string) {
+    const callerName = functionName || getCallerName();
+    this.trace(`Function start: ${callerName}`);
+  }
+  /**
+   * Logs the end of a function.
+   * @param {string} [functionName] - Optional function name to log.
+   */
+  public logFunctionEnd(functionName?: string) {
+    const callerName = functionName || getCallerName();
+    this.trace(`Function end: ${callerName}`);
+  }
+}
+export default SimpleLogger;
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>