cli-ux/lib/table.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const ts_lodash_1 = require("ts-lodash");
const deps_1 = require("./deps");
/**
 * Generates a Unicode table and feeds it into configured printer.
 *
 * Top-level arguments:
 *
 * @arg {Object[]} data - the records to format as a table.
 * @arg {Object} options - configuration for the table.
 *
 * @arg {Object[]} [options.columns] - Options for formatting and finding values for table columns.
 * @arg {function(string)} [options.headerAnsi] - Zero-width formattter for entire header.
 * @arg {string} [options.colSep] - Separator between columns.
 * @arg {function(row, options)} [options.after] - Function called after each row is printed.
 * @arg {function(string)} [options.printLine] - Function responsible for printing to terminal.
 * @arg {function(cells)} [options.printHeader] - Function to print header cells as a row.
 * @arg {function(cells)} [options.printRow] - Function to print cells as a row.
 *
 * @arg {function(row)|string} [options.columns[].key] - Path to the value in the row or function to retrieve the pre-formatted value for the cell.
 * @arg {function(string)} [options.columns[].label] - Header name for column.
 * @arg {function(string, row)} [options.columns[].format] - Formatter function for column value.
 * @arg {function(row)} [options.columns[].get] - Function to return a value to be presented in cell without formatting.
 *
 */
function table(stream, data, inputOptions = {}) {
    const options = Object.assign({}, inputOptions, { columns: (inputOptions.columns || []).map(c => (Object.assign({ format: (value) => (value ? value.toString() : ''), width: 0, label: function () {
                return this.key.toString();
            }, get: function (row) {
                let value;
                let path = ts_lodash_1.default.result(this, 'key');
                if (!path) {
                    value = row;
                }
                else {
                    value = ts_lodash_1.default.get(row, path);
                }
                return this.format(value, row);
            } }, c))), colSep: '  ', after: () => { }, headerAnsi: ts_lodash_1.default.identity, printLine: (s) => stream.log(s), printRow: function (cells) {
            this.printLine(cells.join(this.colSep).trimRight());
        }, printHeader: function (cells) {
            this.printRow(cells.map(ts_lodash_1.default.ary(this.headerAnsi, 1)));
            this.printRow(cells.map(hdr => hdr.replace(/./g, '─')));
        } });
    function calcWidth(cell) {
        let lines = deps_1.default.stripAnsi(cell).split(/[\r\n]+/);
        let lineLengths = lines.map(ts_lodash_1.default.property('length'));
        return Math.max.apply(Math, lineLengths);
    }
    function pad(string, length) {
        let visibleLength = deps_1.default.stripAnsi(string).length;
        let diff = length - visibleLength;
        return string + ' '.repeat(Math.max(0, diff));
    }
    function render() {
        let columns = options.columns;
        if (typeof columns[0] === 'string') {
            columns = columns.map((key) => ({ key }));
        }
        for (let row of data) {
            row.height = 1;
            for (let col of columns) {
                let cell = col.get(row);
                col.width = Math.max(ts_lodash_1.default.result(col, 'label').length, col.width || 0, calcWidth(cell));
                row.height = Math.max(row.height || 0, cell.split(/[\r\n]+/).length);
            }
        }
        if (options.printHeader) {
            options.printHeader(columns.map(function (col) {
                let label = ts_lodash_1.default.result(col, 'label');
                return pad(label, col.width || label.length);
            }));
        }
        function getNthLineOfCell(n, row, col) {
            // TODO memoize this
            let lines = col.get(row).split(/[\r\n]+/);
            return pad(lines[n] || '', col.width);
        }
        for (let row of data) {
            for (let i = 0; i < (row.height || 0); i++) {
                let cells = columns.map(ts_lodash_1.default.partial(getNthLineOfCell, i, row));
                options.printRow(cells);
            }
            options.after(row, options);
        }
    }
    render();
}
exports.table = table;
module.exports = table;