util/bux/cli.ts

#!/usr/bin/env node

//////////////////////////////
// Cross-platform utilities //
//////////////////////////////

import * as path from "path";
import * as yargs from "yargs";
import {
    chmodx,
    configure,
    copyFiles,
    buildTranslations,
    gatherBuildResults,
    linkLocalProjects,
    mkdirp,
    moveFiles,
    rmrf,
    printStatus,
    unlinkLocalProjects,
    ConfigureCommandOptions,
} from "./util";

yargs
    .command({
        command: "status",
        describe:
            "Display information about the repositories managed through bux, " +
            "including paths, link status, and Git information.",
        handler: async () => {
            await printStatus();
        },
    })
    .command({
        command: "build-translations",
        aliases: ["translate"],
        describe:
            "Localize YAML files, convert them to RESJSON, and generate English JSON file",
        builder: (yargs: yargs.Argv) =>
            yargs
                .option("src", {
                    describe: "The source directory containing YAML files",
                    default: "",
                    demandOption: true,
                })
                .option("dest", {
                    describe:
                        "The destination directory for the English RESJSON file used by the localization team",
                    default: "",
                    demandOption: true,
                })
                .option("outputPath", {
                    describe:
                        "The directory that contains the generated English JSON translation file",
                    default: "",
                    demandOption: true,
                })
                .option("packageName", {
                    describe:
                        "The name of the module (e.g. bonito.core) that translations will be built for",
                    default: "",
                    demandOption: false,
                }),
        handler: (argv) =>
            buildTranslations(
                argv.src,
                argv.dest,
                argv.outputPath,
                argv.packageName
            ),
    })
    .command({
        command: "configure",
        aliases: ["config"],
        describe:
            "Configure CLI properties. If at least one configuration option " +
            "is specified, the configuration file is set or updated, without " +
            "a prompt",
        builder: (yargs: yargs.Argv) =>
            yargs
                .option("paths.batchExplorer", {
                    type: "string",
                    describe: "The path to Batch Explorer/Shared Libraries",
                })
                .option("print", {
                    type: "boolean",
                    describe: "Print the resultant configuration object",
                    default: false,
                }),
        handler: (argv) =>
            // KLUDGE: This should be properly typed
            configure(argv as unknown as ConfigureCommandOptions),
    })
    .command({
        command: "cp <src> <dest>",
        aliases: ["copy"],
        describe: "Copy files from one place to another",
        builder: (yargs: yargs.Argv) =>
            yargs
                .positional("sourcePath", {
                    describe: "The source path",
                    default: "",
                })
                .positional("destPath", {
                    describe: "The destination path",
                    default: "",
                }),
        handler: (argv) => copyFiles(argv.sourcePath, argv.destPath),
    })
    .command({
        command: "mv <src> <dest>",
        aliases: ["move"],
        describe: "Move file from one place to another",
        builder: (yargs: yargs.Argv) =>
            yargs
                .positional("sourcePath", {
                    describe: "The source path",
                    default: "",
                })
                .positional("destPath", {
                    describe: "The destination path",
                    default: "",
                }),
        handler: (argv) => moveFiles(argv.sourcePath, argv.destPath),
    })
    .command({
        command: "mkdirp <directory>",
        describe: "Create a directory (and any required parents)",
        builder: (yargs: yargs.Argv) =>
            yargs.positional("directory", {
                describe: "The directory to create",
                default: "",
            }),
        handler: (argv) => mkdirp(argv.directory),
    })
    .command({
        command: "rmrf <directory>",
        describe: "Remove a directory and all of its contents",
        builder: (yargs: yargs.Argv) =>
            yargs.positional("directory", {
                describe: "The directory to remove",
                default: "",
            }),
        handler: (argv) => rmrf(argv.directory),
    })
    .command({
        command: "gather-build-results [basePath]",
        describe: "Collects build/test output into a top-level build directory",
        builder: (yargs: yargs.Argv) =>
            yargs.positional("basePath", {
                describe: "The directory from which to gather build results",
                default: "",
            }),
        handler: (argv) => gatherBuildResults(path.resolve(argv.basePath)),
    })
    .command({
        command: "link",
        describe: "Link local projects for local development",
        handler: () => linkLocalProjects(),
    })
    .command({
        command: "unlink",
        describe: "Unlink local projects (and replace with remote)",
        handler: () => unlinkLocalProjects(),
    })
    .command({
        command: "chmodx [path..]",
        describe: "Make a file executable",
        builder: (yargs: yargs.Argv) =>
            yargs.positional("path", {
                describe: "File or files to make executable",
            }),
        handler: (argv) => chmodx(argv.path),
    })
    .help()
    .alias("h", "help")
    .alias("v", "version")
    .demandCommand().argv;