Lumberjack is a JavaScript utility that hijacks the browser console, makes it more beautiful and enhances it so logs can be split into more manageable chunks.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md updated Nov 25, 2013
demo.html color documentation in readme and demo Nov 24, 2013
lumberjack.js Don't color dir method Dec 12, 2013

README.md

Lumberjack

Lumberjack is a JavaScript utility that hijacks the browser console, makes it more beautiful and enhances it so logs can be split into more manageable chunks. Lumberjack also saves everything that is logged (so you can review later) and colorizes your logs (where supported) to increase legibility.

Demo

http://jbail.github.io/lumberjack/

Getting Started

  1. Copy lumberjack.js into your project.
  2. That's it!

What is Lumberjack?

Browser based applications with lots of JavaScript often result in lots of logging. Unfortunately, the single stream logging built into modern web browsers (through console.log) gets noisy as more and more messages are logged. In can become difficult to even follow the logs. Lumberjack aims to fix that.

Usage

Instead of logging everything with console.log, Lumberjack encourages you to split your logs into bite-sized chunks that map to your application's functionality. In Lumberjack, these are called streams. Streams organize your logging by name. For example:

console.stream('cat').info('I do not like you.');
console.stream('cat').warn('Hiss!');

console.stream('dog').info('The feeling is mutual.');
console.stream('dog').warn('Woof!');

Calling the "stream" method actually creates a brand new console object that you can use. This enables you to do shorthand like this:

var cat = console.stream('cat');

cat.info('Here are some foods I like:');
cat.log('Rabbit');
cat.log('Chicken');

You can also create sub-streams off a stream.

var cat = console.stream('cat');
var boobie = cat.stream('boobie');
var karl = cat.stream('karl');

boobie.warn('Hiss!');
karl.log('Meow');

cat.stream('karl').log('Zzzzzzzz...');
cat.stream('boobie').log('I am sleepy, too');

With Lumberjack you can turn on or off logging globally or for specific sections of your code. If you don't want to hear the dog bark anymore, you can do this:

console.stream('dog').off();
//or
console.off('dog');

console.stream('dog').log('Bark! Bark! Bark!'); //this message isn't going to appear in the console

Even if you turn off a stream, all statements logged to it are still being recorded behind the scenes by Lumberjack. At any point while your application is running you can audit all the log statements like so:

console.stream('dog').logs(); //returns an Array of every message logged to the 'dog' stream

Conversely, if you want to turn a stream on, it's just as easy:

console.stream('rooster').log('qui-qui-ri-qui!'); //this message isn't going to appear in the console

console.stream('rooster').on();
//or
console.on('rooster');

console.stream('rooster').log('COCKADOODLEDOO!'); //this message will appear in the console

Lumberjack supports all the semantic console logging functions: console.log, console.info, console.dir, console.warn and console.error.

Color in Your Console

If your browser supports color in the console (at the moment this is Chrome and Firefox), then the stream names will appear and be colorized. This offers a little more visual distinction which can make your console easier to read. You can override the default colors when you create the stream, or at any time.

var cesar = cat.stream('cesar', {color: '#999', background: '#000'});
var mickey = cat.stream('mickey', {color: 'orange', background: 'beige'});

cesar.log('Hi, my name is Cesar.');
mickey.log('Hi, my name is Mickey.');

cesar.color('white');
cesar.background('red');
cesar.log('Whoa. I used to be black, but now I am red.');

mickey.color('lightblue');
mickey.background('purple');
mickey.log('Hey look at me!');

Author

Jeff Bail

License

Lumberjack is licensed under the MIT Open Source license. http://opensource.org/licenses/MIT