print-tools-js/js/utils/printer.js

Easy-to-use console logging presets and formatting

var Print, box, chalk, dateFormat, dec, decArgs, emoji, getEmote, logOrReturn, presetArgs, printDecoration, printPreset;

chalk = require('chalk');

box = require('boxen');

emoji = require('node-emoji');

dateFormat = require('dateformat');

//: Print Class
Print = {
  //: Success method
  success: function(text, args = {
      dec: 'none',
      indent: 0,
      offset: 0,
      log: true,
      emoji: true,
      ret: false
    }) {
    return printPreset(this, text, '✔', 'blush', 1, args);
  },
  //: Info method
  info: function(text, args = {
      dec: 'none',
      indent: 0,
      offset: 0,
      log: true,
      emoji: true,
      ret: false
    }) {
    return printPreset(this, text, 'ℹ', 'thinking_face', 0, args);
  },
  //: Warning method
  warning: function(text, args = {
      dec: 'none',
      indent: 0,
      offset: 0,
      log: true,
      emoji: true,
      ret: false
    }) {
    return printPreset(this, text, `⚠ ${chalk.bgYellow(' Warning ')}`, 'sweat', 1, args);
  },
  //: Error method
  error: function(text, args = {
      dec: 'none',
      indent: 0,
      offset: 0,
      log: true,
      emoji: true,
      ret: false
    }) {
    return printPreset(this, text, `💀 ${chalk.bgRed(' ERROR ')}`, 'fearful', 0, args);
  },
  //: Arrow method
  arrow: function(text, args = {
      indent: 0,
      log: true,
      ret: false
    }) {
    return printDecoration(this, text, '-->', args);
  },
  //: Chevron method
  chevron: function(text, args = {
      indent: 0,
      log: true,
      ret: false
    }) {
    return printDecoration(this, text, '>>>', args);
  },
  //: Bullet method
  bullet: function(text, args = {
      indent: 0,
      log: true,
      ret: false
    }) {
    return printDecoration(this, text, '•', args);
  },
  //: Log method
  log: function(text, args = {
      ret: false,
      emoji: false,
      offset: 0
    }) {
    var cols, emote, extLen, offsetLen, output, space, textLen, textLenMod, time;
    if (args.ret == null) {
      args.ret = false;
    }
    if (args.offset == null) {
      args.offset = 0;
    }
    if (args.emoji == null) {
      args.emoji = false;
    }
    emote = getEmote(args.emoji);
    cols = process.stdout.columns;
    time = chalk.gray(dateFormat(new Date(), 'HH:MM:ss'));
    textLen = text.replace(/\u001b\[.*?m/g, '').length;
    textLenMod = textLen % cols;
    extLen = emote.length + time.replace(/\u001b\[.*?m/g, '').length + 1 + args.offset;
    offsetLen = cols - textLen - extLen;
    if (offsetLen < 0 && args.offset > 0) {
      extLen -= 1;
    }
    if ((cols - textLenMod - extLen) > 0) {
      space = ' '.repeat(cols - textLenMod - extLen);
    } else {
      if (offsetLen === 0) {
        space = ' '.repeat(cols + (cols - textLenMod - extLen) + 1);
      } else {
        space = ' '.repeat(cols + (cols - textLenMod - extLen));
      }
    }
    output = `${text}${space}${emote} ${time}`;
    return logOrReturn(output, args.ret);
  },
  //: Title Box
  titleBox: function(title, args = {
      theme: 'main',
      titleDesc: null,
      tagLine: null,
      author: null,
      email: null,
      ret: false
    }) {
    var boxLines, boxStr, themeAliases;
    themeAliases = {
      main: 'cyan',
      success: 'green',
      info: 'blue',
      warning: 'yellow',
      danger: 'red'
    };
    if (args.theme == null) {
      args.theme = 'main';
    }
    if (themeAliases[args.theme] != null) {
      args.theme = themeAliases[args.theme];
    }
    if (!Object.values(themeAliases).includes(args.theme)) {
      args.theme = themeAliases['main'];
    }
    boxLines = [];
    if (args.titleDesc == null) {
      boxLines.push(title);
    } else {
      boxLines.push(chalk`{${args.theme} ${title}}: ${args.titleDesc}`);
    }
    if (args.tagLine != null) {
      boxLines.push(`${chalk.gray(args.tagLine)}\n`);
    }
    if ((args.author != null) && (args.email != null)) {
      boxLines.push(chalk`${args.author}: {yellow ${args.email}}`);
    } else if ((args.author != null) && (args.email == null)) {
      boxLines.push(args.author);
    } else if ((args.author == null) && (args.email != null)) {
      boxLines.push(chalk.yellow(args.email));
    }
    boxStr = box(boxLines.join('\n'), {
      padding: 1,
      margin: 1,
      borderStyle: 'round',
      borderColor: args.theme
    });
    if ((args.ret == null) || !args.ret) {
      console.log(boxStr);
      return true;
    } else if (args.ret) {
      return boxStr;
    }
  }
};

//: Print Decoration
printDecoration = function(obj, text, decText, args) {
  var output;
  args = decArgs(args);
  output = dec(text, decText, args.indent);
  if (args.log) {
    return obj.log(output, {
      ret: args.ret
    });
  } else {
    return logOrReturn(output, args.ret);
  }
};

//: Print Preset
printPreset = function(obj, text, presetText, emojiText, defaultOffset, args) {
  var cols, emote, extLen, offsetLen, output, space, styleMethods, textLen, textLenMod;
  args = presetArgs(args, defaultOffset);
  output = `${presetText} ${text}`;
  styleMethods = {
    arrow: obj.arrow,
    chevron: obj.chevron,
    bullet: obj.bullet
  };
  if (styleMethods[args.dec] != null) {
    output = styleMethods[args.dec](output, {
      indent: 0,
      log: false,
      ret: true
    });
  }
  output = `${'    '.repeat(args.indent)}${output}`;
  if (args.log) {
    if (args.emoji) {
      emote = emojiText;
    } else {
      emote = false;
    }
    return obj.log(output, {
      ret: args.ret,
      emoji: emote,
      offset: args.offset
    });
  } else {
    emote = getEmote(emojiText, args.emoji);
    cols = process.stdout.columns;
    textLen = output.replace(/\u001b\[.*?m/g, '').length;
    textLenMod = textLen % cols;
    extLen = emote.length + args.offset;
    offsetLen = cols - textLen - extLen;
    if (offsetLen < 0 && args.offset > 0) {
      extLen -= 1;
    }
    if ((cols - textLenMod - extLen) > 0) {
      space = ' '.repeat(cols - textLenMod - extLen);
    } else {
      if (offsetLen === 0) {
        space = ' '.repeat(cols + (cols - textLenMod - extLen) + 1);
      } else {
        space = ' '.repeat(cols + (cols - textLenMod - extLen));
      }
    }
    output = `${output}${space}${emote}`;
    return logOrReturn(output, args.ret);
  }
};

//: Decoration Args
decArgs = function(obj) {
  var def;
  def = {
    indent: 0,
    log: true,
    ret: false
  };
  return {...def, ...obj};
};

//: Preset Args
presetArgs = function(obj, defaultOffset) {
  var def;
  def = {
    dec: 'none',
    indent: 0,
    offset: defaultOffset,
    log: true,
    emoji: true,
    ret: false
  };
  return {...def, ...obj};
};

//: Get Emote
getEmote = function(emoticon, emoteCheck) {
  var emote;
  if (emoteCheck == null) {
    emoteCheck = emoticon;
  }
  if (emoteCheck !== false) {
    emote = emoji.find(emoticon);
    if (emote == null) {
      emote = ' ';
    } else {
      emote = emote.emoji;
    }
  } else {
    emote = ' ';
  }
  return emote;
};

//: Log or Return
logOrReturn = function(text, ret) {
  if (!ret) {
    console.log(text);
    return true;
  } else {
    return text;
  }
};

//: Decoration Print
dec = function(text, decText = '', indent = 0) {
  return `${'    '.repeat(indent)}${decText} ${text}`;
};

//: Exports
module.exports = Print;

//::: End Program:::