log-ocd/src/settings/format/values/types.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * LOG-OCD: FORMAT VALUES - TYPES
 * -----------------------------------------------------------------------------
 * @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 copy   = help.copy;
var each   = help.each;
var freeze = help.freeze;
var fuse   = help.fuse;
var remap  = help.remap;

var newNaturalNum = require('../../../helpers/new-natural-num');
var newAlignStr = require('../../../helpers/new-align-str');

var fromProps = require('./helpers/from-props');

/**
 * @private
 * @param {!Object} types
 * @param {!Object} base
 * @param {!Object} newTypes
 * @return {!Object}
 */
function buildNewProps(types, base, newTypes) {
  newTypes = remap(newTypes, function(props) {
    return fromProps(base, props);
  });
  return fuse(types, newTypes);
}

/** @type {!Object} */
var types;
/** @type {!Object} */
var base;

// PROPS FOR LOG & PREP CATEGORIES
types = {
  'header': {
    'spaceBefore': { type: 'number', val: 1,  setter: newNaturalNum },
    'spaceAfter':  { type: 'number', val: 6,  setter: newNaturalNum },
    'accentMark':  { type: 'string', val: '`'                       },
    'lineLimit':   { type: 'number', val: 0,  setter: newNaturalNum }
  },
  'msg': {
    'accentMark':  { type: 'string', val: '`'                       },
    'lineLimit':   { type: 'number', val: 0,  setter: newNaturalNum },
    'bullet':      { type: 'string', val: '-'                       },
    'indent':      { type: 'number', val: 2,  setter: newNaturalNum }
  },
  'ocdmap': {
    'spaceBefore': { type: 'number', val: 0,  setter: newNaturalNum },
    'spaceAfter':  { type: 'number', val: 0,  setter: newNaturalNum },
    'delimiter':   { type: 'string', val: ':'                       }
  },
  'string': {
    'brackets':    { type: 'string', val: '"' }
  },
  'regexp': {
    'identifier':  { type: 'string', val: ''  },
    'brackets':    { type: 'string', val: '/' }
  },
  'array': {
    'identifier':  { type: 'string', val: ''   },
    'delimiter':   { type: 'string', val: ','  },
    'brackets':    { type: 'string', val: '[]' },
    'indent':      { type: 'number', val: 2, setter: newNaturalNum }
  },
  'object': {
    'identifier':  { type: 'string', val: ''   },
    'delimiter':   { type: 'string', val: ','  },
    'brackets':    { type: 'string', val: '{}' },
    'indent':      { type: 'number', val: 2, setter: newNaturalNum }
  }
};

types = buildNewProps(types, types['array'], {
  'args': {
    'identifier':  { type: 'string', val: '[Arguments] ' }
  }
});

types = buildNewProps(types, types['object'], {
  'function': {
    'identifier':  { type: 'string', val: '[Function] ' }
  },
  'element':  {
    'identifier':  { type: 'string', val: '[DOMElement] ' }
  },
  'document': {
    'identifier':  { type: 'string', val: '[DOMDocument] ' }
  }
});

// PROPS FOR TRACE CATEGORY
types = fuse(types, {
  'root': {
    'spaceBefore': { type: 'number', val: 0, setter: newNaturalNum },
    'spaceAfter':  { type: 'number', val: 0, setter: newNaturalNum },
    'identifier':  { type: 'string', val: ''                       },
    'lineLimit':   { type: 'number', val: 0, setter: newNaturalNum },
    'brackets':    { type: 'string', val: ''                       }
  },
  'row': {
    'spaceBefore': { type: 'number', val: 1, setter: newNaturalNum },
    'spaceAfter':  { type: 'number', val: 1, setter: newNaturalNum }
  }
});

base = {
  'spaceBefore': { type: 'number', val: 1,       setter: newNaturalNum },
  'spaceAfter':  { type: 'number', val: 0,       setter: newNaturalNum },
  'lineLimit':   { type: 'number', val: 0,       setter: newNaturalNum },
  'align':       { type: 'string', val: 'right', setter: newAlignStr   }
};
types = buildNewProps(types, base, {
  'event': {
    'spaceBefore': { type: 'number', val: 0,      setter: newNaturalNum },
    'align':       { type: 'string', val: 'left', setter: newAlignStr   },
    'title':       { type: 'string', val: 'event'                       }
  },
  'file': {
    'dirDepth':    { type: 'number', val: -1, setter: newNaturalNum.build(-1) },
    'title':       { type: 'string', val: 'file'                              }
  },
  'module': {
    'title':       { type: 'string', val: 'module' }
  },
  'line': {
    'spaceBefore': { type: 'number', val: 2, setter: newNaturalNum },
    'title':       { type: 'string', val: 'line'                   }
  },
  'column': {
    'title':       { type: 'string', val: 'column' }
  }
});

module.exports = freeze(types, true);