dbug - npm Package Compare versions

Comparing version 0.3.1 to 0.4.0

index.js

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+/*jshint camelcase: false*/
 
@@ -14,9 +15,11 @@ const tty = require('tty').isatty(2);
 
-function envDebugColor(colorString) {
+var dbug;
+
+var isColored = (function envDebugColor(colorString) {
   try {
-    return !!JSON.parse(colorString);
+    return colorString ? !!JSON.parse(colorString) : tty;
   } catch (ex) {
     return false;
   }
-}
+})(process.env.DEBUG_COLORS);
 
@@ -43,17 +46,7 @@ function parseDEBUG(debugStr) {
 
-function getter(obj, name, fn) {
-  Object.defineProperty(obj, name, {
-    get: fn
-  });
-}
+var env = process.env.DEBUG || '';
+var parsedEnv = parseDEBUG(env);
 
-function coerce(val) {
-  if (val instanceof Error) {
-    return val.stack || val.message;
-  }
-  return val;
-}
-
-function isEnabled(debugStr, name) {
-  var env = parseDEBUG(debugStr);
+function isEnabled(name) {
+  var env = parsedEnv;
   var match = env.skips.some(function(re){
@@ -76,85 +69,188 @@ return re.test(name);
 
-function isColored() {
-  var env = process.env.DEBUG_COLORS;
-  return env ? envDebugColor(env) : tty;
+function colored(name, level, args) {
+  var c = colors[level];
+  args[0] = [
+    '  ',
+    name + ':',
+    '\x1b[9' + c + 'm' + level.toUpperCase() + '\x1b[39m ',
+    '\x1b[90m' + args[0]
+  ].join('');
+  args.push('\x1b[39m');
+  console[level === 'debug' ? 'log' : level].apply(console, args);
 }
 
-function logger(name) {
-  name = name + ':';
-  function colored(level, text) {
-    text = coerce(text);
-    var c = colors[level];
-    return [
-      '  ',
-      name,
-      '\x1b[9' + c + 'm' + level.toUpperCase() + '\x1b[39m ',
-      '\x1b[90m' + text + '\x1b[39m'
-    ].join('');
-  }
+function plain(name, level, args) {
+  args[0] = new Date().toUTCString()
+    + ' ' + name + ':' + level.toUpperCase() + ' ' + args[0];
+  console[level === 'debug' ? 'log' : level].apply(console, args);
+}
 
-  function plain(level, text) {
-    text = coerce(text);
+function disabled() {}
 
-    return new Date().toUTCString()
-      + ' ' + name + level.toUpperCase() + ' ' + text;
-  }
+var log = isColored ? colored : plain;
 
-  return function log(level, args) {
-    var format = isColored() ? colored : plain;
-    args[0] = format(level, args[0]);
-    console[level === 'debug' ? 'log' : level].apply(console, args);
-  };
-}
+colored.__dbug = plain.__dbug = disabled.__dbug = true;
 
-var loggers = {};
-function log(name, level, args) {
-  loggers[name](level, args);
-}
 
 
-function dbugger(name) {
-
+var dbuggers = {};
+function define(dbugger, name) {
   function logAt(level) {
-    return function canLog() {
-      if (!dbug.enabled) {
-        return;
+    return function dbug() {
+      var args = new Array(arguments.length);
+      var i = args.length;
+      while (i--) {
+        args[i] = arguments[i];
       }
-      module.exports.__log(name, level, arguments);
+      log(name, level, args);
     };
   }
+  Object.defineProperty(dbugger, 'enabled', {
+    configurable: true,
+    get: function getEnabled() {
+      return dbugger.__enabled;
+    },
+    set: function setEnabled(val) {
+      dbugger.__enabled = !!val;
+      if (dbugger.__enabled) {
+        dbugger.debug = logAt('debug');
+        dbugger.info = logAt('info');
+        dbugger.warn = logAt('warn');
+        dbugger.error = logAt('error');
+        dbugger.log = dbugger.debug;
+      } else {
+        dbugger.debug =
+        dbugger.info =
+        dbugger.warn =
+        dbugger.error =
+        dbugger.log =
+          disabled;
+      }
+    }
+  });
 
-  var dbug = logAt('debug');
-  dbug.log = logAt('debug');
-  dbug.debug = dbug.log;
-  dbug.info = logAt('info');
-  dbug.warn = logAt('warn');
-  dbug.error = logAt('error');
-
-  getter(dbug, 'enabled', function enabled() {
-    var DEBUG = process.env.DEBUG;
-    if (dbug.__DEBUG === DEBUG) {
-      return dbug.__enabled;
+  Object.defineProperty(dbugger, 'colored', {
+    configurable: true,
+    get: function getColored() {
+      return dbug.colored;
+    },
+    set: function setColored(val) {
+      dbug.colored = val;
     }
-    dbug.__DEBUG = DEBUG;
-    return dbug.__enabled = isEnabled(DEBUG, name);
   });
 
-  getter(dbug, 'colored', isColored);
+  dbugger.enabled = isEnabled(name);
 
-  loggers[name] = logger(name);
+  dbuggers[name] = dbugger;
+}
 
-  return dbug;
+function dbugger(name) {
+  if (dbuggers[name]) {
+    return dbuggers[name];
+  }
+  var dbugger = function dbug() {
+    if (dbugger.__enabled) {
+      dbugger.debug.apply(this, arguments);
+    }
+  };
+
+  define(dbugger, name);
+
+  return dbugger;
 }
 
+
+function enableDbuggers() {
+  for (var name in dbuggers) {
+    if (isEnabled(name)) {
+      dbuggers[name].enabled = true;
+    } else {
+      dbuggers[name].enabled = false;
+    }
+  }
+}
+
+dbug = function dbug(name) {
+  return dbugger(name);
+};
+
+Object.defineProperty(dbug, 'colored', {
+  get: function getColored() {
+    return isColored;
+  },
+  set: function setColored(val) {
+    isColored = !!val;
+    if (!log.__dbug) {
+      return;
+    }
+    if (isColored) {
+      log = colored;
+    } else {
+      log = plain;
+    }
+  }
+});
+
+Object.defineProperty(dbug, 'env', {
+  get: function getEnv() {
+    return env;
+  },
+  set: function setEnv(val) {
+    env = String(val || '');
+    parsedEnv = parseDEBUG(env);
+    enableDbuggers();
+  }
+});
+
+// woah. this is a private API. don't rely on it. i can blow it up
+// any time. kablamo!
+Object.defineProperty(dbug, '__log', {
+  enumerable: false,
+  get: function() {},
+  set: function setLog(val) {
+    log = val;
+  }
+});
+
+dbug.version = require('./package.json').version;
+
+function decimalVersion(verStr) {
+  var parts = verStr.split('.');
+  var v = 0;
+  try {
+    v = parseInt(parts[0], 10) * 10000
+      + parseInt(parts[1], 10) * 100;
+    if (parts[2].indexOf('-') !== -1) {
+      parts = parts[2].split('-');
+      v += parseInt(parts[0], 10);
+      v += parseInt(parts[1], 16) / 1000; // a1, b1, b2, etc
+    } else {
+      v += parseInt(parts[2], 10);
+    }
+  } catch (e) {
+    return -1;
+  }
+}
+
+// old way, doesn't use properties, so i can't slurp that well
 if (global.__dbug__1) {
-  module.exports = global.__dbug__1;
-} else {
-  module.exports = function dbug(name) {
-    return dbugger(name);
+  global.__dbug__1.__log = function __dbug() {
+    log.apply(null, arguments);
   };
+}
+global.__dbug__1 = dbug;
 
-  // woah. this is a private API. don't rely on it. i can blow it up
-  // any time. kablamo!
-  module.exports.__log = log;
-  global.__dbug__1 = module.exports;
+
+// merge different versions to use the same dbug instance
+if (global.__dbug__) {
+  if (decimalVersion(dbug) > decimalVersion(global.__dbug__)) {
+    dbuggers = global.__dbug__.__dbuggers;
+    for (var k in dbuggers) {
+      dbuggers[k] = define(dbuggers[k], k);
+    }
+    global.__dbug__ = dbug;
+  }
+} else {
+  global.__dbug__ = dbug;
 }
+module.exports = global.__dbug__;

package.json

 {
   "name": "dbug",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "debug improvements",
   "scripts": {
+    "matcha": "matcha -I exports",
     "test": "mocha --check-leaks --ui exports"
@@ -11,2 +12,3 @@ },
     "mocha": "1.x",
+    "matcha": "*",
     "utcstring": "*"
@@ -23,4 +25,12 @@ },
   "author": "Sean McArthur <[e-mail]> (http://seanmonstar.com)",
-  "repo": "seanmonstar/dbug",
-  "license": "MPLv2.0"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/seanmonstar/dbug.git"
+  },
+  "bugs": "https://github.com/seanmonstar/dbug/issues",
+  "license": "MPLv2.0",
+  "files": [
+    "LICENSE",
+    "index.js"
+  ]
 }

README.md

@@ -28,4 +28,11 @@ # dbug
 
-However, `dbug` will now check for chages to the env variable, so a script can enable debugging even after the dbugger has been created.
+A user script wanting to dynamically enable or disable can do it a
+couple ways:
 
+```js
+require('dbug').env = 'foo,quux'; // just like ENV var
+var foo = require('dbug')('foo');
+foo.enabled = true;
+```
+
 [debug]: https://npmjs.org/package/debug

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

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

38

increased by22.58%

Number of low supply chain risk alerts

2

decreased by-80%

Worsened metrics

Total package byte prevSize

23790

decreased by-14.5%

Dev dependency count

4

increased by33.33%

Number of package files

4

decreased by-55.56%

Lines of code

218

decreased by-28.05%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes