@skax/logger 0.1.0 → 1.0.0

package/README.md

@@ -11,5 +11,11 @@ yarn add @skax/logger
 ```ts
 import Logger from '@skax/logger';
 
-Logger.v('console.log print');
+const logger = new Logger();
+
+logger.d('console.log print'); // debug
+logger.v('console.log print'); // log
+logger.i('console.log print'); // info
+logger.w('console.log print'); // warn
+logger.e('console.log print'); // error
 ```

package/index.js

@@ -1,165 +1,114 @@
 /*
 *
-* @skax/logger.js v0.1.0
-* Copyright (c) 2023-7-15 ShineShao <xiaoshaoqq@gmail.com>
+* @skax/logger.js v1.0.0
+* Copyright (c) 2023-9-19 ShineShao <xiaoshaoqq@gmail.com>
 * Released under the MIT License.
 *
 */
 'use strict';
 
-function __spreadArray(to, from, pack) {
-  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-    if (ar || !(i in from)) {
-      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-      ar[i] = from[i];
-    }
-  }
-  return to.concat(ar || Array.prototype.slice.call(from));
-}
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-  var e = new Error(message);
-  return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 /**
- * @class Logger class
+ * @class Logger
  * @classdesc Provide multiple log printing methods
+ * @example
+ * const logger = new Logger({})
+ * logger.v("verbose log")
  */
 var Logger = /** @class */ (function () {
-    function Logger() {
+    function Logger(options) {
+        if (options === void 0) { options = {}; }
+        this._options = {};
+        this._levelNum = 0;
+        /**
+         * @description  Method used to print error logs
+         * @static
+         *
+         * @example
+         * logger.e("error message") // error message
+         *
+         * @param {...any[]} args error messages
+         * @returns {void}
+         */
+        this.e = this._loggerFactory('error', this._levelNum <= 4);
+        /**
+         * @description Method used to print warn logs
+         * @static
+         *
+         * @example
+         * logger.w("warn message") // warn message
+         *
+         * @param {...any[]} args warn messages
+         * @returns {void}
+         */
+        this.w = this._loggerFactory('warn', this._levelNum <= 3);
+        /**
+         * @description Method used to print info logs
+         * @static
+         *
+         * @example
+         * logger.i("info message") // info message
+         *
+         * @param {...any[]} args info messages
+         * @returns {void}
+         */
+        this.i = this._loggerFactory('info', this._levelNum <= 2);
+        /**
+         * @description Method used to print verbose logs
+         * @static
+         *
+         * @example
+         * logger.v("verbose message") // verbose message
+         *
+         * @param {...any[]} args verbose messages
+         * @returns {void}
+         */
+        this.v = this._loggerFactory('log', this._levelNum <= 1);
+        /**
+         * @description Method used to print debug logs
+         * @static
+         *
+         * @example
+         * logger.d("debug message") // debug message
+         *
+         * @param {...any[]} msg debug messages
+         * @returns {void}
+         */
+        this.d = this._loggerFactory('debug', this._levelNum < 1);
+        this.setOptions(options);
     }
     /**
-     * @description Static method used to print error logs
-     * @static
-     *
-     * @example
-     * Logger.e("error message") // [LOGGER ERROR] > error message
-     *
-     * @param {...any[]} args error messages
-     * @returns {void}
-     */
-    Logger.e = function () {
-        var arguments$1 = arguments;
-
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments$1[_i];
-        }
-        if (Logger.LOGGER_LEVEL <= 4)
-            { Logger.HIDE_TAG
-                ? console.error.apply(console, args) : console.error.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " ERROR]"), 'background: red; color: #fff'], args, false)); }
-    };
-    /**
-     * @description Static method used to print warn logs
-     * @static
-     *
-     * @example
-     * Logger.w("warn message") // [LOGGER WARN] > warn message
-     *
-     * @param {...any[]} args warn messages
-     * @returns {void}
-     */
-    Logger.w = function () {
-        var arguments$1 = arguments;
-
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments$1[_i];
-        }
-        if (Logger.LOGGER_LEVEL <= 3)
-            { Logger.HIDE_TAG
-                ? console.warn.apply(console, args) : console.warn.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " WARN]"), 'background: #faad14; color: #fff'], args, false)); }
-    };
-    /**
-     * @description Static method used to print info logs
-     * @static
-     *
-     * @example
-     * Logger.i("info message") // [LOGGER INFO] > info message
-     *
-     * @param {...any[]} args info messages
-     * @returns {void}
-     */
-    Logger.i = function () {
-        var arguments$1 = arguments;
-
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments$1[_i];
-        }
-        if (Logger.LOGGER_LEVEL <= 2)
-            { Logger.HIDE_TAG
-                ? console.info.apply(console, args) : console.info.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " INFO]"), 'background: #ffe58f; color: #fff'], args, false)); }
-    };
-    /**
-     * @description Static method used to print verbose logs
-     * @static
-     *
-     * @example
-     * Logger.v("verbose message") // [LOGGER VERBOSE] > verbose message
-     *
-     * @param {...any[]} args verbose messages
-     * @returns {void}
-     */
-    Logger.v = function () {
-        var arguments$1 = arguments;
-
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments$1[_i];
-        }
-        if (Logger.LOGGER_LEVEL <= 1)
-            { Logger.HIDE_TAG ? console.log.apply(console, args) : console.log.apply(console, __spreadArray(["[".concat(Logger.TAG, " VERBOSE]")], args, false)); }
-    };
-    /**
-     * @description Static method used to print debug logs
-     * @static
-     *
-     * @example
-     * Logger.d("debug message") // [LOGGER DEBUG] > debug message
-     * Logger.d("debug message", "DEBUG") // [DEBUG] > debug message
-     *
-     * @param {...any[]} msg debug messages
-     * @returns {void}
-     */
-    Logger.d = function () {
-        var arguments$1 = arguments;
-
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments$1[_i];
-        }
-        if (Logger.LOGGER_LEVEL < 1) {
-            Logger.HIDE_TAG
-                ? console.log.apply(console, args) : console.log.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " DEBUG]"), 'background: #1677ff; color: #fff'], args, false));
-        }
-    };
-    /**
-     * @description Static method used to set logger option
+     * @description  Method used to set logger option and change logger level
      * @static
      *
      * @example
-     * Logger.setOptions({level: 'INFO'}) // set logger level
+     * logger.setOptions({level: 'INFO'}) // set logger level
      *
      * @param {LoggerOptions} options logger options
      * @return {void}
      */
