secretary

Bring common sense to console logging.

#secretary#

A node.js module that brings common sense to console logging.

##Installation##

Not quite published yet

##Setup##

####Configuration:####

sec.configure({
    minFlag: 1,
    maxFlag: 5,
    minRunningFlag: 3,
    maxRunningFlag: 4
});

The potential configuration options are as follows:

  • minFlag - default: 1 - The lowest possible flag for any output. This must be >= 1.
  • maxFlag - default: 10 - The highest possible flag for any output. This must be >= 1.
  • minRunningFlag - default: minFlag - The lowest flag whose output will be processed when the program is run. This value must fall within the range of the minFlag and the maxFlag or it will not be registered.
  • maxRunningFlag - default: maxFlag - The highest flag whose output will be processed when the program is run. This value must fall within the range of the minFlag and the maxFlag or it will not be registered.

##Usage##

####Instantiation:####

var sec = require('secretary');

####Filtering:####

One of the key features of secretary is the ability to litter your code with thoughtfully place console logging throughout your code, and have it filtered out at runtime by the flag that was supplied with the output. This way, you're always in control of the verbosity of your output, during development and during production. It also does away with the need for quick-and-dirty console.logs that you delete shortly afterwards.

If we assume the following configuration:

minFlag: 1,
maxFlag: 5,
minRunningFlag: 3

And then run the following code:

sec.log('Beginning DEBUG output...', 1);
sec.log('Integrity check successful', 3);
sec.log('Server starting on port 3000', 5);

We will see the following output:

Integrity check successful
Server starting on port 3000