log-ocd/src/helpers/new-stack/new-trace.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * LOG-OCD: NEW-TRACE HELPER
 * -----------------------------------------------------------------------------
 * @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('../index');
var amend  = help.amend;
var each   = help.each;
var freeze = help.freeze;
var slice  = help.slice;

var newEmptyObj = require('../new-empty-obj');
var getModule = require('./get-module');
var isNative = require('./is-native');

/**
 * @private
 * @type {!Object}
 * @const
 */
var KEYS = freeze({
  'event':  { type: 'string', make: require('./get-event'),    nat: '' },
  'dir':    { type: '!array', make: require('./get-dirpath'),  nat: [] },
  'file':   { type: 'string', make: require('./get-file'),     nat: '' },
  'line':   { type: 'string', make: require('./get-line'),     nat: '' },
  'column': { type: 'string', make: require('./get-column'),   nat: '' },
  'module': { type: 'string', make: function(){}, nat: '(native core)' }
}, true);

/**
 * @typedef {!{
 *   index:  number,
 *   event:  string,
 *   dir:    !Array,
 *   file:   string,
 *   line:   string,
 *   column: string,
 *   module: string
 * }} Trace
 */

/**
 * @param {number} index
 * @param {string} traceStr
 * @param {!Array<string>=} base
 * @return {!Trace}
 */
module.exports = function newTrace(index, traceStr, base) {

  /** @type {!Trace} */
  var trace;

  trace = newEmptyObj('Trace');
  trace = amend(trace, 'index', index, 'number');

  if ( isNative(traceStr) ) return nativeTrace(trace);

  each(KEYS, function(obj, key) {
    trace = amend(trace, key, obj.make(traceStr), obj.type);
  });
  trace.module = getModule(traceStr, base, trace);
  return freeze(trace, true);
};

/**
 * @private
 * @param {!Trace} trace
 * @return {!Trace}
 */
function nativeTrace(trace) {
  each(KEYS, function(obj, key) {
    trace = amend(trace, key, slice(obj.nat), obj.type);
  });
  return freeze(trace, true);
}