-    Logger.setOptions = function (options) {
-        Logger.LOGGER_LEVEL = Logger._matchLevel(options.level);
-        Logger.HIDE_TAG = !!options.hideTag;
+    Logger.prototype.setOptions = function (options) {
+        this._options = options;
+        this._levelNum = this._matchLevel(options.level || 'DEBUG');
+        if (this._levelNum !== 0) {
+            this.e = this._loggerFactory('error', this._levelNum <= 4);
+            this.w = this._loggerFactory('warn', this._levelNum <= 3);
+            this.i = this._loggerFactory('info', this._levelNum <= 2);
+            this.v = this._loggerFactory('warn', this._levelNum <= 1);
+            this.d = this._loggerFactory('warn', this._levelNum < 1);
+        }
     };
     /**
-     * @description Static method used to match logger level
+     * @description Private method used to match logger level
      * @static
      * @private
      *
      * @example
-     * Logger._matchLevel("DEBUG") // 0
+     * this._matchLevel("DEBUG") // 0
      *
      * @param {LoggerLevel} level logger level
      * @return {number}
      */
-    Logger._matchLevel = function (level) {
+    Logger.prototype._matchLevel = function (level) {
         var logLevel = 0;
         switch (level) {
             case 'DEBUG':
@@ -180,10 +129,35 @@ var Logger = /** @class */ (function () {
         }
         return logLevel;
     };
-    Logger.TAG = 'LOGGER';
-    // log level default 0,
-    Logger.LOGGER_LEVEL = 0;
-    Logger.HIDE_TAG = false;
+    /**
+     * @private
+     * @description Logger factory
+     * @param type
+     * @param bool
+     * @returns
+     */
+    Logger.prototype._loggerFactory = function (type, bool) {
+        var func = console[type];
+        if (bool && func) {
+            return func.bind(console, "[".concat(type.toLocaleUpperCase(), "]"));
+        }
+        return Logger.noop;
+    };
+    /**
+     * @description Get options
+     * @returns {LoggerOptions}
+     */
+    Logger.prototype.getOptions = function () {
+        return this._options;
+    };
+    /**
+     * @description Get version
+     * @returns {string}
+     */
+    Logger.prototype.version = function () {
+        return '1.0.0';
+    };
+    Logger.noop = function () { };
     return Logger;
 }());
 

package/index.umd.js

@@ -1,7 +1,7 @@
 /*
 *
-* @skax/logger.js v0.1.0
-* Copyright (c) 2023-7-15 ShineShao <xiaoshaoqq@gmail.com>
+* @skax/logger.js v1.0.0
+* Copyright (c) 2023-9-19 ShineShao <xiaoshaoqq@gmail.com>
 * Released under the MIT License.
 *
 */
@@ -11,159 +11,108 @@
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.Logger = factory());
 })(this, (function () { 'use strict';
 
-    function __spreadArray(to, from, pack) {
-      if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-          if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-          ar[i] = from[i];
-        }
-      }
-      return to.concat(ar || Array.prototype.slice.call(from));
-    }
-    typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-      var e = new Error(message);
-      return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-    };
-
     /**
-     * @class Logger class
+     * @class Logger
      * @classdesc Provide multiple log printing methods
+     * @example
+     * const logger = new Logger({})
+     * logger.v("verbose log")
      */
     var Logger = /** @class */ (function () {
-        function Logger() {
+        function Logger(options) {
+            if (options === void 0) { options = {}; }
+            this._options = {};
+            this._levelNum = 0;
+            /**
+             * @description  Method used to print error logs
+             * @static
+             *
+             * @example
+             * logger.e("error message") // error message
+             *
+             * @param {...any[]} args error messages
+             * @returns {void}
+             */
+            this.e = this._loggerFactory('error', this._levelNum <= 4);
+            /**
+             * @description Method used to print warn logs
+             * @static
+             *
+             * @example
+             * logger.w("warn message") // warn message
+             *
+             * @param {...any[]} args warn messages
+             * @returns {void}
+             */
+            this.w = this._loggerFactory('warn', this._levelNum <= 3);
+            /**
+             * @description Method used to print info logs
+             * @static
+             *
+             * @example
+             * logger.i("info message") // info message
+             *
+             * @param {...any[]} args info messages
+             * @returns {void}
+             */
+            this.i = this._loggerFactory('info', this._levelNum <= 2);
+            /**
+             * @description Method used to print verbose logs
+             * @static
+             *
+             * @example
+             * logger.v("verbose message") // verbose message
+             *
+             * @param {...any[]} args verbose messages
+             * @returns {void}
+             */
+            this.v = this._loggerFactory('log', this._levelNum <= 1);
+            /**
+             * @description Method used to print debug logs
+             * @static
+             *
+             * @example
+             * logger.d("debug message") // debug message
+             *
+             * @param {...any[]} msg debug messages
+             * @returns {void}
+             */
+            this.d = this._loggerFactory('debug', this._levelNum < 1);
+            this.setOptions(options);
         }
         /**
-         * @description Static method used to print error logs
-         * @static
-         *
-         * @example
-         * Logger.e("error message") // [LOGGER ERROR] > error message
-         *
-         * @param {...any[]} args error messages
-         * @returns {void}
-         */
-        Logger.e = function () {
-            var arguments$1 = arguments;
-
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments$1[_i];
-            }
-            if (Logger.LOGGER_LEVEL <= 4)
-                { Logger.HIDE_TAG
-                    ? console.error.apply(console, args) : console.error.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " ERROR]"), 'background: red; color: #fff'], args, false)); }
-        };
-        /**
-         * @description Static method used to print warn logs
-         * @static
-         *
-         * @example
-         * Logger.w("warn message") // [LOGGER WARN] > warn message
-         *
-         * @param {...any[]} args warn messages
-         * @returns {void}
-         */
-        Logger.w = function () {
-            var arguments$1 = arguments;
-
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments$1[_i];
-            }
-            if (Logger.LOGGER_LEVEL <= 3)
-                { Logger.HIDE_TAG
-                    ? console.warn.apply(console, args) : console.warn.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " WARN]"), 'background: #faad14; color: #fff'], args, false)); }
-        };
-        /**
-         * @description Static method used to print info logs
-         * @static
-         *
-         * @example
-         * Logger.i("info message") // [LOGGER INFO] > info message
-         *
-         * @param {...any[]} args info messages
-         * @returns {void}
-         */
-        Logger.i = function () {
-            var arguments$1 = arguments;
-
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments$1[_i];
-            }
-            if (Logger.LOGGER_LEVEL <= 2)
-                { Logger.HIDE_TAG
-                    ? console.info.apply(console, args) : console.info.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " INFO]"), 'background: #ffe58f; color: #fff'], args, false)); }
-        };
-        /**
-         * @description Static method used to print verbose logs
-         * @static
-         *
-         * @example
-         * Logger.v("verbose message") // [LOGGER VERBOSE] > verbose message
-         *
-         * @param {...any[]} args verbose messages
-         * @returns {void}
-         */
-        Logger.v = function () {
-            var arguments$1 = arguments;
-
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments$1[_i];
-            }
-            if (Logger.LOGGER_LEVEL <= 1)
-                { Logger.HIDE_TAG ? console.log.apply(console, args) : console.log.apply(console, __spreadArray(["[".concat(Logger.TAG, " VERBOSE]")], args, false)); }
-        };
-        /**
-         * @description Static method used to print debug logs
-         * @static
-         *
-         * @example
-         * Logger.d("debug message") // [LOGGER DEBUG] > debug message
-         * Logger.d("debug message", "DEBUG") // [DEBUG] > debug message
-         *
-         * @param {...any[]} msg debug messages
-         * @returns {void}
-         */
-        Logger.d = function () {
-            var arguments$1 = arguments;
-
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments$1[_i];
-            }
-            if (Logger.LOGGER_LEVEL < 1) {
-                Logger.HIDE_TAG
-                    ? console.log.apply(console, args) : console.log.apply(console, __spreadArray(["%c[".concat(Logger.TAG, " DEBUG]"), 'background: #1677ff; color: #fff'], args, false));
-            }
-        };
-        /**
-         * @description Static method used to set logger option
+         * @description  Method used to set logger option and change logger level
          * @static
          *
          * @example
-         * Logger.setOptions({level: 'INFO'}) // set logger level
+         * logger.setOptions({level: 'INFO'}) // set logger level
          *
          * @param {LoggerOptions} options logger options
          * @return {void}
          */
