@voliware/logger - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "@voliware/logger",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A tiny Javascript logger with levels and several options. Supports Node and all modern Browsers",
@@ -10,3 +10,4 @@ "main": "index.js",
   "scripts": {
-    "test": "mocha"
+    "test": "mocha",
+    "build": "build.js"
   },
@@ -29,5 +30,6 @@ "repository": {
   "devDependencies": {
-    "mocha": "^6.1.4"
+    "mocha": "^6.1.4",
+    "uglify-es": "^3.3.9"
   },
   "dependencies": {}
 }

src/logger.js

@@ -6,281 +6,281 @@ /**
  * let logger = new Logger("User", {
-    *     level: Logger.level.debug,
-    *     timestamp: {
-    *         state: true,
-    *         format: Logger.timestamp.local    
-    *     }
-    * });
-    * logger.debug("Logged in"); // [7/1/2019, 10:43:26 AM] [DBG] [User] Logged in
-    * 
-    * @example - create a logger as part of an object "Foo"
-    * this.logger = new Logger("App", {
-    *     level: Logger.level.info,
-    *     timestamp: {state: false}
-    *     context: this
-    * });
-    * logger.info("Initialized"); // [INF] [App] [Foo] Initialized
-    * 
-    * @example - when logging an object, the object itself is passed to console.log()
-    * logger.info({name: "Test", count: 100}); // [INF] [App] logging object
-    *                                          // {name:"Test", count:100}
+ *     level: Logger.level.debug,
+ *     timestamp: {
+ *         state: true,
+ *         format: Logger.timestamp.local    
+ *     }
+ * });
+ * logger.debug("Logged in"); // [7/1/2019, 10:43:26 AM] [DBG] [User] Logged in
+ * 
+ * @example - create a logger as part of an object "Foo"
+ * this.logger = new Logger("App", {
+ *     level: Logger.level.info,
+ *     timestamp: {state: false}
+ *     context: this
+ * });
+ * logger.info("Initialized"); // [INF] [App] [Foo] Initialized
+ * 
+ * @example - when logging an object, the object itself is passed to console.log()
+ * logger.info({name: "Test", count: 100}); // [INF] [App] logging object
+ *                                          // {name:"Test", count:100}
+ */
+class Logger {
+
+    /**
+    * Constructor
+    * @param {string} name - name of the logger
+    * @param {object} options 
+    * @param {number} options.level - starting log level
+    * @param {object} options.timestamp - timestamp options
+    * @param {boolean} options.timestamp.state - whether to print timestamps
+    * @param {number} options.timestamp.format - timestamp format
+    * @param {string} options.context - optional context prepended before logger name
+    * @return {Logger}
     */
-    class Logger {
-    
-        /**
-        * Constructor
-        * @param {string} name - name of the logger
-        * @param {object} options 
-        * @param {number} options.level - starting log level
-        * @param {object} options.timestamp - timestamp options
-        * @param {boolean} options.timestamp.state - whether to print timestamps
-        * @param {number} options.timestamp.format - timestamp format
-        * @param {string} options.context - optional context prepended before logger name
-        * @return {Logger}
-        */
-        constructor(name, options = {}){
-            this.name = name;
-            this.options = {
-                level: Logger.level.info,
-                timestamp: {
-                    state: false,
-                    format: Logger.timestamp.locale
-                },
-                context: null
-            };
-            Object.assign(this.options, options);
-    
-            this.setTimestampFormat(this.options.timestamp.format);
-    
-            return this;
+    constructor(name, options = {}){
+        this.name = name;
+        this.options = {
+            level: Logger.level.info,
+            timestamp: {
+                state: false,
+                format: Logger.timestamp.locale
+            },
+            context: null
+        };
+        Object.assign(this.options, options);
+
+        this.setTimestampFormat(this.options.timestamp.format);
+
+        return this;
+    }
+
+    /**
+    * Set the logger context. 
+    * This could be set when printing logs from
+    * a specific object, for example, to indicate
+    * which object the logger is found in (aka its context).
+    * @param {string} context 
+    * @return {Logger}
+    */
+    setContext(context){
+        this.options.context = context;
+        return this;
+    }
+
+    /**
+    * Set the log level.
+    * This will immediately change the logger's log level.
+    * @param {number} level 
+    * @return {Logger}
+    */
+    setLogLevel(level){
+        this.options.level = level;
+        return this;
+    }
+
+    /**
+    * Set any timestamp options
+    * @param {object} options
+    * @param {boolean} options.state - whether to print timestamps
+    * @param {number} options.format - timestamp format
+    * @return {Logger}
+    */
+    setTimestamp(options){
+        this.options.timestamp = options;
+        this.setTimestampFormat(this.options.timestamp.format);
+        return this;
+    }
+
+    /**
+    * Set the timestamp format
+    * @param {number} format 
+    * @return {Logger}
+    */
+    setTimestampFormat(format){
+        switch(format){
+            case Logger.timestamp.utc:
+                this.appendTimestamp = this.appendUtcTimestamp;
+                break;
+            case Logger.timestamp.localedate:
+                this.appendTimestamp = this.appendLocaleDateTimestamp
+                break;
+            case Logger.timestamp.localetime:
+                this.appendTimestamp = this.appendLocaleTimeTimestamp
+                break;
+            case Logger.timestamp.locale:
+            default:
+                this.appendTimestamp = this.appendLocaleTimestamp;
+                break;
         }
-    
-        /**
-        * Set the logger context. 
-        * This could be set when printing logs from
-        * a specific object, for example, to indicate
-        * which object the logger is found in (aka its context).
-        * @param {string} context 
-        * @return {Logger}
-        */
-        setContext(context){
-            this.options.context = context;
-            return this;
+        return this;
+    }
+
+    /**
+    * Set a custom timestamp format.
+    * @param {function} func - function that outputs a timestamp string
+    * @return {Logger}
+    */
+    setCustomTimestampFormat(func){
+        this.appendTimestamp = func;
+        return this;
+    }
+
+    /**
+    * Append a UTC timestamp.
+    * eg "Mon, 01 Jul 2019 14:43:35 GMT"
+    * @return {Logger}
+    */
+    appendUtcTimestamp(){
+        return `[${(new Date().toUTCString())}] `;
+    }
+
+    /**
+    * Append a locale timestamp.
+    * eg "7/1/2019, 10:43:26 AM"
+    * @return {Logger}
+    */
+    appendLocaleTimestamp(){
+        return `[${(new Date().toLocaleString())}] `;
+    }
+
+    /**
+    * Append a UTC timestamp.
+    * eg "10:43:06 AM"
+    * @return {Logger}
+    */
+    appendLocaleTimeTimestamp(){
+        return `[${(new Date().toLocaleTimeString())}] `;
+    }
+
+    /**
+    * Append a locale date timestamp.
+    * eg "7/1/2019"
+    * @return {Logger}
+    */
+    appendLocaleDateTimestamp(){
+        return `[${(new Date().toLocaleDateString())}] `;
+    }
+
+    /**
+    * Create a log message.
+    * @param {string} message - message to log
+    * @param {number} [level=this.options.level] - log level; current level by default
+    * @return {Logger}
+    */
+    createMessage(message, level = this.options.level){
+        if(level < this.options.level){
+            return;
         }
-    
-        /**
-        * Set the log level.
-        * This will immediately change the logger's log level.
-        * @param {number} level 
-        * @return {Logger}
-        */
-        setLogLevel(level){
-            this.options.level = level;
-            return this;
+
+        let msg = "";
+        if(this.options.timestamp.state){
+            msg += this.appendTimestamp();
         }
-    
-        /**
-        * Set any timestamp options
-        * @param {object} options
-        * @param {boolean} options.state - whether to print timestamps
-        * @param {number} options.format - timestamp format
-        * @return {Logger}
-        */
-        setTimestamp(options){
-            this.options.timestamp = options;
-            this.setTimestampFormat(this.options.timestamp.format);
-            return this;
+
+        msg += `[${Logger.level.string[level]}] `;
+        msg += `[${this.name}] `;
+
+        if(this.options.context){
+            msg += `[${this.options.context}] `;
         }
-    
-        /**
-        * Set the timestamp format
-        * @param {number} format 
-        * @return {Logger}
-        */
-        setTimestampFormat(format){
-            switch(format){
-                case Logger.timestamp.utc:
-                    this.appendTimestamp = this.appendUtcTimestamp;
-                    break;
-                case Logger.timestamp.localedate:
-                    this.appendTimestamp = this.appendLocaleDateTimestamp
-                    break;
-                case Logger.timestamp.localetime:
-                    this.appendTimestamp = this.appendLocaleTimeTimestamp
-                    break;
-                case Logger.timestamp.locale:
-                default:
-                    this.appendTimestamp = this.appendLocaleTimestamp;
-                    break;
-            }
-            return this;
+
+        if(typeof message === "string"){
+            msg += message;
         }
-    
-        /**
-        * Set a custom timestamp format.
-        * @param {function} func - function that outputs a timestamp string
-        * @return {Logger}
-        */
-        setCustomTimestampFormat(func){
-            this.appendTimestamp = func;
-            return this;
+        else {
+            msg += "logging object";
         }
-    
-        /**
-        * Append a UTC timestamp.
-        * eg "Mon, 01 Jul 2019 14:43:35 GMT"
-        * @return {Logger}
-        */
-        appendUtcTimestamp(){
-            return `[${(new Date().toUTCString())}] `;
+
+        return msg;
+    }
+
+    /**
+    * Log a message.
+    * @param {string} message - message to log
+    * @param {number} [level=this.options.level] - log level; current level by default
+    * @return {Logger}
+    */
+    log(message, level = this.options.level){
+        let msg = this.createMessage(message, level);
+
+        if(typeof message === "string"){
+            console.log(msg);
         }
-    
-        /**
-        * Append a locale timestamp.
-        * eg "7/1/2019, 10:43:26 AM"
-        * @return {Logger}
-        */
-        appendLocaleTimestamp(){
-            return `[${(new Date().toLocaleString())}] `;
+        else {
+            console.log(msg);
+            console.log(message);
         }
-    
-        /**
-        * Append a UTC timestamp.
-        * eg "10:43:06 AM"
-        * @return {Logger}
-        */
-        appendLocaleTimeTimestamp(){
-            return `[${(new Date().toLocaleTimeString())}] `;
-        }
-    
-        /**
-        * Append a locale date timestamp.
-        * eg "7/1/2019"
-        * @return {Logger}
-        */
-        appendLocaleDateTimestamp(){
-            return `[${(new Date().toLocaleDateString())}] `;
-        }
-    
-        /**
-        * Create a log message.
-        * @param {string} message - message to log
-        * @param {number} [level=this.options.level] - log level; current level by default
-        * @return {Logger}
-        */
-        createMessage(message, level = this.options.level){
-            if(level < this.options.level){
-                return;
-            }
-    
-            let msg = "";
-            if(this.options.timestamp.state){
-                msg += this.appendTimestamp();
-            }
-    
-            msg += `[${Logger.level.string[level]}] `;
-            msg += `[${this.name}] `;
-    
-            if(this.options.context){
-                msg += `[${this.options.context}] `;
-            }
-    
-            if(typeof message === "string"){
-                msg += message;
-            }
-            else {
-                msg += "logging object";
-            }
-    
-            return msg;
-        }
-    
-        /**
-        * Log a message.
-        * @param {string} message - message to log
-        * @param {number} [level=this.options.level] - log level; current level by default
-        * @return {Logger}
-        */
-        log(message, level = this.options.level){
-            let msg = this.createMessage(message, level);
-    
-            if(typeof message === "string"){
-                console.log(msg);
-            }
-            else {
-                console.log(msg);
-                console.log(message);
-            }
-        }
-    
-        /**
-        * Log a verbose message.
-        * Use this level when logging relatively
-        * unimportant information. Especially useful
-        * when debugging program flow.
-        * @param {string} message 
-        * @return {Logger}
-        */
-        verbose(message){
-            return this.log(message, Logger.level.verbose);
-        }
-    
-        /**
-        * Log a debug message
-        * @param {string} message 
-        * @return {Logger}
-        */
-        debug(message){
-            return this.log(message, Logger.level.debug);
-        }
-    
-        /**
-        * Log an info message
-        * @param {string} message 
-        * @return {Logger}
-        */
-        info(message){
-            return this.log(message, Logger.level.info);
-        }
-    
-        /**
-        * Log a warning message
-        * @param {string} message 
-        * @return {Logger}
-        */
-        warning(message){
-            return this.log(message, Logger.level.warning);
-        }
-    
-        /**
-        * Log an error message
-        * @param {string} message 
-        * @return {Logger}
-        */
-        error(message){
-            return this.log(message, Logger.level.error);
-        }
     }
-    Logger.level = {
-        verbose: 0,
-        debug: 1,
-        info: 2,
-        warning: 3,
-        error: 4,
-        string: [
-            "VRB",
-            "DBG",
-            "INF",
-            "WRN",
-            "ERR"
-        ]
-    };
-    Logger.timestamp = {
-        utc: 0,
-        locale: 1,
-        localetime: 2,
-        localedate: 3
-    };
-    
-    if(typeof module !== "undefined"){
-        module.exports = Logger;
-    }
+
+    /**
+    * Log a verbose message.
+    * Use this level when logging relatively
+    * unimportant information. Especially useful
+    * when debugging program flow.
+    * @param {string} message 
+    * @return {Logger}
+    */
+    verbose(message){
+        return this.log(message, Logger.level.verbose);
+    }
+
+    /**
+    * Log a debug message
+    * @param {string} message 
+    * @return {Logger}
+    */
+    debug(message){
+        return this.log(message, Logger.level.debug);
+    }
+
+    /**
+    * Log an info message
+    * @param {string} message 
+    * @return {Logger}
+    */
+    info(message){
+        return this.log(message, Logger.level.info);
+    }
+
+    /**
+    * Log a warning message
+    * @param {string} message 
+    * @return {Logger}
+    */
+    warning(message){
+        return this.log(message, Logger.level.warning);
+    }
+
+    /**
+    * Log an error message
+    * @param {string} message 
+    * @return {Logger}
+    */
+    error(message){
+        return this.log(message, Logger.level.error);
+    }
+}
+Logger.level = {
+    verbose: 0,
+    debug: 1,
+    info: 2,
+    warning: 3,
+    error: 4,
+    string: [
+        "VRB",
+        "DBG",
+        "INF",
+        "WRN",
+        "ERR"
+    ]
+};
+Logger.timestamp = {
+    utc: 0,
+    locale: 1,
+    localetime: 2,
+    localedate: 3
+};
+
+if(typeof module !== "undefined"){
+    module.exports = Logger;
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15846

increased by17.01%

Number of package files

9

increased by28.57%

Lines of code

361

increased by8.41%

Worsened metrics

Dev dependency count

2

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes