andela-iamao / react-raise

lib/speak.js

const chalk = require('chalk');
const figlet = require('figlet');

/**
 * Print a message on the console
 * @param {String} message - message to print to screen
 *  @param {String} [type='console'] - type of message to print

The parameter type='console' does not exist. Did you maybe forget to remove this comment?

 * @param {String} [color='cyan'] - color of message

The parameter color='cyan' does not exist. Did you maybe forget to remove this comment?

 * @returns {Void} returns nothing
 */
function speak(message, type = 'console', color = 'cyan') {
  if (type === 'console') {
    console.log(chalk[color](message)); //eslint-disable-line
  } else {
    console.log(  //eslint-disable-line
      chalk[color](
        figlet.textSync(message, { horizontalLayout: 'full' })
    ));
  }
  return { type, message, color };
}

module.exports = speak;