-        Logger.setOptions = function (options) {
-            Logger.LOGGER_LEVEL = Logger._matchLevel(options.level);
-            Logger.HIDE_TAG = !!options.hideTag;
+        Logger.prototype.setOptions = function (options) {
+            this._options = options;
+            this._levelNum = this._matchLevel(options.level || 'DEBUG');
+            if (this._levelNum !== 0) {
+                this.e = this._loggerFactory('error', this._levelNum <= 4);
+                this.w = this._loggerFactory('warn', this._levelNum <= 3);
+                this.i = this._loggerFactory('info', this._levelNum <= 2);
+                this.v = this._loggerFactory('warn', this._levelNum <= 1);
+                this.d = this._loggerFactory('warn', this._levelNum < 1);
+            }
         };
         /**
-         * @description Static method used to match logger level
+         * @description Private method used to match logger level
          * @static
          * @private
          *
          * @example
-         * Logger._matchLevel("DEBUG") // 0
+         * this._matchLevel("DEBUG") // 0
          *
          * @param {LoggerLevel} level logger level
          * @return {number}
          */
-        Logger._matchLevel = function (level) {
+        Logger.prototype._matchLevel = function (level) {
             var logLevel = 0;
             switch (level) {
                 case 'DEBUG':
@@ -184,10 +133,35 @@
             }
             return logLevel;
         };
-        Logger.TAG = 'LOGGER';
-        // log level default 0,
-        Logger.LOGGER_LEVEL = 0;
-        Logger.HIDE_TAG = false;
+        /**
+         * @private
+         * @description Logger factory
+         * @param type
+         * @param bool
+         * @returns
+         */
+        Logger.prototype._loggerFactory = function (type, bool) {
+            var func = console[type];
+            if (bool && func) {
+                return func.bind(console, "[".concat(type.toLocaleUpperCase(), "]"));
+            }
+            return Logger.noop;
+        };
+        /**
+         * @description Get options
+         * @returns {LoggerOptions}
+         */
+        Logger.prototype.getOptions = function () {
+            return this._options;
+        };
+        /**
+         * @description Get version
+         * @returns {string}
+         */
+        Logger.prototype.version = function () {
+            return '1.0.0';
+        };
+        Logger.noop = function () { };
         return Logger;
     }());
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@skax/logger",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "console logger",
   "main": "index.js",
