smartarg/SmartArg.js

Forked repo of Arg, with smart help and version logging

"use strict";
Object.defineProperty(exports, "__esModule", {value: true});
const Arg_1 = require("./Arg");
var Arg_2 = require("./Arg");
exports.COUNT = Arg_2.COUNT;
exports.flag = Arg_2.flag;
class default_1 {
    constructor() {
        this.args = [];
        this._examples = [];
        this._primary = 1;
        this._secondary = 33;
    }
    name(name) {
        this._name = name;
        return this;
    }
    version(version) {
        this._version = version;
        return this;
    }
    description(description) {
        this._description = description;
        return this;
    }
    usage(usage) {
        this._usage = usage;
        return this;
    }
    example(example, description) {
        this._examples.push([example, description]);
        return this;
    }
    primary(color) {
        this._primary = color;
        return this;
    }
    secondary(color) {
        this._secondary = color;
        return this;
    }
    option(flags, valueType, description = undefined) {
        if (flags.length > 2)
            throw new Error("There can't be more than 2 flags for a command");
        if (flags.length == 2 && flags[0].length != 2)
            throw new Error("Short flag can't be smaller or greater than 1 char");
        //long, short | undefined, value type, desc
        // @ts-ignore
        this.args.push([flags.pop(), flags.pop(), valueType, description]);
        return this;
    }
    parse(options = undefined) {
        const spec = {};
        this.args.forEach(arg => {
            // @ts-ignore
            spec[arg[0]] = arg[2];
            if (arg[1])
                spec[arg[1]] = arg[0];
        });
        return Arg_1.arg(spec, options);
    }
    smartParse(options = undefined) {
        this.option(["-h", "--help"], Boolean, "print help");
        this.option(["-v", "--version"], Boolean, "print version");
        const args = this.parse(options);
        if (args["--help"]) {
            let mini_name;
            if (!this._name)
                throw new Error("name not provided");
            if (!this._version)
                throw new Error("version not provided");
            if (!this._description)
                throw new Error("description not provided");
            this._usage = this._usage || `${mini_name = this._name.toLowerCase().replace(/\s/g, '')} <flag>`;
            if (!this._examples.length) {
                this._examples.push([`$ ${mini_name || (mini_name = this._name.toLowerCase().replace(/\s/g, ''))} -h`, "Print Help"]);
                this._examples.push([`$ ${mini_name} -v`, "Print Version"]);
            }
            this.displayHelp();
        } else if (args["--version"])
            console.log(this._version);
        else
            return args;
        process.exit(0);
    }
    displayHelp() {
        process.stdout.write("\n");
        printHeading(this._primary, this._name);
        printChild(0, this._description, "");
        printHeading(this._primary, "Usage :");
        printChild(0, this._usage, "");
        printHeading(this._primary, "Version :");
        printChild(0, this._version, "");
        printHeading(this._primary, "Option(s) :");
        this.args.forEach(arg => {
            printChild(this._secondary, `${arg[1] ? `${arg[1]}, ` : ""}${arg[0]}`, arg[3]);
        });
        if (this._examples.length) {
            printHeading(this._primary, "Example(s) :");
            this._examples.forEach(example => {
                printChild(this._secondary, example[0], example[1]);
            });
        }
        process.stdout.write("\n");
    }
}
exports.default = default_1;
function printHeading(color, msg) {
    process.stdout.write(`\n    \x1b[${color}m${msg}\x1b[0m`);
}
exports.printHeading = printHeading;
function printChild(color, msg, value = undefined) {
    process.stdout.write(`\n\t  \x1b[${color}m${msg}\x1b[0m\n\t\t${value ? value + "\n" : ""}`);
}
exports.printChild = printChild;