@skax/logger 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Shine Shao
+
+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 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

@@ -0,0 +1,15 @@
+## @skax/logger
+
+![build](https://github.com/freeshineit/skax-logger/workflows/build/badge.svg) ![Download](https://img.shields.io/npm/dm/@skax/logger.svg) ![Version](https://img.shields.io/npm/v/@skax/logger.svg) ![License](https://img.shields.io/npm/l/@skax/logger.svg)
+
+### Usage
+
+```sh
+yarn add @skax/logger
+```
+
+```ts
+import Logger from '@skax/logger';
+
+Logger.v('console.log print');
+```

package/index.js

@@ -0,0 +1,190 @@
+/*
+*
+* @skax/logger.js v0.1.0
+* Copyright (c) 2023-7-15 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
+ * @classdesc Provide multiple log printing methods
+ */
+var Logger = /** @class */ (function () {
+    function Logger() {
+    }
+    /**
+     * @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
+     * @static
+     *
+     * @example
+     * 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;
+    };
+    /**
+     * @description Static method used to match logger level
+     * @static
+     * @private
+     *
+     * @example
+     * Logger._matchLevel("DEBUG") // 0
+     *
+     * @param {LoggerLevel} level logger level
+     * @return {number}
+     */
+    Logger._matchLevel = function (level) {
+        var logLevel = 0;
+        switch (level) {
+            case 'DEBUG':
+                logLevel = 0;
+                break;
+            case 'VERBOSE':
+                logLevel = 1;
+                break;
+            case 'INFO':
+                logLevel = 2;
+                break;
+            case 'WARN':
+                logLevel = 3;
+                break;
+            case 'ERROR':
+                logLevel = 4;
+                break;
+        }
+        return logLevel;
+    };
+    Logger.TAG = 'LOGGER';
+    // log level default 0,
+    Logger.LOGGER_LEVEL = 0;
+    Logger.HIDE_TAG = false;
+    return Logger;
+}());
+
+module.exports = Logger;

package/index.umd.js

@@ -0,0 +1,196 @@
+/*
+*
+* @skax/logger.js v0.1.0
+* Copyright (c) 2023-7-15 ShineShao <xiaoshaoqq@gmail.com>
+* Released under the MIT License.
+*
+*/
+(function (global, factory) {
+    typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+    typeof define === 'function' && define.amd ? define(factory) :
+    (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
+     * @classdesc Provide multiple log printing methods
+     */
+    var Logger = /** @class */ (function () {
+        function Logger() {
+        }
+        /**
+         * @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
+         * @static
+         *
+         * @example
+         * 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;
+        };
+        /**
+         * @description Static method used to match logger level
+         * @static
+         * @private
+         *
+         * @example
+         * Logger._matchLevel("DEBUG") // 0
+         *
+         * @param {LoggerLevel} level logger level
+         * @return {number}
+         */
+        Logger._matchLevel = function (level) {
+            var logLevel = 0;
+            switch (level) {
+                case 'DEBUG':
+                    logLevel = 0;
+                    break;
+                case 'VERBOSE':
+                    logLevel = 1;
+                    break;
+                case 'INFO':
+                    logLevel = 2;
+                    break;
+                case 'WARN':
+                    logLevel = 3;
+                    break;
+                case 'ERROR':
+                    logLevel = 4;
+                    break;
+            }
+            return logLevel;
+        };
+        Logger.TAG = 'LOGGER';
+        // log level default 0,
+        Logger.LOGGER_LEVEL = 0;
+        Logger.HIDE_TAG = false;
+        return Logger;
+    }());
+
+    return Logger;
+
+}));

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@skax/logger",
+  "version": "0.1.0",
+  "description": "console logger",
+  "main": "index.js",
+  "umd": "dist/index.umd.js",
+  "types": "types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/freeshineit/skax-logger.git"
+  },
+  "keywords": [
+    "logger",
+    "console"
+  ],
+  "author": "ShineShao <xiaoshaoqq@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/freeshineit/skax-logger/issues"
+  },
+  "homepage": "https://github.com/freeshineit/skax-logger#readme",
+  "engines": {
+    "node": ">=14"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,98 @@
+/** logger level */
+export type LoggerLevel = 'DEBUG' | 'VERBOSE' | 'INFO' | 'WARN' | 'ERROR';
+/** logger options */
+export interface LoggerOptions {
+    /** logger level */
+    level?: LoggerLevel;
+    /** hidden tag prefix */
+    hideTag?: boolean;
+}
+/**
+ * @class Logger class
+ * @classdesc Provide multiple log printing methods
+ */
+declare class Logger {
+    private static readonly TAG;
+    private static LOGGER_LEVEL;
+    private static HIDE_TAG;
+    /**
+     * @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}
+     */
+    static e(...args: any[]): void;
+    /**
+     * @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}
+     */
+    static w(...args: any[]): void;
+    /**
+     * @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}
+     */
+    static i(...args: any[]): void;
+    /**
+     * @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}
+     */
+    static v(...args: any[]): void;
+    /**
+     * @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}
+     */
+    static d(...args: any[]): void;
+    /**
+     * @description Static method used to set logger option
+     * @static
+     *
+     * @example
+     * Logger.setOptions({level: 'INFO'}) // set logger level
+     *
+     * @param {LoggerOptions} options logger options
+     * @return {void}
+     */
+    static setOptions(options: LoggerOptions): void;
+    /**
+     * @description Static method used to match logger level
+     * @static
+     * @private
+     *
+     * @example
+     * Logger._matchLevel("DEBUG") // 0
+     *
+     * @param {LoggerLevel} level logger level
+     * @return {number}
+     */
+    private static _matchLevel;
+}
+export default Logger;