verb/lib/log.js

Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.

/**
 * Verb <https://github.com/assemble/verb>
 * Generate markdown documentation for GitHub projects.
 *
 * Copyright (c) 2014 Jon Schlinkert, Brian Woodward, contributors.
 * Licensed under the MIT license.
 */

'use strict';

var verb = require('../');
var colors = verb.colors;


/**
 * General log
 *
 * @public
 * @return {string}
 */

var log = function () {
  var args = Array.prototype.map.call(arguments, function (arg) {
    return colors.stripColor(arg);
  });
  args[0] = colors.bold(args[0]);
  return console.log.apply(this, args);
};

var format = function(color, text) {
  return colors[color]('  ' + verb.runner.name + ' [' + text + '] ·');
};


log.verbose = {};



/**
 * Testing some logging formats.
 */

log.write = function () {
  return console.log.apply(this, arguments);
};

log.writeln = function () {
  var args = arguments;
  return console.log.apply('\n' + this, args);
};

log.subhead = function () {
  var args = arguments;
  args[0] = format('bold', args[0]);
  return console.log.apply(this, args);
};

log.setup = function () {
  var args = arguments;
  args[0] = format('yellow', args[0]);
  return console.log.apply(this, args);
};

log.run = function () {
  var args = arguments;
  args[0] = format('gray', args[0]);
  return console.log.apply(this, args);
};



/**
 * Timestamp
 *
 * @public
 * @return {string}
 */

log.timestamp = function () {
  var args = arguments;
  args[0] = verb.utils.time() + colors.gray(args[0]);
  return console.log.apply(this, args);
};


/**
 * Bold
 *
 * @public
 * @return {string}
 */

log.bold = function () {
  var args = arguments;
  args[0] = colors.bold(args[0]);
  return console.log.apply(this, args);
};

/**
 * Info
 *
 * @public
 * @return {string}
 */

log.info = function () {
  var args = arguments;
  args[0] = args[0];
  return console.log.apply(this, args);
};

/**
 * Success
 *
 * @public
 * @return {string}
 */

log.success = function () {
  var args = arguments;
  args[0] = colors.green(args[0]);
  return console.log.apply(this, args);
};

/**
 * Done.
 *
 * @public
 * @return {string}
 */

log.done = function () {
  var args = arguments;
  args[0] = (colors.green('  ' + verb.runner.name + ' [' + args[0] + ']'));
  return console.log.apply(this, args);
};

/**
 * Warn
 *
 * @public
 * @return {string}
 */

log.warn = function () {
  var args = arguments;
  args[0] = colors.yellow(args[0]);
  return console.warn.apply(this, args);
};

/**
 * Error
 *
 * @public
 * @return {string}
 */

log.error = function () {
  var args = arguments;
  args[0] = colors.red(args[0]);
  return console.error.apply(this, args);
};

/**
 * Fatal
 *
 * @public
 * @return {string}
 */

log.fatal = function () {
  var args = arguments;
  args[0] = (colors.red('  ' + verb.runner.name + ' [FAIL]:') + colors.gray(' · ') + args[0]);
  console.log();
  console.log.apply(this, args);
  process.exit(1);
};

/**
 * markdown CLI formats
 */

// Emphasis
log.em = colors.cyan.bold;

// Links
log.path = colors.green.bold;

// Code
log.code = colors.cyan;

// Add all properties on `log` to `verbose`
Object.keys(log).filter(function(key) {
  return typeof log[key] === 'function';
}).forEach(function(key) {
  log.verbose[key] = function() {
    if(verb.mode.verbose !== false) {
      log[key].apply(log, arguments);
      return log.verbose;
    } else {
      return;
    }
  };
});

module.exports = log;