index.js

#! /usr/bin/env node
const yargs = require('yargs');
const path = require('path')
const chalk = require('chalk');

const Stepper = require('./lib/read/stepper');
const Reporter = require('./lib/read/reporter');

const transformers = require('./lib/transformers');

(async () => {

    yargs.command('report <doc> [html]', 'Test markdown/steps file and report feedback into rendered output', 
        (yargs) => {
            yargs.positional('html', {
                describe: 'html file to execute'
            })        
        }, 
        async (argv) => {
            await docable(argv, true);
        })
        .option({
            output: {
                alias: 'o',
                describe: 'output report path',
                type: 'string'
            }
        });

    yargs.command('run <doc> [html]', 'Execute markdown/steps file', 
        (yargs) => {
            yargs.positional('html', {
                describe: 'html file to execute'
            })        
        }, 
        async (argv) => {
            await docable(argv, false);
        })
        .option({
            output: {
                alias: 'o',
                describe: 'output report path',
                type: 'string'
            }
        });

    // Turn on help and access argv
    yargs.help().argv;

})();

async function fromHtml($, setup, cwd, docDir, onProgress, vars, stdioStreams) {

    let cells = [];
    $('[data-docable="true"]').each(function (index, elem) {
        cells.push({
            index: index,
            content: $(elem).text().trim(),
            ...$(elem).data(),
            elem,
            id: $(elem).attr('id')
        });
    });

    let stepper = new Stepper();
    if( onProgress ) {
        stepper.progress.on('data', onProgress );
    }
    let connectors = await stepper.buildConnector(setup, cwd, docDir);

    /* let { results, _, status } */
    return stepper.runSteps(cells, $, connectors, cwd, undefined, vars, stdioStreams);
}


async function docable(options, report, verbose = true) {
    let stepper = new Stepper(path.resolve(options.doc), options.html ? path.resolve(options.html) : undefined);
    await stepper.setup(options.setupObj);
    const { $, results, status } = await stepper.run(options.stepIndex);

    // print execution results in console
    if (verbose) {
        const passingCount = results.filter(r => r.result.status).length;
        const failingCount = results.filter(r => !r.result.status).length;
        const summaryColor = failingCount > 0 ? 'red' : 'green';

        // print summary of tasks
        console.log(chalk`{${summaryColor} \nSummary: ${Number((100 * passingCount / results.length).toFixed(1))}% of all tasks passed.} ` +
            chalk`{${summaryColor} ${passingCount} passed - ${failingCount} failed.}`);
    }

    if (report) {
        const reporter = new Reporter($, results);
        await reporter.report(options.output);
    }

    process.exitCode = status ? 0 : 1;

    // TODO:
    // await stepper.tearDown();

    return results;
}

module.exports = {docable, transformers, Stepper, fromHtml};