log-ocd/src/init.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * LOG-OCD: SETUP
 * -----------------------------------------------------------------------------
 * @version 1.0.0-beta.11
 * @see [log-ocd]{@link https://github.com/imaginate/log-ocd}
 *
 * @author Adam Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 * @copyright 2022 Adam A Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 *
 * Supporting Libraries:
 * @see [chalk]{@link https://github.com/chalk/chalk}
 * @see [vitals]{@link https://github.com/imaginate/vitals}
 *
 * Annotations:
 * @see [JSDoc3]{@link http://usejsdoc.org/}
 * @see [Closure Compiler specific JSDoc]{@link https://developers.google.com/closure/compiler/docs/js-for-compiler}
 */

'use strict';

var help = require('./helpers');
var each  = help.each;
var fuse  = help.fuse;
var slice = help.slice;

var newSettings = require('./settings');

var LOG   = require('./methods/log');
var GET   = require('./methods/get');
var SET   = require('./methods/set');
var RESET = require('./methods/reset');

var SETTERS = {
  'config': 'setConfig',
  'format': 'setFormat',
  'style':  'setStyle'
};

/**
 * @typedef {!{
 *   toString:    function,
 *   log:         function,
 *   pass:        function,
 *   error:       function,
 *   warn:        function,
 *   debug:       function,
 *   fail:        function,
 *   trace:       function,
 *   getConfig:   function,
 *   getFormat:   function,
 *   getStyle:    function,
 *   setConfig:   function,
 *   setFormat:   function,
 *   setStyle:    function,
 *   resetConfig: function,
 *   resetFormat: function,
 *   resetStyle:  function
 * }} LogOCD
 */

var METHODS = {
  'toString': require('./methods/to-string'),
  'log':      null,
  'pass':     null,
  'error':    null,
  'warn':     null,
  'debug':    null,
  'fail':     null,
  'trace':    require('./methods/trace')
};

/** @type {number} */
var instCount = 0;

/**
 * Creates a new log-ocd instance.
 * @return {LogOCD}
 */
module.exports = function newLogOCD() {

  /** @type {Settings} */
  var settings;
  /** @type {LogOCD} */
  var logocd;

  settings = newSettings( ++instCount );
  logocd = bind(LOG, settings, 'log');
  logocd = addSetters(logocd, settings);
  each(METHODS, function(func, method) {
    func = func
      ? bind(func, settings)
      : bind(LOG, settings, method);
    logocd[method] = addSetters(func, settings, method);
  });
  logocd.get = addSetters({}, settings, 'get');
  logocd.construct = newLogOCD;
  return logocd;
};

/**
 * @private
 * @param {function} func
 * @param {Settings} settings
 * @param {string=} method
 * @return {function}
 */
function bind(func, settings, method) {
  return method
    ? func.bind(settings, method)
    : func.bind(settings);
}

/**
 * @private
 * @param {function} func
 * @param {Settings} settings
 * @param {string} type
 * @param {string=} method
 * @return {function}
 */
function bindType(func, settings, type, method) {
  return method
    ? func.bind(settings, type, method)
    : func.bind(settings, type);
}

/**
 * @private
 * @param {function} func
 * @param {Settings} settings
 * @param {string=} method
 * @return {function}
 */
function addSetters(func, settings, method) {
  each(SETTERS, function(key, type) {
    func[key] = bindType(SET, settings, type, method);
    key = fuse('re', key);
    func[key] = bindType(RESET, settings, type, method);
    key = slice(key, 3);
    key = fuse('g', key);
    func[key] = bindType(GET, settings, type, method);
  });
  return func;
}