elm-review/lib/styled-message.js

Run elm-review from Node.js

/**
 * @import {Options} from './types/options';
 * @import {FormattedString, StyledMessage} from './types/styled-message'
 */

const chalk = require('chalk');
const stripAnsi = require('strip-ansi');
const terminalLink = require('terminal-link');
const wrap = require('wrap-ansi');

// LOG

/**
 * @param {Options} options
 * @param {StyledMessage} message
 * @param {boolean} clearFixLine
 * @returns {void}
 */
function clearAndLog(options, message, clearFixLine) {
  if (options.watch && !options.debug && options.report !== 'json') {
    clearConsole();
  } else if (clearFixLine && process.stdout.isTTY) {
    process.stdout.clearLine(0);
    process.stdout.cursorTo(0);
  }

  log(options, message);
}

/**
 * @param {Options} options
 * @param {StyledMessage} message
 * @returns {void}
 */
function log(options, message) {
  const colorEnabled = options.color !== false && options.report === null;
  console.log(wrapLinesForTerminal(styleMessage(colorEnabled, message)));
}

// COLORING

/**
 * @param {boolean} colorEnabled
 * @param {StyledMessage} message
 * @returns {string}
 */
function styleMessage(colorEnabled, message) {
  return message
    .map((part) => {
      if (typeof part === 'string') {
        return part;
      }

      if (!colorEnabled) {
        return part.string;
      }

      const stringWithLink =
        part.href && terminalLink.isSupported
          ? terminalLink(part.string, part.href)
          : part.string;

      return withStyling(part)(stringWithLink);
    })
    .join('');
}

/**
 * @param {FormattedString} part
 * @returns {chalk.Chalk}
 */
function withStyling(part) {
  return part.color ? chalk.hex(part.color) : chalk;
}

// WRAP LINES

const codeBlockRegex = /^($|\s{4}|\s*(\d+|\+)\||\s+\^+|·+$)/;

/**
 * @param {string} message
 * @returns {string}
 */
function wrapLinesForTerminal(message) {
  return message
    .split('\n\n')
    .map((paragraph) => {
      // Don't wrap what looks like code blocks, code extracts
      // or the line with ^^^^
      if (
        paragraph
          .split('\n')
          .every((line) => codeBlockRegex.test(stripAnsi(line)))
      ) {
        return paragraph;
      }

      // @ts-expect-error(TS2349): `wrap-ansi` is funky.
      // eslint-disable-next-line @typescript-eslint/no-unsafe-return -- Types are wrong.
      return wrap(paragraph, 80);
    })
    .join('\n\n');
}

// CLEARING CONSOLE

/**
 * @returns {void}
 */
function clearConsole() {
  process.stdout.write(
    process.platform === 'win32'
      ? '\u001B[2J\u001B[0f'
      : '\u001B[2J\u001B[3J\u001B[H'
  );
}

module.exports = {
  clearAndLog,
  log
};