-  "umd": "dist/index.umd.js",
+  "umd": "index.umd.js",
   "types": "types/index.d.ts",
   "repository": {
     "type": "git",
@@ -20,6 +20,6 @@
   },
   "homepage": "https://github.com/freeshineit/skax-logger#readme",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   }
 }

package/types/index.d.ts

@@ -4,95 +4,114 @@ export type LoggerLevel = 'DEBUG' | 'VERBOSE' | 'INFO' | 'WARN' | 'ERROR';
 export interface LoggerOptions {
     /** logger level */
     level?: LoggerLevel;
-    /** hidden tag prefix */
-    hideTag?: boolean;
 }
 /**
- * @class Logger class
+ * @class Logger
  * @classdesc Provide multiple log printing methods
+ * @example
+ * const logger = new Logger({})
+ * logger.v("verbose log")
  */
 declare class Logger {
-    private static readonly TAG;
-    private static LOGGER_LEVEL;
-    private static HIDE_TAG;
+    private static readonly noop;
+    private _options;
+    private _levelNum;
+    constructor(options?: LoggerOptions);
     /**
-     * @description Static method used to print error logs
+     * @description  Method used to print error logs
      * @static
      *
      * @example
-     * Logger.e("error message") // [LOGGER ERROR] > error message
+     * logger.e("error message") // error message
      *
      * @param {...any[]} args error messages
      * @returns {void}
      */
-    static e(...args: any[]): void;
+    e: any;
     /**
-     * @description Static method used to print warn logs
+     * @description Method used to print warn logs
      * @static
      *
      * @example
-     * Logger.w("warn message") // [LOGGER WARN] > warn message
+     * logger.w("warn message") // warn message
      *
      * @param {...any[]} args warn messages
      * @returns {void}
      */
-    static w(...args: any[]): void;
+    w: any;
     /**
-     * @description Static method used to print info logs
+     * @description Method used to print info logs
      * @static
      *
      * @example
-     * Logger.i("info message") // [LOGGER INFO] > info message
+     * logger.i("info message") // info message
      *
      * @param {...any[]} args info messages
      * @returns {void}
      */
-    static i(...args: any[]): void;
+    i: any;
     /**
-     * @description Static method used to print verbose logs
+     * @description Method used to print verbose logs
      * @static
      *
      * @example
-     * Logger.v("verbose message") // [LOGGER VERBOSE] > verbose message
+     * logger.v("verbose message") // verbose message
      *
      * @param {...any[]} args verbose messages
      * @returns {void}
      */
-    static v(...args: any[]): void;
+    v: any;
     /**
-     * @description Static method used to print debug logs
+     * @description Method used to print debug logs
      * @static
      *
      * @example
-     * Logger.d("debug message") // [LOGGER DEBUG] > debug message
-     * Logger.d("debug message", "DEBUG") // [DEBUG] > debug message
+     * logger.d("debug message") // debug message
      *
      * @param {...any[]} msg debug messages
      * @returns {void}
      */
-    static d(...args: any[]): void;
+    d: any;
     /**
-     * @description Static method used to set logger option
+     * @description  Method used to set logger option and change logger level
      * @static
      *
      * @example
-     * Logger.setOptions({level: 'INFO'}) // set logger level
+     * logger.setOptions({level: 'INFO'}) // set logger level
      *
      * @param {LoggerOptions} options logger options
      * @return {void}
      */
-    static setOptions(options: LoggerOptions): void;
+    setOptions(options: Partial<LoggerOptions>): void;
     /**
-     * @description Static method used to match logger level
+     * @description Private method used to match logger level
      * @static
      * @private
      *
      * @example
-     * Logger._matchLevel("DEBUG") // 0
+     * this._matchLevel("DEBUG") // 0
      *
      * @param {LoggerLevel} level logger level
      * @return {number}
      */
-    private static _matchLevel;
+    private _matchLevel;
+    /**
+     * @private
+     * @description Logger factory
+     * @param type
+     * @param bool
+     * @returns
+     */
+    private _loggerFactory;
+    /**
+     * @description Get options
+     * @returns {LoggerOptions}
+     */
+    getOptions(): Partial<LoggerOptions>;
+    /**
+     * @description Get version
+     * @returns {string}
+     */
+    version(): string;
 }
 export default Logger;