New: Add console methods such as warn, info, dir (#8)

Author: amandeepmittal

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Blaine Bublitz
+Copyright (c) 2015 Blaine Bublitz <blaine.bublitz@gmail.com>
 Based on gulp-util, copyright 2014 Fractal <contact@wearefractal.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

@@ -27,7 +27,23 @@ current time in HH:MM:ss format.
 
 ### `log.error(msg...)`
 
-Logs ths message as if you called `console.error` but prefixes the output with the
+Logs the message as if you called `console.error` but prefixes the output with the
+current time in HH:MM:ss format.
+
+### `log.warn(msg...)`
+
+Logs the message as if you called `console.warn` but prefixes the output with the
+current time in HH:MM:ss format.
+
+
+### `log.info(msg...)`
+
+Logs the message as if you called `console.info` but prefixes the output with the
+current time in HH:MM:ss format.
+
+### `log.dir(msg...)`
+
+Logs the message as if you called `console.dir` but prefixes the output with the
 current time in HH:MM:ss format.
 
 ## License

index.js

@@ -16,6 +16,27 @@ function log(){
   return this;
 }
 
+function info(){
+  var time = getTimestamp();
+  process.stdout.write(time + ' ');
+  console.info.apply(console, arguments);
+  return this;
+}
+
+function dir(){
+  var time = getTimestamp();
+  process.stdout.write(time + ' ');
+  console.dir.apply(console, arguments);
+  return this;
+}
+
+function warn(){
+  var time = getTimestamp();
+  process.stderr.write(time + ' ');
+  console.warn.apply(console, arguments);
+  return this;
+}
+
 function error(){
   var time = getTimestamp();
   process.stderr.write(time + ' ');
@@ -24,4 +45,7 @@ function error(){
 }
 
 module.exports = log;
+module.exports.info = info;
+module.exports.dir = dir;
+module.exports.warn = warn;
 module.exports.error = error;

package.json

@@ -2,9 +2,11 @@
   "name": "fancy-log",
   "version": "1.2.0",
   "description": "Log things, prefixed with a timestamp",
-  "author": "Blaine Bublitz <blaine@iceddev.com> (http://iceddev.com)",
-  "contributors": [],
-  "repository": "phated/fancy-log",
+  "author": "Blaine Bublitz <blaine.bublitz@gmail.com>",
+  "contributors": [
+    "Aman Mittal (http://amandeepmittal.github.io/)"
+  ],
+  "repository": "js-cli/fancy-log",
   "license": "MIT",
   "engines": {
     "node": ">= 0.10"

test.js

@@ -2,6 +2,8 @@
 /*
   Initial code from https://github.com/gulpjs/gulp-util/blob/v3.0.6/test/log.js
  */
+var util = require('util');
+
 var lab = exports.lab = require('lab').script();
 var code = require('code');
 var chalk = require('chalk');
@@ -55,6 +57,130 @@ lab.describe('log()', function(){
   });
 });
 
+lab.describe('log.info()', function(){
+
+  var stdout_write = process.stdout.write;
+  var writtenValue = '';
+
+  function writeSpy(value) {
+    writtenValue += value;
+  }
+
+  lab.afterEach(function(done){
+    writtenValue = '';
+    done();
+  });
+
+  lab.it('should work i guess', function(done){
+    // Stub process.stdout.write
+    process.stdout.write = writeSpy;
+
+    log.info(1, 2, 3, 4, 'five');
+    var time = timestamp('HH:mm:ss');
+    code.expect(writtenValue).equals('[' + chalk.grey(time) + '] 1 2 3 4 \'five\'\n');
+
+    // Restore process.stdout.write after test
+    process.stdout.write = stdout_write;
+
+    done();
+  });
+
+  lab.it('should accept formatting', function(done){
+     // Stub process.stdout.write
+    process.stdout.write = writeSpy;
+
+    log.info('%s %d %j', 'something', 0.1, {key: 'value'});
+    var time = timestamp('HH:mm:ss');
+    code.expect(writtenValue).equals(
+      '[' + chalk.grey(time) + '] '+
+      'something 0.1 {\"key\":\"value\"}\n'
+    );
+
+    // Restore process.stdout.write after test
+    process.stdout.write = stdout_write;
+
+    done();
+  });
+});
+
+lab.describe('log.dir()', function(){
+
+  var stdout_write = process.stdout.write;
+  var writtenValue = '';
+
+  function writeSpy(value) {
+    writtenValue += value;
+  }
+
+  lab.afterEach(function(done){
+    writtenValue = '';
+    done();
+  });
+
+  lab.it('should format an object with util.inspect', function(done){
+     // Stub process.stdout.write
+    process.stdout.write = writeSpy;
+
+    log.dir({key: 'value'});
+    var time = timestamp('HH:mm:ss');
+    code.expect(writtenValue).equals(
+      '[' + chalk.grey(time) + '] '+
+      util.inspect({key:'value'}) + '\n'
+    );
+
+    // Restore process.stdout.write after test
+    process.stdout.write = stdout_write;
+
+    done();
+  });
+});
+
+lab.describe('log.warn()', function(){
+
+  var stderr_write = process.stderr.write;
+  var writtenValue = '';
+
+  function writeSpy(value) {
+    writtenValue += value;
+  }
+
+  lab.afterEach(function(done){
+    writtenValue = '';
+    done();
+  });
+
+  lab.it('should work i guess', function(done){
+    // Stub process.stderr.write
+    process.stderr.write = writeSpy;
+
+    log.warn(1, 2, 3, 4, 'five');
+    var time = timestamp('HH:mm:ss');
+    code.expect(writtenValue).equals('[' + chalk.grey(time) + '] 1 2 3 4 \'five\'\n');
+
+    // Restore process.stderr.write after test
+    process.stderr.write = stderr_write;
+
+    done();
+  });
+
+  lab.it('should accept formatting', function(done){
+     // Stub process.stderr.write
+    process.stderr.write = writeSpy;
+
+    log.warn('%s %d %j', 'something', 0.1, {key: 'value'});
+    var time = timestamp('HH:mm:ss');
+    code.expect(writtenValue).equals(
+      '[' + chalk.grey(time) + '] '+
+      'something 0.1 {\"key\":\"value\"}\n'
+    );
+
+    // Restore process.stderr.write after test
+    process.stderr.write = stderr_write;
+
+    done();
+  });
+});
+
 lab.describe('log.error()', function(){
 
   var stderr_write = process.stderr.write;