andydebugtool v1.3.1

An.dy Debug Tool

An.dy debug tool makes debugging an easier task. Just install it in your project, and with a quick setup, you will be getting messages on your console.

install

By command line do:

npm install andydebugtool --save

Use

Requiring the debug tool on your project

Wherever you need to put a message, remember to require the debug tool at the top of such file.

const debugTool = require('andydebugtool');

Setting your own debug messages

Put the following line were you want to get a debug message:

debugTool.debug('YOUR_MESSAGE', '{type}');

Error Types

success will turn debug message to green color.
error will turn debug message to red color.
warn will turn debug message to yellow color.

Running debug mode

Once messages are in place, initiate Debug mode on the command line by setting the environmental variable:

DEBUG=true

Debug message on you console

Debug messages will appear in the following form, according to their placement and will

Fri, 13 Jan 2017 01:38:24 GMT:
   [an.dy_url_shortener] YOUR_MESSAGE

Running Tests

Unit testing is provided with mocha and chai.

In order to run the tests use:

npm test

Or if you have mocha install globally (with the -g option), you could also use:

mocha

A complete successful test should look like this:

debugutil


 3 passing (13ms)

Version Bumper

This tool counts with an automated version bumper, it will bump the part of the version indeicated by 1. To use it, on you command line do:

gulp bump { major | minor | patch }