@icon-magic/logger - npm Package Compare versions

Comparing version 2.0.1-beta.0 to 2.2.8-beta.0

dist/src/index.d.ts

@@ -9,11 +9,23 @@ import * as winston from 'winston';
  */
-export interface Logger {
-    error: (msg: string) => void;
-    debug: (msg: string) => void;
-    info: (msg: string) => void;
+interface LoggerInterface {
+    error(msg: string): void;
+    debug(msg: string): void;
+    info(msg: string): void;
+    setDebug(debug: boolean): void;
 }
 /**
  * Wrapper around winston's logger that takes in a fileName
+ * @const debugState <boolean> defaults to false, passed in from cli flags.
+ * Using commander, -d or --debug flag will make this true.
  * @param fileName name of the file that's added as a label to the logging data
  */
-export declare function logger(fileName: string): Logger;
+export declare class Logger implements LoggerInterface {
+    fileName: string;
+    static debugState: boolean;
+    constructor(fileName: string);
+    error(msg?: string): void;
+    debug(msg?: string): void;
+    info(msg: string): void;
+    setDebug(debug: boolean): void;
+}
+export {};

dist/src/index.js

@@ -21,18 +21,27 @@ "use strict";
  * Wrapper around winston's logger that takes in a fileName
+ * @const debugState <boolean> defaults to false, passed in from cli flags.
+ * Using commander, -d or --debug flag will make this true.
  * @param fileName name of the file that's added as a label to the logging data
  */
-function logger(fileName) {
-    return {
-        error: function (msg) {
-            exports.winstonLogger.error({ message: msg, label: fileName });
-        },
-        debug: function (msg) {
-            exports.winstonLogger.debug({ message: msg, label: fileName });
-        },
-        info: function (msg) {
-            exports.winstonLogger.info({ message: msg, label: fileName });
+class Logger {
+    constructor(fileName) {
+        this.fileName = fileName;
+    }
+    error(msg = '') {
+        exports.winstonLogger.error({ message: msg, label: this.fileName });
+    }
+    debug(msg = '') {
+        if (Logger.debugState) {
+            exports.winstonLogger.debug({ message: msg, label: this.fileName });
         }
-    };
+    }
+    info(msg) {
+        exports.winstonLogger.info({ message: msg, label: this.fileName });
+    }
+    setDebug(debug) {
+        Logger.debugState = debug;
+    }
 }
-exports.logger = logger;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBMkQ7QUFHM0QsTUFBTSxFQUFFLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxHQUFHLGdCQUFNLENBQUM7QUFFeEQsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsRUFBRSxFQUFFO0lBQy9ELE9BQU8sR0FBRyxTQUFTLEtBQUssS0FBSyxLQUFLLEtBQUssS0FBSyxPQUFPLEVBQUUsQ0FBQztBQUN4RCxDQUFDLENBQUMsQ0FBQztBQUVIOztHQUVHO0FBQ1UsUUFBQSxhQUFhLEdBQW1CLHNCQUFZLENBQUM7SUFDeEQsVUFBVSxFQUFFO1FBQ1YsSUFBSSxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztRQUMxQyxJQUFJLG9CQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLG9CQUFvQixFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztRQUN2RSxJQUFJLG9CQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLHNCQUFzQixFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztLQUMxRTtJQUNELE1BQU0sRUFBRSxPQUFPLENBQUMsUUFBUSxFQUFFLEVBQUUsU0FBUyxFQUFFLEVBQUUsUUFBUSxDQUFDO0NBQ25ELENBQUMsQ0FBQztBQVdIOzs7R0FHRztBQUNILFNBQWdCLE1BQU0sQ0FBQyxRQUFnQjtJQUNyQyxPQUFPO1FBQ0wsS0FBSyxFQUFFLFVBQVMsR0FBVztZQUN6QixxQkFBYSxDQUFDLEtBQUssQ0FBQyxFQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDekQsQ0FBQztRQUNELEtBQUssRUFBRSxVQUFTLEdBQVc7WUFDekIscUJBQWEsQ0FBQyxLQUFLLENBQUMsRUFBRSxPQUFPLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUUsQ0FBQyxDQUFDO1FBQ3pELENBQUM7UUFDRCxJQUFJLEVBQUUsVUFBUyxHQUFXO1lBQ3hCLHFCQUFhLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBTyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUN4RCxDQUFDO0tBQ0YsQ0FBQztBQUNKLENBQUM7QUFaRCx3QkFZQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGNyZWF0ZUxvZ2dlciwgZm9ybWF0LCB0cmFuc3BvcnRzIH0gZnJvbSAnd2luc3Rvbic7XG5pbXBvcnQgKiBhcyB3aW5zdG9uIGZyb20gJ3dpbnN0b24nO1xuXG5jb25zdCB7IGNvbWJpbmUsIGNvbG9yaXplLCBwcmludGYsIHRpbWVzdGFtcCB9ID0gZm9ybWF0O1xuXG5jb25zdCBteUZvcm1hdCA9IHByaW50ZigoeyBsZXZlbCwgbWVzc2FnZSwgbGFiZWwsIHRpbWVzdGFtcCB9KSA9PiB7XG4gIHJldHVybiBgJHt0aW1lc3RhbXB9IFske2xhYmVsfV0gJHtsZXZlbH06ICR7bWVzc2FnZX1gO1xufSk7XG5cbi8qKlxuICogSW5pdGlhbGl6aW5nIHdpbnN0b24ncyBsb2dnZXIgdG8gY2FwdHVyZSB0aGUgcnVuIGFuZCBlcnJvciBsb2dzXG4gKi9cbmV4cG9ydCBjb25zdCB3aW5zdG9uTG9nZ2VyOiB3aW5zdG9uLkxvZ2dlciA9IGNyZWF0ZUxvZ2dlcih7XG4gIHRyYW5zcG9ydHM6IFtcbiAgICBuZXcgdHJhbnNwb3J0cy5Db25zb2xlKHsgbGV2ZWw6ICdkZWJ1ZycgfSksXG4gICAgbmV3IHRyYW5zcG9ydHMuRmlsZSh7IGZpbGVuYW1lOiAnaWNvbi1tYWdpYy1ydW4ubG9nJywgbGV2ZWw6ICdzaWxseScgfSksXG4gICAgbmV3IHRyYW5zcG9ydHMuRmlsZSh7IGZpbGVuYW1lOiAnaWNvbi1tYWdpYy1lcnJvci5sb2cnLCBsZXZlbDogJ2Vycm9yJyB9KVxuICBdLFxuICBmb3JtYXQ6IGNvbWJpbmUoY29sb3JpemUoKSwgdGltZXN0YW1wKCksIG15Rm9ybWF0KVxufSk7XG5cbi8qKlxuICogV3JhcHBlciBhcm91bmQgd2luc3RvbidzIGxvZ2dlclxuICovXG5leHBvcnQgaW50ZXJmYWNlIExvZ2dlciB7XG4gIGVycm9yOiAobXNnOiBzdHJpbmcpID0+IHZvaWQ7XG4gIGRlYnVnOiAobXNnOiBzdHJpbmcpID0+IHZvaWQ7XG4gIGluZm86IChtc2c6IHN0cmluZykgPT4gdm9pZDtcbn1cblxuLyoqXG4gKiBXcmFwcGVyIGFyb3VuZCB3aW5zdG9uJ3MgbG9nZ2VyIHRoYXQgdGFrZXMgaW4gYSBmaWxlTmFtZVxuICogQHBhcmFtIGZpbGVOYW1lIG5hbWUgb2YgdGhlIGZpbGUgdGhhdCdzIGFkZGVkIGFzIGEgbGFiZWwgdG8gdGhlIGxvZ2dpbmcgZGF0YVxuICovXG5leHBvcnQgZnVuY3Rpb24gbG9nZ2VyKGZpbGVOYW1lOiBzdHJpbmcpOiBMb2dnZXIge1xuICByZXR1cm4ge1xuICAgIGVycm9yOiBmdW5jdGlvbihtc2c6IHN0cmluZyk6IHZvaWQge1xuICAgICAgd2luc3RvbkxvZ2dlci5lcnJvcih7IG1lc3NhZ2U6IG1zZywgbGFiZWw6IGZpbGVOYW1lIH0pO1xuICAgIH0sXG4gICAgZGVidWc6IGZ1bmN0aW9uKG1zZzogc3RyaW5nKTogdm9pZCB7XG4gICAgICB3aW5zdG9uTG9nZ2VyLmRlYnVnKHsgbWVzc2FnZTogbXNnLCBsYWJlbDogZmlsZU5hbWUgfSk7XG4gICAgfSxcbiAgICBpbmZvOiBmdW5jdGlvbihtc2c6IHN0cmluZyk6IHZvaWQge1xuICAgICAgd2luc3RvbkxvZ2dlci5pbmZvKHsgbWVzc2FnZTogbXNnLCBsYWJlbDogZmlsZU5hbWUgfSk7XG4gICAgfVxuICB9O1xufVxuIl19
+exports.Logger = Logger;
+Logger.debugState = false;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBMkQ7QUFHM0QsTUFBTSxFQUFFLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxHQUFHLGdCQUFNLENBQUM7QUFFeEQsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsRUFBRSxFQUFFO0lBQy9ELE9BQU8sR0FBRyxTQUFTLEtBQUssS0FBSyxLQUFLLEtBQUssS0FBSyxPQUFPLEVBQUUsQ0FBQztBQUN4RCxDQUFDLENBQUMsQ0FBQztBQUVIOztHQUVHO0FBQ1UsUUFBQSxhQUFhLEdBQW1CLHNCQUFZLENBQUM7SUFDeEQsVUFBVSxFQUFFO1FBQ1YsSUFBSSxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztRQUMxQyxJQUFJLG9CQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLG9CQUFvQixFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztRQUN2RSxJQUFJLG9CQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsUUFBUSxFQUFFLHNCQUFzQixFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztLQUMxRTtJQUNELE1BQU0sRUFBRSxPQUFPLENBQUMsUUFBUSxFQUFFLEVBQUUsU0FBUyxFQUFFLEVBQUUsUUFBUSxDQUFDO0NBQ25ELENBQUMsQ0FBQztBQVlIOzs7OztHQUtHO0FBQ0gsTUFBYSxNQUFNO0lBR2pCLFlBQVksUUFBZ0I7UUFDMUIsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7SUFDM0IsQ0FBQztJQUNELEtBQUssQ0FBQyxNQUFjLEVBQUU7UUFDcEIscUJBQWEsQ0FBQyxLQUFLLENBQUMsRUFBRSxPQUFPLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztJQUM5RCxDQUFDO0lBQ0QsS0FBSyxDQUFDLE1BQWMsRUFBRTtRQUNwQixJQUFJLE1BQU0sQ0FBQyxVQUFVLEVBQUU7WUFDckIscUJBQWEsQ0FBQyxLQUFLLENBQUMsRUFBRSxPQUFPLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztTQUM3RDtJQUNILENBQUM7SUFDRCxJQUFJLENBQUMsR0FBVztRQUNkLHFCQUFhLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBTyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7SUFDN0QsQ0FBQztJQUNELFFBQVEsQ0FBQyxLQUFjO1FBQ3JCLE1BQU0sQ0FBQyxVQUFVLEdBQUcsS0FBSyxDQUFDO0lBQzVCLENBQUM7O0FBbkJILHdCQW9CQztBQWxCUSxpQkFBVSxHQUFZLEtBQUssQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGNyZWF0ZUxvZ2dlciwgZm9ybWF0LCB0cmFuc3BvcnRzIH0gZnJvbSAnd2luc3Rvbic7XG5pbXBvcnQgKiBhcyB3aW5zdG9uIGZyb20gJ3dpbnN0b24nO1xuXG5jb25zdCB7IGNvbWJpbmUsIGNvbG9yaXplLCBwcmludGYsIHRpbWVzdGFtcCB9ID0gZm9ybWF0O1xuXG5jb25zdCBteUZvcm1hdCA9IHByaW50ZigoeyBsZXZlbCwgbWVzc2FnZSwgbGFiZWwsIHRpbWVzdGFtcCB9KSA9PiB7XG4gIHJldHVybiBgJHt0aW1lc3RhbXB9IFske2xhYmVsfV0gJHtsZXZlbH06ICR7bWVzc2FnZX1gO1xufSk7XG5cbi8qKlxuICogSW5pdGlhbGl6aW5nIHdpbnN0b24ncyBsb2dnZXIgdG8gY2FwdHVyZSB0aGUgcnVuIGFuZCBlcnJvciBsb2dzXG4gKi9cbmV4cG9ydCBjb25zdCB3aW5zdG9uTG9nZ2VyOiB3aW5zdG9uLkxvZ2dlciA9IGNyZWF0ZUxvZ2dlcih7XG4gIHRyYW5zcG9ydHM6IFtcbiAgICBuZXcgdHJhbnNwb3J0cy5Db25zb2xlKHsgbGV2ZWw6ICdkZWJ1ZycgfSksXG4gICAgbmV3IHRyYW5zcG9ydHMuRmlsZSh7IGZpbGVuYW1lOiAnaWNvbi1tYWdpYy1ydW4ubG9nJywgbGV2ZWw6ICdzaWxseScgfSksXG4gICAgbmV3IHRyYW5zcG9ydHMuRmlsZSh7IGZpbGVuYW1lOiAnaWNvbi1tYWdpYy1lcnJvci5sb2cnLCBsZXZlbDogJ2Vycm9yJyB9KVxuICBdLFxuICBmb3JtYXQ6IGNvbWJpbmUoY29sb3JpemUoKSwgdGltZXN0YW1wKCksIG15Rm9ybWF0KVxufSk7XG5cbi8qKlxuICogV3JhcHBlciBhcm91bmQgd2luc3RvbidzIGxvZ2dlclxuICovXG5pbnRlcmZhY2UgTG9nZ2VySW50ZXJmYWNlIHtcbiAgZXJyb3IobXNnOiBzdHJpbmcpOiB2b2lkO1xuICBkZWJ1Zyhtc2c6IHN0cmluZyk6IHZvaWQ7XG4gIGluZm8obXNnOiBzdHJpbmcpOiB2b2lkO1xuICBzZXREZWJ1ZyhkZWJ1ZzogYm9vbGVhbik6IHZvaWQ7XG59XG5cbi8qKlxuICogV3JhcHBlciBhcm91bmQgd2luc3RvbidzIGxvZ2dlciB0aGF0IHRha2VzIGluIGEgZmlsZU5hbWVcbiAqIEBjb25zdCBkZWJ1Z1N0YXRlIDxib29sZWFuPiBkZWZhdWx0cyB0byBmYWxzZSwgcGFzc2VkIGluIGZyb20gY2xpIGZsYWdzLlxuICogVXNpbmcgY29tbWFuZGVyLCAtZCBvciAtLWRlYnVnIGZsYWcgd2lsbCBtYWtlIHRoaXMgdHJ1ZS5cbiAqIEBwYXJhbSBmaWxlTmFtZSBuYW1lIG9mIHRoZSBmaWxlIHRoYXQncyBhZGRlZCBhcyBhIGxhYmVsIHRvIHRoZSBsb2dnaW5nIGRhdGFcbiAqL1xuZXhwb3J0IGNsYXNzIExvZ2dlciBpbXBsZW1lbnRzIExvZ2dlckludGVyZmFjZXtcbiAgZmlsZU5hbWU6IHN0cmluZztcbiAgc3RhdGljIGRlYnVnU3RhdGU6IGJvb2xlYW4gPSBmYWxzZTtcbiAgY29uc3RydWN0b3IoZmlsZU5hbWU6IHN0cmluZykge1xuICAgIHRoaXMuZmlsZU5hbWUgPSBmaWxlTmFtZTtcbiAgfVxuICBlcnJvcihtc2c6IHN0cmluZyA9ICcnKTogdm9pZCB7XG4gICAgd2luc3RvbkxvZ2dlci5lcnJvcih7IG1lc3NhZ2U6IG1zZywgbGFiZWw6IHRoaXMuZmlsZU5hbWUgfSk7XG4gIH1cbiAgZGVidWcobXNnOiBzdHJpbmcgPSAnJyk6IHZvaWQge1xuICAgIGlmIChMb2dnZXIuZGVidWdTdGF0ZSkge1xuICAgICAgd2luc3RvbkxvZ2dlci5kZWJ1Zyh7IG1lc3NhZ2U6IG1zZywgbGFiZWw6IHRoaXMuZmlsZU5hbWUgfSk7XG4gICAgfVxuICB9XG4gIGluZm8obXNnOiBzdHJpbmcpOiB2b2lkIHtcbiAgICB3aW5zdG9uTG9nZ2VyLmluZm8oeyBtZXNzYWdlOiBtc2csIGxhYmVsOiB0aGlzLmZpbGVOYW1lIH0pO1xuICB9XG4gIHNldERlYnVnKGRlYnVnOiBib29sZWFuKTogdm9pZCB7XG4gICAgTG9nZ2VyLmRlYnVnU3RhdGUgPSBkZWJ1ZztcbiAgfVxufVxuIl19

package.json

 {
   "name": "@icon-magic/logger",
-  "version": "2.0.1-beta.0",
+  "version": "2.2.8-beta.0",
   "description": "Icon magic logger package.",
@@ -20,3 +20,4 @@ "main": "dist/src/index.js",
     "winston": "^3.2.1"
-  }
+  },
+  "gitHead": "f8ef6904a3d74ae7ca9a014bf7e6a98d133fbed9"
 }

README.md

@@ -19,12 +19,12 @@ # @icon-magic/logger
 // Import the logger module and it's interface
-import { Logger, logger } from '@icon-magic/logger';
+import { Logger } from "@icon-magic/logger";
 
 // Instantiate by passing the name of the file. This will be a label in the log message
-const LOGGER: logger = logger('icon-magic:icon-models:asset');
+const LOGGER: logger = new Logger("icon-magic:icon-models:asset");
 
 // Log a debug message
-LOGGER.debug('Icon generation has begun');
+LOGGER.debug("Icon generation has begun");
 
 // Log an error message
-LOGGER.error('Oh no! An error has occurred!');
+LOGGER.error("Oh no! An error has occurred!");
 ```
@@ -31,0 +31,0 @@

src/index.ts

@@ -25,6 +25,7 @@ import { createLogger, format, transports } from 'winston';
  */
-export interface Logger {
-  error: (msg: string) => void;
-  debug: (msg: string) => void;
-  info: (msg: string) => void;
+interface LoggerInterface {
+  error(msg: string): void;
+  debug(msg: string): void;
+  info(msg: string): void;
+  setDebug(debug: boolean): void;
 }
@@ -34,16 +35,26 @@
  * Wrapper around winston's logger that takes in a fileName
+ * @const debugState <boolean> defaults to false, passed in from cli flags.
+ * Using commander, -d or --debug flag will make this true.
  * @param fileName name of the file that's added as a label to the logging data
  */
-export function logger(fileName: string): Logger {
-  return {
-    error: function(msg: string): void {
-      winstonLogger.error({ message: msg, label: fileName });
-    },
-    debug: function(msg: string): void {
-      winstonLogger.debug({ message: msg, label: fileName });
-    },
-    info: function(msg: string): void {
-      winstonLogger.info({ message: msg, label: fileName });
+export class Logger implements LoggerInterface{
+  fileName: string;
+  static debugState: boolean = false;
+  constructor(fileName: string) {
+    this.fileName = fileName;
+  }
+  error(msg: string = ''): void {
+    winstonLogger.error({ message: msg, label: this.fileName });
+  }
+  debug(msg: string = ''): void {
+    if (Logger.debugState) {
+      winstonLogger.debug({ message: msg, label: this.fileName });
     }
-  };
+  }
+  info(msg: string): void {
+    winstonLogger.info({ message: msg, label: this.fileName });
+  }
+  setDebug(debug: boolean): void {
+    Logger.debugState = debug;
+  }
 }

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Lines of code

152

increased by26.67%

Worsened metrics

Total package byte prevSize

13642

decreased by-86.61%

No dependency changes