@stencila/dockter/dist/cli.js

#!/usr/bin/env node
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const os_1 = __importDefault(require("os"));
const path_1 = __importDefault(require("path"));
// @ts-ignore
const yargonaut_1 = __importDefault(require("yargonaut"));
const yargs_1 = __importDefault(require("yargs"));
const js_yaml_1 = __importDefault(require("js-yaml"));
const VERSION = require('../package').version;
const DockerCompiler_1 = __importDefault(require("./DockerCompiler"));
const errors_1 = require("./errors");
const CachingUrlFetcher_1 = __importDefault(require("./CachingUrlFetcher"));
const cli_nix_1 = __importDefault(require("./cli-nix"));
const compiler = new DockerCompiler_1.default(new CachingUrlFetcher_1.default());
yargonaut_1.default
    .style('blue')
    .helpStyle('green')
    .errorsStyle('red');
yargs_1.default
    .scriptName('dockter')
    // Help global option
    .alias('h', 'help')
    .usage('$0 <cmd> [args]')
    // Version global option
    .alias('v', 'version')
    .version(VERSION)
    .describe('version', 'Show version')
    // Nix global option
    .option('nix', {
    describe: 'Use NixOS base image'
})
    // Ensure at least one command
    .demandCommand(1, 'Please provide a command.')
    // Provide suggestions regarding similar commands if no matching command is found
    .recommendCommands()
    // Any command-line argument given that is not demanded, or does not have a corresponding description, will be reported as an error.
    // Unrecognized commands will also be reported as errors.
    .strict()
    // Compile command
    // @ts-ignore
    .command('compile [folder]', 'Compile a project to a software environment', yargs => {
    folderArg(yargs);
}, async (args) => {
    const folder = path_1.default.resolve(args.folder);
    let environ = await compiler.compile('file://' + folder, false).catch(error);
    if (args.nix) {
        cli_nix_1.default.compile(environ, folder);
    }
})
    // Build command
    // @ts-ignore
    .command('build [folder]', 'Build a Docker image for project', yargs => {
    folderArg(yargs);
}, async (args) => {
    const folder = path_1.default.resolve(args.folder);
    if (args.nix) {
        await cli_nix_1.default.build(folder);
    }
    else {
        await compiler.compile('file://' + folder, true).catch(error);
    }
})
    // Execute command
    // @ts-ignore
    .command('execute [folder] [command]', 'Execute a project', yargs => {
    folderArg(yargs),
        yargs.positional('command', {
            type: 'string',
            default: '',
            describe: 'The command to execute'
        });
}, async (args) => {
    const folder = path_1.default.resolve(args.folder);
    if (args.nix) {
        await cli_nix_1.default.execute(folder, args.command);
    }
    else {
        const node = await compiler.execute('file://' + folder, args.command).catch(error);
        output(node, args.format);
    }
})
    // Who command
    // @ts-ignore
    .command('who [folder]', 'List the people your project depends upon', yargs => {
    folderArg(yargs);
    yargs.option('depth', {
        alias: 'd',
        type: 'integer',
        default: 100,
        describe: 'The maximum dependency recursion depth'
    });
}, async (args) => {
    const folder = path_1.default.resolve(args.folder);
    const people = await compiler.who('file://' + folder, args.depth).catch(error);
    if (!people) {
        console.log('Nobody (?)');
    }
    else {
        // Sort by number of packages descending and then alphabetically ascending
        let sorted = Object.entries(people).sort(([aName, aPkgs], [bName, bPkgs]) => {
            if (aPkgs.length > bPkgs.length)
                return -1;
            if (aPkgs.length < bPkgs.length)
                return 1;
            if (aName < bName)
                return -1;
            if (aName > bName)
                return 1;
            return 0;
        });
        // Output in a CLI friendly way
        const output = sorted.map(([name, packages]) => {
            return `${name} (${packages.join(', ')})`;
        }).join(', ');
        console.log(output);
    }
})
    .parse();
/**
 * Specify the [folder] argument settings
 *
 * @param yargs The yargs object
 */
function folderArg(yargs) {
    yargs.positional('folder', {
        type: 'string',
        default: '.',
        describe: 'The path to the project folder'
    });
}
/**
 * Print output to stdout
 *
 * @param object The object to print
 * @param format The format use: `json` or `yaml`
 */
function output(object, format = 'json') {
    if (object)
        console.log(format === 'yaml' ? js_yaml_1.default.safeDump(object, { lineWidth: 120 }) : JSON.stringify(object, null, '  '));
}
/**
 * Print an error to stderr
 *
 * @param error The error to print
 */
function error(error) {
    if (error instanceof errors_1.ApplicationError) {
        console.error(error.message);
    }
    else {
        console.error('Woops, sorry something went wrong :(');
        console.error('Please help us fix this issue by posting this output to https://github.com/stencila/dockter/issues/new');
        console.error(`  args: ${process.argv.slice(2).join(' ')}`);
        console.error(`  version: ${VERSION}`);
        console.error(`  platform: ${os_1.default.platform()}`);
        console.error(error);
        process.exit(1);
    }
}