@syncify/ansi/src/helpers.ts

ANSI Colors, Symbols and TUI related terminal enchancements for Syncify.

import { COL } from './symbols';

/**
 * Sanitizes the log message passed. Converts a `Buffer`, `number`, `object`,
 * `boolean` or an `array` type to a readable string.
 *
 * @example
 *
* sanitize(true) => 'true'
* sanitize({ x: 1 }) => '{"x":1}'
* sanitize(1000) => '1000'
*/
export function sanitize (message: number | boolean | string | Buffer | object | any[]): string {

  if (Buffer.isBuffer(message)) return message.toString();
  if (Array.isArray(message) || typeof message === 'object') return JSON.stringify(message);
  if (typeof message === 'boolean' || typeof message === 'number') return `${message}`;

  return typeof message === 'string'
    ? message
    : String(message);

};

/**
 * **eq**
 *
 * Equalised Spacing
 */
export function eq (array: any[] | object, prop: string = null) {

  let size: number = 0;

  if (Array.isArray(array)) {
    for (const item of array) {
      if (prop) {

        if (item[prop].length > size) {
          size = item[prop].length;
        }

      } else {

        if (item.length > size) {
          size = item.length;
        }

      }
    }
  } else {

    for (const item in array) {
      if (item.length > size) size = item.length;
    }
  }

  size = size + 1;

  return function curried (string: string | number) {

    const n = typeof string === 'string' ? size - string.length : size - string;

    return n < 1 ? ' ' : ' '.repeat(n);

  };

}

/**
 * Return the current time/date - This is console specific and
 * will write ANSI colors
 *
 * @example
* getTime() // 01:59:20
*/
export function getTime () {

  const now = new Date();
  const hur = now.getHours();
  const min = now.getMinutes();
  const sec = now.getSeconds();

  return (
    (hur < 10 ? `0${hur}` : hur) +
    COL + (min < 10 ? `0${min}` : min) +
    COL + (sec < 10 ? `0${sec}` : sec)
  );
};

/**
 * Detect ANSI Codes
 *
 * Returns the regex expression or `false`
 *
 * @param string The string to detect ANSI occurances
 * @param option Whether or not to apply `g` flag
 */
export function detect (string: string, { onlyFirst = false } = {}) {

  const regexp = [
    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
    '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))'
  ];

  const ansi = string.match(new RegExp(regexp.join('|'), onlyFirst ? undefined : 'g'));

  return ansi !== null ? ansi : false;
}