@spare/markdown/index.js

Markdown table formatter

import { entriesMargin } from '@spare/entries-margin';
import { entriesPadder } from '@spare/entries-padder';
import { RTSP, LF, AEU } from '@texting/enum-chars';
import { liner } from '@texting/liner';
import { tableMargin } from '@spare/table-margin';
import { tablePadder } from '@spare/table-padder';
import { size } from '@vect/matrix-index';

class Markdown {

  /***
   *
   * @param {Object} ob
   * @param {Object} option
   *
   * @param {string} [option.dash=': ']
   *
   * @param {Function} [option.keyRead]
   * @param {Function} [option.read]
   *
   * @param {number} [option.head]
   * @param {number} [option.tail]
   *
   * @param {boolean} [option.ansi]
   * @param {number} [option.level=0]
   *
   * @param {string} [option.pad]
   * @param {string} [option.prefix]
   * @param {string} [option.suffix]
   *
   * @returns {string}
   */
  static object(ob = {}, option = {}) { return Markdown.entries(Object.entries(ob), option) }

  /***
   *
   * @param {[*,*][]} entries
   * @param {Object} option
   *
   * @param {string} [option.dash=': ']
   *
   * @param {Function} [option.keyRead]
   * @param {Function} [option.read]
   *
   * @param {number} [option.head]
   * @param {number} [option.tail]
   *
   * @param {boolean} [option.ansi]
   * @param {number} [option.level=0]
   *
   * @param {string} [option.pad]
   * @param {string} [option.prefix]
   * @param {string} [option.suffix]
   *
   * @returns {string}
   */
  static entries(entries = [], option = {}) {
    if (!entries?.length) return liner([], option)
    const delim = LF;
    const { dash = RTSP, level, prefix, suffix, pad } = option;
    entries = entriesMargin(entries, option); // use head, tail, keyRead, read, rule
    entries = pad ? entriesPadder(entries, option) : entries; // use ansi, fill
    return liner(
      entries.map(([ k, v ]) => (prefix ?? '') + k + dash + v.trimEnd() + (suffix ?? '')),
      { delim, level }
    )
  }
  /***
   *
   * @param {Object} table
   * @param {Object} option
   *
   *
   * @param {Function} [option.read]
   * @param {Function} [option.headRead]
   *
   * @param {number} [option.top]
   * @param {number} [option.bottom]
   * @param {number} [option.left]
   * @param {number} [option.right]
   *
   * @param {boolean} [option.ansi=true]
   * @param {boolean} [option.fullAngle]
   * @param {number} [option.level=0]
   *
   * @returns {string}
   */
  static table(table, option = {}) {
    if (!table) return AEU
    let matrix = table.rows || table.matrix, banner = table.head || table.banner;
    const [ height, width ] = size(matrix), labelWidth = banner?.length;
    if (!height || !width || !labelWidth) return AEU
    table = tableMargin(table, option); // use: top, left, bottom ,right, read, headRead
    let { head, rule, rows } = tablePadder(table, option);// use: ansi, full
    return Liner({ delim: LF, level: option.level })([
      '| ' + head.join(' | ') + ' |',
      '| ' + rule.join(' | ') + ' |',
      ...rows.map(row => '| ' + row.join(' | ') + ' |')
    ])
  }
}

export { Markdown };