observatory/lib/out.js

Beautiful UI for showing tasks running on the command line.

'use strict';

var chalk = require('chalk');
var OS = require('os');
var settings = require('./settings');

/**
 * figure out how many lines a string of text will use
 * @param text
 * @returns {number}
 */
function height(text) {
    // todo: text might include \n
    return Math.ceil(ln(text)/process.stdout.columns );
}

function writeln(currentLine, text) {
    currentLine += height(text);
    write(text + OS.EOL);
    return currentLine;
}

function write(text) {
    if (settings.write) {
        settings.write(text);
    }
}

function ln(text) {
    return chalk.stripColor(text || '').length;
}

function padding(n) {
    return n > 0 ? (new Array(n)).join(' ') : '';
}

module.exports = {
    height: height,
    writeln: writeln,
    write: write,
    ln: ln,
    padding: padding
};