semlog 0.6.9 → 0.7.0

package/index.js

@@ -11,8 +11,8 @@
 // Requirements                         //
 //////////////////////////////////////////
 
-var chalk = require('chalk');
-var prettyjson = require('prettyjson');
+const chalk = require('chalk');
+const prettyjson = require('prettyjson');
 
 //////////////////////////////////////////
 // Variables                            //
@@ -30,14 +30,14 @@ if (!global.githubFannonSemlog) {
             printDateTime: false,
             printDebug: true,
             printVerbose: true,
-            historySize: 2048 // 0 for none
+            historySize: 2048, // 0 for none
         },
         statistics: {
             debug: 0,
             warning: 0,
             error: 0,
-            total: 0
-        }
+            total: 0,
+        },
     };
 }
 
@@ -56,7 +56,7 @@ exports.chalk = chalk;
  * @param {string|object}   msg     Message String or Object
  * @param {boolean}         [silent]  Dot not print message to the console, but stores it to the log history.
  */
-exports.log = function(obj, silent) {
+exports.log = function (obj, silent) {
     if (obj && obj instanceof Error) {
         exports.error(obj, silent);
     } else if (obj && typeof obj === 'object') {
@@ -66,8 +66,7 @@ exports.log = function(obj, silent) {
     }
 };
 
-exports.message = function(msg, silent) {
-
+exports.message = function (msg, silent) {
     global.githubFannonSemlog.statistics.total += 1;
     if (msg && msg.indexOf && (msg.indexOf('[V]') >= 0 || msg.indexOf('[D]') >= 0)) {
         global.githubFannonSemlog.statistics.debug += 1;
@@ -77,13 +76,13 @@ exports.message = function(msg, silent) {
         global.githubFannonSemlog.statistics.error += 1;
     }
 
-    var config = global.githubFannonSemlog.config;
+    const config = global.githubFannonSemlog.config;
     silent = silent || config.silent;
 
     if (typeof msg !== 'string') {
         try {
             msg = '' + JSON.stringify(msg);
-        } catch (e) {
+        } catch {
             msg = '[E] [SEMLOG] Could not stringify given parameter';
         }
     }
@@ -91,12 +90,11 @@ exports.message = function(msg, silent) {
     exports.addToHistory(msg);
 
     if (!silent) {
-
         if (config.colorize) {
             msg = exports.colorize(msg);
         }
 
-        if ((config.printTime || config.printDateTime) && msg.trim && msg.trim().length > 0) {
+        if ((config.printTime || config.printDateTime) && msg.trim().length > 0) {
             if (config.printDateTime) {
                 msg = chalk.gray('[' + exports.humanDate() + '] ') + msg;
             } else {
@@ -104,11 +102,9 @@ exports.message = function(msg, silent) {
             }
         }
 
-        if (!config.printVerbose && msg.indexOf('[V]') >= 0) {
-            // Supressing output of verbose message
-        } else if (!config.printDebug && msg.indexOf('[D]') >= 0) {
-            // Supressing output of debug message
-        } else {
+        const suppress =
+            (!config.printVerbose && msg.indexOf('[V]') >= 0) || (!config.printDebug && msg.indexOf('[D]') >= 0);
+        if (!suppress) {
             console.log(msg);
         }
     }
@@ -119,32 +115,30 @@ exports.message = function(msg, silent) {
  *
  * @param {object}        obj     Object
  */
-exports.debug = function(obj, silent) {
-
+exports.debug = function (obj, silent) {
     global.githubFannonSemlog.statistics.total += 1;
 
-    var config = global.githubFannonSemlog.config;
+    const config = global.githubFannonSemlog.config;
     silent = silent || config.silent;
     exports.addToHistory(obj);
 
     if (!silent) {
         if (global.githubFannonSemlog.config.printYaml) {
             // Print YAML
-            var options = {
+            const options = {
                 keysColor: 'white',
                 dashColor: 'white',
                 stringColor: 'yellow',
-                numberColor: 'blue'
+                numberColor: 'blue',
             };
 
             if (!global.githubFannonSemlog.config.colorize) {
                 options.noColor = true;
             }
             console.log(chalk.gray('---\n') + prettyjson.render(obj, options));
-
         } else {
             // Print indented JSON
-            var msg = JSON.stringify(obj, false, 4);
+            const msg = JSON.stringify(obj, false, 4);
             console.log(chalk.gray(msg));
         }
     }
@@ -155,12 +149,11 @@ exports.debug = function(obj, silent) {
  *
  * @param {object}        obj     Object
  */
-exports.error = function(obj, silent) {
-
+exports.error = function (obj, silent) {
     global.githubFannonSemlog.statistics.total += 1;
     global.githubFannonSemlog.statistics.error += 1;
 
-    var config = global.githubFannonSemlog.config;
+    const config = global.githubFannonSemlog.config;
     silent = silent || config.silent;
     exports.addToHistory(obj);
 
@@ -173,11 +166,9 @@ exports.error = function(obj, silent) {
     }
 };
 
-
-exports.addToHistory = function(obj) {
-
-    var config = global.githubFannonSemlog.config;
-    var msg = '';
+exports.addToHistory = function (obj) {
+    const config = global.githubFannonSemlog.config;
+    let msg;
 
     try {
         msg = JSON.stringify(obj, null, 4);
@@ -190,8 +181,7 @@ exports.addToHistory = function(obj) {
         if (config.logDateTime) {
             msg = '[' + exports.humanDate() + '] ' + msg;
         }
-
-    } catch (e) {
+    } catch {
         msg = '[W] Internal semlog error: Could not push circular/invalid object into the history';
     }
 
@@ -205,28 +195,26 @@ exports.addToHistory = function(obj) {
  * @param {string} msg
  * @returns {string}
  */
-exports.colorize = function(msg) {
-
-    var colorMap = {
-        '[E]': 'red',         // ERROR
-        '[W]': 'yellow',      // WARNING
-        '[?]': 'yellow',      // MISSING
-        '[S]': 'green',       // SUCCESS
-        '[i]': 'blue',        // INFO
-        '[+]': 'green',       // ADDED
-        '[-]': 'red',         // REMOVED
-        '[C]': 'cyan',        // CHANGED
-        '[U]': 'grey',        // UNCHANGED
-        '[=]': 'grey',        // EQUAL
-        '[/]': 'grey',        // SKIPPED
-        '[V]': 'magenta',     // VERBOSE
-        '[D]': 'magenta',     // DEBUG
-        '[T]': 'magenta',     // TO-DO
-        '[TODO]': 'magenta'   // TO-DO
+exports.colorize = function (msg) {
+    const colorMap = {
+        '[E]': 'red', // ERROR
+        '[W]': 'yellow', // WARNING
+        '[?]': 'yellow', // MISSING
+        '[S]': 'green', // SUCCESS
+        '[i]': 'blue', // INFO
+        '[+]': 'green', // ADDED
+        '[-]': 'red', // REMOVED
+        '[C]': 'cyan', // CHANGED
+        '[U]': 'grey', // UNCHANGED
+        '[=]': 'grey', // EQUAL
+        '[/]': 'grey', // SKIPPED
+        '[V]': 'magenta', // VERBOSE
+        '[D]': 'magenta', // DEBUG
+        '[T]': 'magenta', // TO-DO
+        '[TODO]': 'magenta', // TO-DO
     };
 
-    for (var searchString in colorMap) {
-        var color = colorMap[searchString];
+    for (const [searchString, color] of Object.entries(colorMap)) {
         if (msg && msg.indexOf && msg.indexOf(searchString) > -1) {
             return chalk[color](msg);
         }
@@ -235,7 +223,6 @@ exports.colorize = function(msg) {
     return msg;
 };
 
-
 //////////////////////////////////////////
 // LOGGER FUNCTIONS                     //
 //////////////////////////////////////////
@@ -243,15 +230,14 @@ exports.colorize = function(msg) {
 /**
  * Gets the current config
  */
-exports.getConfig = function() {
+exports.getConfig = function () {
     return global.githubFannonSemlog.config;
 };
 
-
 /**
  * Gets the current config
  */
-exports.getStatistics = function() {
+exports.getStatistics = function () {
     return global.githubFannonSemlog.statistics;
 };
 
@@ -261,24 +247,21 @@ exports.getStatistics = function() {
  *
  * @param {object} config
  */
-exports.updateConfig = function(config) {
-    for (var key in config) {
-        var value = config[key];
-        global.githubFannonSemlog.config[key] = value;
-    }
+exports.updateConfig = function (config) {
+    Object.assign(global.githubFannonSemlog.config, config);
     return global.githubFannonSemlog.config;
 };
 
 /**
  * Clears (empties) the log object
  */
-exports.clearLogHistory = function() {
+exports.clearLogHistory = function () {
     global.githubFannonSemlog.history = [];
     global.githubFannonSemlog.statistics = {
         debug: 0,
         warning: 0,
         error: 0,
-        total: 0
+        total: 0,
     };
 };
 
@@ -287,11 +270,10 @@ exports.clearLogHistory = function() {
  *
  * @returns {Array}
  */
-exports.getLogHistory = function() {
+exports.getLogHistory = function () {
     return global.githubFannonSemlog.history;
 };
 
-
 //////////////////////////////////////////
 // HELPER UTILITIES                     //
 //////////////////////////////////////////
@@ -303,7 +285,7 @@ exports.getLogHistory = function() {
  * @param {number} digits   number of total digits
  * @returns {string}
  */
-exports.pad = function(number, digits) {
+exports.pad = function (number, digits) {
     return new Array(Math.max(digits - String(number).length + 1, 0)).join(0) + number;
 };
 
@@ -315,7 +297,7 @@ exports.pad = function(number, digits) {
  * @param number
  * @returns {string}
  */
-exports.prettyNumber = function(number) {
+exports.prettyNumber = function (number) {
     return number.toString().replace(/\B(?=(\d{3})+(?!\d))/g, '.');
 };
 
@@ -328,12 +310,11 @@ exports.prettyNumber = function(number) {
 
  * @returns {String}
  */
-exports.cleanUrl = function(url) {
+exports.cleanUrl = function (url) {
     url = url.trim();
     return url.replace(/^\/|\/$/g, '');
 };
 
-
 /**
  * Strips trailing slashes from URL
  *
@@ -342,7 +323,7 @@ exports.cleanUrl = function(url) {
  * @param {String} url URL to cleanup
  * @returns {String}
  */
-exports.stripTrailingSlash = function(url) {
+exports.stripTrailingSlash = function (url) {
     if (url.substr(-1) === '/') {
         url = url.substr(0, url.length - 1);
     }
@@ -354,9 +335,8 @@ exports.stripTrailingSlash = function(url) {
  *
  * @see http://stackoverflow.com/a/23329386
  */
-exports.byteSize = function(obj) {
-
-    var str = '';
+exports.byteSize = function (obj) {
+    let str;
 
     if (typeof obj === 'object') {
         str = JSON.stringify(obj);
@@ -364,15 +344,15 @@ exports.byteSize = function(obj) {
         str = obj.toString();
     }
 
-    var s = str.length;
-    for (var i = str.length - 1; i >= 0; i--) {
-        var code = str.charCodeAt(i);
+    let s = str.length;
+    for (let i = str.length - 1; i >= 0; i--) {
+        const code = str.charCodeAt(i);
         if (code > 0x7f && code <= 0x7ff) {
             s++;
         } else if (code > 0x7ff && code <= 0xffff) {
             s += 2;
         }
-        if (code >= 0xDC00 && code <= 0xDFFF) {
+        if (code >= 0xdc00 && code <= 0xdfff) {
             i--;
         } //trail surrogate
     }
@@ -387,13 +367,15 @@ exports.byteSize = function(obj) {
  *
  * @see http://stackoverflow.com/a/14919494
  */
-exports.prettyBytes = function(bytes, si) {
-    var thresh = si ? 1000 : 1024;
+exports.prettyBytes = function (bytes, si) {
+    const thresh = si ? 1000 : 1024;
     if (bytes < thresh) {
         return bytes + ' B';
     }
-    var units = si ? ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'] : ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'];
-    var u = -1;
+    const units = si
+        ? ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+        : ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'];
+    let u = -1;
     do {
         bytes /= thresh;
         ++u;
@@ -408,7 +390,7 @@ exports.prettyBytes = function(bytes, si) {
  * @param {Date=} date   Optional date object. If falsy, will take current time.
  * @returns {Array}
  */
-exports.getDateArray = function(date) {
+exports.getDateArray = function (date) {
     date = date || new Date();
     return [
         date.getFullYear(),
@@ -417,7 +399,7 @@ exports.getDateArray = function(date) {
         exports.pad(date.getHours(), 2),
         exports.pad(date.getMinutes(), 2),
         exports.pad(date.getSeconds(), 2),
-        exports.pad(date.getMilliseconds(), 2)
+        exports.pad(date.getMilliseconds(), 3),
     ];
 };
 
@@ -428,9 +410,9 @@ exports.getDateArray = function(date) {
  * @param {object} [date]
  * @returns {string}
  */
-exports.humanDate = function(date) {
+exports.humanDate = function (date) {
     date = date || new Date();
-    var d = exports.getDateArray(date);
+    const d = exports.getDateArray(date);
     return d[0] + '-' + d[1] + '-' + d[2] + ' ' + d[3] + ':' + d[4] + ':' + d[5];
 };
 
@@ -441,9 +423,9 @@ exports.humanDate = function(date) {
  * @param {object} [date]
  * @returns {string}
  */
-exports.roboDate = function(date) {
+exports.roboDate = function (date) {
     date = date || new Date();
-    var d = exports.getDateArray(date);
+    const d = exports.getDateArray(date);
     return d[0] + '-' + d[1] + '-' + d[2] + '_' + d[3] + '-' + d[4] + '-' + d[5];
 };
 
@@ -454,9 +436,9 @@ exports.roboDate = function(date) {
  * @param {object} [date]
  * @returns {string}
  */
-exports.humanTime = function(date) {
+exports.humanTime = function (date) {
     date = date || new Date();
-    var d = exports.getDateArray(date);
+    const d = exports.getDateArray(date);
     return d[3] + ':' + d[4] + ':' + d[5];
 };
 
@@ -467,9 +449,8 @@ exports.humanTime = function(date) {
  * @param {object} [date]
  * @returns {string}
  */
-exports.roboTime = function(date) {
+exports.roboTime = function (date) {
     date = date || new Date();
-    var d = exports.getDateArray(date);
+    const d = exports.getDateArray(date);
     return d[3] + '-' + d[4] + '-' + d[5];
 };
-

package/package.json

@@ -1,16 +1,32 @@
 {
   "name": "semlog",
-  "version": "0.6.9",
+  "version": "0.7.0",
   "description": "A semantic logger module, that colors and formats automatically depending on the content",
-  "homepage": "https://github.com/Fannon/semlog",
+  "homepage": "https://github.com/gesinn-it-pub/semlog",
   "author": {
     "name": "Simon Heimler",
     "email": "heimlersimon@gmail.com",
     "url": "http://www.fannon.de"
   },
-  "repository": "Fannon/semlog",
+  "contributors": [
+    {
+      "name": "gesinn.it GmbH & Co. KG",
+      "email": "github@gesinn.it",
+      "url": "https://gesinn.it"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gesinn-it-pub/semlog.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "license": "MIT",
   "main": "index.js",
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "keywords": [
     "semlog",
     "log",
@@ -19,26 +35,37 @@
     "colors"
   ],
   "dependencies": {
-    "chalk": "^1.1.3",
-    "prettyjson": "^1.1.3"
+    "chalk": "^4.1.2",
+    "prettyjson": "^1.2.1"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
-    "codeclimate-test-reporter": "0.3.1",
-    "grunt": "^1.0.1",
-    "grunt-cli": "^1.2.0",
-    "grunt-documentation": "^1.1.2",
-    "grunt-eslint": "^18.0.0",
-    "grunt-jscs": "^2.8.0",
-    "grunt-mocha-cli": "^2.0.0",
-    "grunt-mocha-istanbul": "^3.0.1",
-    "grunt-release": "^0.13.0",
-    "istanbul": "^0.4.3",
-    "load-grunt-tasks": "^3.4.1",
-    "mocha": "^2.4.5",
-    "time-grunt": "^1.3.0"
+    "@eslint/js": "^10.0.0",
+    "c8": "^11.0.0",
+    "chai": "^4.3.7",
+    "eslint": "^10.0.0",
+    "eslint-config-prettier": "^10.0.0",
+    "globals": "^17.0.0",
+    "mocha": "^11.0.0",
+    "prettier": "^3.0.0"
   },
   "scripts": {
-    "test": "grunt"
+    "lint": "eslint index.js test/",
+    "format:check": "prettier --check index.js test/",
+    "test": "mocha 'test/**/*.spec.js'",
+    "test:coverage": "c8 mocha 'test/**/*.spec.js'"
+  },
+  "mocha": {
+    "timeout": 16000,
+    "reporter": "spec"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text",
+      "clover"
+    ],
+    "include": [
+      "index.js"
+    ]
   }
 }