node-debug-tool - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

examples/example.js

@@ -17,1 +17,3 @@ 'use strict';
 }, 2000);
+
+worker1.log(new Error('abc'));

lib/node-debug-tool.js

@@ -43,3 +43,2 @@ /**
     var generateOutput = function (string, prefix, color) {
-
         if (process.env.DEBUG_MODE != true) {
@@ -49,9 +48,21 @@ return;
 
-        var date = new Date(),
-            time = ! isTTY ? ('(' + date.toUTCString() + ')') + ' ' : '',
-            prefixColor = isTTY ? '\u001b[3' + color + 'm' : '',
-            resetColor  = isTTY ? '\u001b[0m' : '';
+        var time = '',
+            prefixColor = '',
+            resetColor = '',
+            date = new Date();
 
+        // using color on TTY, otherwise using UTCString prefix
+        if (isTTY) {
+            prefixColor = '\u001b[3' + color + 'm';
+            resetColor = '\u001b[0m';
+        } else {
+            time = '(' + date.toUTCString() + ')' + ' ';
+        }
+
         tickTimer();
 
+        if ( ! string instanceof Error) {
+            string = JSON.stringify(string, null, 4);
+        }
+
         console.log(
@@ -58,0 +69,0 @@ time + '['+workerName+'] ' +

package.json

 {
   "name": "node-debug-tool",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Node debug tool",
@@ -5,0 +5,0 @@ "main": "./lib/node-debug-tool.js",

README.md

 # Node Debug Tool  
 [![Build Status](https://travis-ci.org/danrevah/node-debug-tool.svg?branch=master)](https://travis-ci.org/danrevah/node-debug-tool) 
 
+ > Tiny node.js debugging tool with colors and timing functionality
+ 
 ## Table of contents
+
+ * [Installation](#installation)
+ * [Usage](#usage)
+ 
+
+## Installation
+```
+ $ npm install node-debug-tool
+```
+
+## Usage
+The `DEBUG_MODE` environment variable, must be set to 1 in order to see the deubbing information.
+
+*Code example:*
+```javascript
+
+  var worker1 = require('../lib/node-debug-tool')('worker 1');
+  var worker2 = require('../lib/node-debug-tool')('worker 2');
+  
+  worker1.error('Some Error');
+  worker1.warning('Some warning');
+  worker1.log('Some logging');
+  
+  worker2.error('Foo');
+  worker2.warning('Bar');
+  worker2.log('Foo bar');
+  
+  setInterval(function () {
+      worker2.log('Some Foo Bar Log');
+  }, 2000);
+```
+
+*Usage & Output:*
+
+
+![alt tag](http://i57.tinypic.com/2ez3brl.jpg)

test/node-debug-tool.js

@@ -24,3 +24,3 @@ var chai = require('chai');
         it("should return a colored red text string with [Error] prefix and time tick", function() {
-            expect(mockConsoleLogAndCallDebug('error', 'foo')).to.match(/\[Worker 1\] \u001b\[31m\[Error\] foo\u001b\[0m \+\d+ms/);
+            expect(mockConsoleLogAndCallDebug('error', 'foo')).to.match(/\[Worker 1\] \u001b\[31m\[Error\] "foo"\u001b\[0m \+\d+ms/);
         });
@@ -31,3 +31,3 @@ });
         it("should return a colored yellow text string with [Warning] prefix and time tick", function() {
-            expect(mockConsoleLogAndCallDebug('warning', 'foo')).to.match(/\[Worker 1\] \u001b\[33m\[Warning\] foo\u001b\[0m \+\d+ms/);
+            expect(mockConsoleLogAndCallDebug('warning', 'foo')).to.match(/\[Worker 1\] \u001b\[33m\[Warning\] "foo"\u001b\[0m \+\d+ms/);
         });
@@ -38,5 +38,5 @@ });
         it("should return a colored green text string with [Debug] prefix and time tick", function() {
-            expect(mockConsoleLogAndCallDebug('log', 'foo')).to.match(/\[Worker 1\] \u001b\[32m\[Debug\] foo\u001b\[0m \+\d+ms/);
+            expect(mockConsoleLogAndCallDebug('log', 'foo')).to.match(/\[Worker 1\] \u001b\[32m\[Debug\] "foo"\u001b\[0m \+\d+ms/);
         });
     });
 });

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

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

24445

increased by13.13%

Lines of code

112

increased by10.89%

Number of lines in readme file

43

increased by760%

Worsened metrics

Number of package files

15

decreased by-6.25%

No dependency changes