@jdbk/book-cli/lib/utils/logger.js

Command line interface for front end project

/* eslint-disable no-underscore-dangle */
/* eslint-disable global-require */
const chalk = require('chalk');
const stripAnsi = require('strip-ansi'); // 从字符串中去掉ANSI转义码
const readline = require('readline'); // 读取行数据
const EventEmitter = require('events');

const { stopSpinner } = require('./spinner');

exports.events = new EventEmitter();

function _log(type, tag, message) {
  if (process.env.BOOK_CLI_API_MODE && message) {
    exports.events.emit('log', {
      message,
      type,
      tag,
    });
  }
}

const format = (label, msg) => msg
  .split('\n')
  .map((line, i) => (i === 0 ? `${label} ${line}` : line.padStart(stripAnsi(label).length)))
  .join('\n');

const chalkTag = (msg) => chalk.bgBlackBright.white.dim(` ${msg} `);

exports.log = (msg = '', tag = null) => {
  // eslint-disable-next-line babel/no-unused-expressions
  // eslint-disable-next-line no-unused-expressions
  tag ? console.log(format(chalkTag(tag), msg)) : console.log(msg);
  _log('log', tag, msg);
};

exports.info = (msg, tag = null) => {
  console.log(
    format(chalk.bgBlue.black(' INFO ') + (tag ? chalkTag(tag) : ''), msg),
  );
  _log('info', tag, msg);
};

exports.done = (msg, tag = null) => {
  console.log(
    format(chalk.bgGreen.black(' DONE ') + (tag ? chalkTag(tag) : ''), msg),
  );
  _log('done', tag, msg);
};

exports.warn = (msg, tag = null) => {
  console.warn(
    format(
      chalk.bgYellow.black(' WARN ') + (tag ? chalkTag(tag) : ''),
      chalk.yellow(msg),
    ),
  );
  _log('warn', tag, msg);
};

exports.error = (msg, tag = null) => {
  stopSpinner();
  console.error(
    format(chalk.bgRed(' ERROR ') + (tag ? chalkTag(tag) : ''), chalk.red(msg)),
  );
  _log('error', tag, msg);
  if (msg instanceof Error) {
    console.error(msg.stack);
    _log('error', tag, msg.stack);
  }
};

exports.clearConsole = (title) => {
  if (process.stdout.isTTY) {
    const blank = '\n'.repeat(process.stdout.rows);
    console.log(blank);
    readline.cursorTo(process.stdout, 0, 0);
    readline.clearScreenDown(process.stdout);
    if (title) {
      console.log(title);
    }
  }
};

// silent all logs except errors during tests and keep record
if (process.env.BOOK_CLI_TEST) {
  require('./_silence')('logs', exports);
}