massarg 1.0.7-pre.1 → 2.0.0-pre.2

package/command.js

@@ -0,0 +1,319 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MassargHelpCommand = exports.MassargCommand = exports.CommandConfig = void 0;
+const zod_1 = require("zod");
+const error_1 = require("./error");
+const help_1 = require("./help");
+const option_1 = require("./option");
+const utils_1 = require("./utils");
+const example_1 = require("./example");
+const CommandConfig = (args) => zod_1.z.object({
+    /** Command name */
+    name: zod_1.z.string(),
+    /** Command description, displayed in the help output */
+    description: zod_1.z.string(),
+    /** Command aliases */
+    aliases: zod_1.z.string().array().optional(),
+    /**
+     * Function used when invoking this command. It receives the parsed options and the primary
+     * instance of Massarg used to invoke this command (the top-level instance)
+     */
+    run: zod_1.z
+        .function()
+        .args(args, zod_1.z.any())
+        .returns(zod_1.z.union([zod_1.z.promise(zod_1.z.void()), zod_1.z.void()])),
+});
+exports.CommandConfig = CommandConfig;
+/**
+ * A command is a named function that can be invoked with a set of options.
+ *
+ * Commands can have sub-commands, which can have their own sub-commands, and so on.
+ *
+ * Options are not inherited by sub-commands, but their parsed values are passed down when
+ * invoking a sub-command. This works recursively.
+ *
+ * @example
+ * ```ts
+ * massarg(options).command({
+ *   name: 'foo',
+ *   description: 'foo command',
+ *   run: (options, instance) => {
+ *     console.log(options, instance)
+ *   },
+ * })
+ * ```
+ */
+class MassargCommand {
+    constructor(options, parent) {
+        this.commands = [];
+        this.options = [];
+        this.examples = [];
+        this.args = {};
+        (0, exports.CommandConfig)(zod_1.z.any()).parse(options);
+        this.name = options.name;
+        this.description = options.description;
+        this.aliases = options.aliases ?? [];
+        this._run = options.run;
+        this._helpConfig = {};
+        this.parent = parent;
+    }
+    get helpConfig() {
+        if (this.parent) {
+            return (0, utils_1.deepMerge)(this.parent.helpConfig, this._helpConfig);
+        }
+        return (0, utils_1.deepMerge)(help_1.defaultHelpConfig, this._helpConfig);
+    }
+    command(config) {
+        try {
+            const command = config instanceof MassargCommand ? config : new MassargCommand(config);
+            const existing = this.commands.find((c) => c.name === command.name);
+            if (existing) {
+                throw new error_1.ValidationError({
+                    code: 'duplicate_command',
+                    message: `Command "${command.name}" already exists`,
+                    path: [this.name, command.name],
+                });
+            }
+            command.parent = this;
+            this.commands.push(command);
+            return this;
+        }
+        catch (e) {
+            if ((0, error_1.isZodError)(e)) {
+                throw new error_1.ValidationError({
+                    path: [this.name, config.name, ...e.issues[0].path.map((p) => p.toString())],
+                    code: e.issues[0].code,
+                    message: e.issues[0].message,
+                });
+            }
+            throw e;
+        }
+    }
+    flag(config) {
+        try {
+            const flag = config instanceof option_1.MassargFlag ? config : new option_1.MassargFlag(config);
+            const existing = this.options.find((c) => c.name === flag.name);
+            if (existing) {
+                throw new error_1.ValidationError({
+                    code: 'duplicate_flag',
+                    message: `Flag "${flag.name}" already exists`,
+                    path: [this.name, flag.name],
+                });
+            }
+            this.options.push(flag);
+            return this;
+        }
+        catch (e) {
+            if ((0, error_1.isZodError)(e)) {
+                throw new error_1.ValidationError({
+                    path: [this.name, config.name, ...e.issues[0].path.map((p) => p.toString())],
+                    code: e.issues[0].code,
+                    message: e.issues[0].message,
+                });
+            }
+            throw e;
+        }
+    }
+    option(config) {
+        try {
+            const option = config instanceof option_1.MassargOption
+                ? config
+                : option_1.MassargOption.fromTypedConfig(config);
+            const existing = this.options.find((c) => c.name === option.name);
+            if (existing) {
+                throw new error_1.ValidationError({
+                    code: 'duplicate_option',
+                    message: `Option "${option.name}" already exists`,
+                    path: [this.name, option.name],
+                });
+            }
+            if (option.isDefault) {
+                const defaultOption = this.options.find((o) => o.isDefault);
+                if (defaultOption) {
+                    throw new error_1.ValidationError({
+                        code: 'duplicate_default_option',
+                        message: `Option "${option.name}" cannot be set as default because option "${defaultOption.name}" is already set as default`,
+                        path: [this.name, option.name],
+                    });
+                }
+            }
+            this.options.push(option);
+            return this;
+        }
+        catch (e) {
+            if ((0, error_1.isZodError)(e)) {
+                throw new error_1.ValidationError({
+                    path: [this.name, config.name, ...e.issues[0].path.map((p) => p.toString())],
+                    code: e.issues[0].code,
+                    message: e.issues[0].message,
+                });
+            }
+            throw e;
+        }
+    }
+    /**
+     * Adds an example to this command.
+     *
+     * An example is a description of how to use the command, with an example input and output.
+     *
+     * At least one of `description`, `input` or `output` must be provided, but neither alone is
+     * required.
+     */
+    example(config) {
+        this.examples.push(new example_1.MassargExample(config));
+        return this;
+    }
+    /**
+     * Configure the help output for this (and all child) commands.
+     *
+     * You can automatically bind the help command to this command, and/or bind the help option
+     * to this command.
+     *
+     * If you don't opt-in to this behavior with `bindCommand` or `bindOption`, you can still
+     * access the help output via `this.helpString()` and `this.printHelp()`.
+     */
+    help(config) {
+        this._helpConfig = help_1.HelpConfig.parse(config);
+        if (this.helpConfig.bindCommand) {
+            this.command(new MassargHelpCommand());
+        }
+        if (this.helpConfig.bindOption) {
+            this.option(new option_1.MassargHelpFlag());
+        }
+        return this;
+    }
+    /**
+     * Configure the main function for this command. This command will run when no sub-commands
+     * are provided.
+     *
+     * If none is provided, help will be printed.
+     */
+    main(run) {
+        this._run = run;
+        return this;
+    }
+    /**
+     * Parse the given arguments and run the command or sub-commands along with the given options
+     * and flags.
+     *
+     * To parse the arguments without running any commands and only get the output args,
+     * use `getArgs` instead.
+     */
+    parse(argv, args, parent) {
+        this.getArgs(argv, args, parent, true);
+    }
+    parseOption(arg, argv) {
+        const option = this.options.find((o) => o._match(arg));
+        if (!option) {
+            throw new error_1.ValidationError({
+                path: [option_1.MassargOption.getName(arg)],
+                code: 'unknown_option',
+                message: 'Unknown option',
+            });
+        }
+        const res = option._parseDetails([arg, ...argv], { ...this.args });
+        this.args[res.key] = (0, utils_1.setOrPush)(res.value, this.args[res.key], option.isArray);
+        return res.argv;
+    }
+    getArgs(argv, args, parent, parseCommands = false) {
+        let _args = { ...this.args, ...args };
+        let _argv = [...argv];
+        const _a = this.args;
+        // fill defaults
+        for (const option of this.options) {
+            if (option.defaultValue !== undefined && _a[option.name] === undefined) {
+                _args[option.getOutputName()] = option.defaultValue;
+            }
+        }
+        // parse options
+        while (_argv.length) {
+            const arg = _argv.shift();
+            // make sure option exists
+            const found = this.options.some((o) => o._isOption(arg));
+            if (found) {
+                _argv = this.parseOption(arg, _argv);
+                _args = { ..._args, ...this.args };
+                continue;
+            }
+            // if not, try see if it's a command
+            const command = this.commands.find((c) => c.name === arg || c.aliases.includes(arg));
+            if (command) {
+                // this is dry run, just exit
+                if (!parseCommands) {
+                    return command.getArgs(_argv, this.args, parent ?? this, false);
+                    // break
+                }
+                // this is real run, parse command, pass unparsed args
+                return command.parse(_argv, this.args, parent ?? this);
+            }
+            // default option - passes arg value even without flag name
+            const defaultOption = this.options.find((o) => o.isDefault);
+            if (defaultOption) {
+                _argv = this.parseOption(`--${defaultOption.name}`, [arg, ..._argv]);
+                continue;
+            }
+            // not parsed by any step, add to extra key
+            _a.extra ??= [];
+            _a.extra.push(arg);
+        }
+        // merge args
+        this.args = { ...this.args, ..._args };
+        // dry run, just exit
+        if (!parseCommands) {
+            return this.args;
+        }
+        // no sub command found, run main command
+        if (this._run) {
+            this._run(this.args, parent ?? this);
+        }
+    }
+    /**
+     * Generate the help output for this command, and return it as a string.
+     */
+    helpString() {
+        return new help_1.HelpGenerator(this).generate();
+    }
+    /**
+     * Print the help output for this command.
+     */
+    printHelp() {
+        console.log(this.helpString());
+    }
+}
+exports.MassargCommand = MassargCommand;
+class MassargHelpCommand extends MassargCommand {
+    constructor(config = {}) {
+        super({
+            name: 'help',
+            aliases: ['h'],
+            description: 'Print help for this command, or a subcommand if specified',
+            run: (args, parent) => {
+                if (args.command) {
+                    const command = parent.commands.find((c) => c.name === args.command);
+                    if (command) {
+                        command.printHelp();
+                        return;
+                    }
+                    else {
+                        throw new error_1.ParseError({
+                            path: ['command'],
+                            code: 'unknown_command',
+                            message: 'Unknown command',
+                            received: args.command,
+                        });
+                    }
+                }
+                parent.printHelp();
+            },
+            ...config,
+        });
+        this.option({
+            name: 'command',
+            aliases: ['c'],
+            description: 'Command to print help for',
+            isDefault: true,
+        });
+    }
+}
+exports.MassargHelpCommand = MassargHelpCommand;
+//# sourceMappingURL=command.js.map

package/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,mCAAiE;AACjE,iCAAqE;AACrE,qCAMiB;AACjB,mCAA4D;AAC5D,uCAAyD;AAElD,MAAM,aAAa,GAAG,CAA0C,IAAwB,EAAE,EAAE,CACjG,OAAC,CAAC,MAAM,CAAC;IACP,mBAAmB;IACnB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,wDAAwD;IACxD,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,sBAAsB;IACtB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACtC;;;OAGG;IACH,GAAG,EAAE,OAAC;SACH,QAAQ,EAAE;SACV,IAAI,CAAC,IAAI,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC;SACnB,OAAO,CAAC,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,OAAC,CAAC,IAAI,EAAE,CAAC,EAAE,OAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAA+B;CACnF,CAAC,CAAA;AAhBS,QAAA,aAAa,iBAgBtB;AAaJ;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,cAAc;IAYzB,YAAY,OAA4B,EAAE,MAA4B;QAPtE,aAAQ,GAA0B,EAAE,CAAA;QACpC,YAAO,GAAoB,EAAE,CAAA;QAC7B,aAAQ,GAAqB,EAAE,CAAA;QAC/B,SAAI,GAAkB,EAAE,CAAA;QAKtB,IAAA,qBAAa,EAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACrC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAA;QACpC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,IAAI,UAAU;QACZ,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,IAAA,iBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;SAC3D;QACD,OAAO,IAAA,iBAAS,EAAC,wBAAiB,EAAE,IAAI,CAAC,WAAW,CAAyB,CAAA;IAC/E,CAAC;IAaD,OAAO,CACL,MAA4C;QAE5C,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,YAAY,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;YACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;YACnE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,mBAAmB;oBACzB,OAAO,EAAE,YAAY,OAAO,CAAC,IAAI,kBAAkB;oBACnD,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC;iBAChC,CAAC,CAAA;aACH;YACD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAA;YACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,IAAA,kBAAU,EAAC,CAAC,CAAC,EAAE;gBACjB,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oBACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;iBAC7B,CAAC,CAAA;aACH;YACD,MAAM,CAAC,CAAA;SACR;IACH,CAAC;IAeD,IAAI,CACF,MAAwE;QAExE,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,YAAY,oBAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,oBAAW,CAAC,MAAM,CAAC,CAAA;YAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAA;YAC/D,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,SAAS,IAAI,CAAC,IAAI,kBAAkB;oBAC7C,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;iBAC7B,CAAC,CAAA;aACH;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAqB,CAAC,CAAA;YACxC,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,IAAA,kBAAU,EAAC,CAAC,CAAC,EAAE;gBACjB,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oBACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;iBAC7B,CAAC,CAAA;aACH;YACD,MAAM,CAAC,CAAA;SACR;IACH,CAAC;IAmBD,MAAM,CACJ,MAAqD;QAErD,IAAI;YACF,MAAM,MAAM,GACV,MAAM,YAAY,sBAAa;gBAC7B,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,sBAAa,CAAC,eAAe,CAAC,MAAiC,CAAC,CAAA;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAA;YACjE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,WAAW,MAAM,CAAC,IAAI,kBAAkB;oBACjD,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;iBAC/B,CAAC,CAAA;aACH;YACD,IAAI,MAAM,CAAC,SAAS,EAAE;gBACpB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;gBAC3D,IAAI,aAAa,EAAE;oBACjB,MAAM,IAAI,uBAAe,CAAC;wBACxB,IAAI,EAAE,0BAA0B;wBAChC,OAAO,EAAE,WAAW,MAAM,CAAC,IAAI,8CAA8C,aAAa,CAAC,IAAI,6BAA6B;wBAC5H,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;qBAC/B,CAAC,CAAA;iBACH;aACF;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAuB,CAAC,CAAA;YAC1C,OAAO,IAAI,CAAA;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,IAAA,kBAAU,EAAC,CAAC,CAAC,EAAE;gBACjB,MAAM,IAAI,uBAAe,CAAC;oBACxB,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;oBACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;iBAC7B,CAAC,CAAA;aACH;YACD,MAAM,CAAC,CAAA;SACR;IACH,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAqB;QAC3B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,wBAAc,CAAC,MAAM,CAAC,CAAC,CAAA;QAC9C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAkB;QACrB,IAAI,CAAC,WAAW,GAAG,iBAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAE3C,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE;YAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAA;SACvC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,wBAAe,EAAE,CAAC,CAAA;SACnC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,GAAiB;QACpB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;QACf,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAc,EAAE,IAAoB,EAAE,MAA6B;QACvE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAEO,WAAW,CAAC,GAAW,EAAE,IAAc;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;QACtD,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,uBAAe,CAAC;gBACxB,IAAI,EAAE,CAAC,sBAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,gBAAgB;aAC1B,CAAC,CAAA;SACH;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAClE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAiB,CAAC,GAAG,IAAA,iBAAS,EAC1C,GAAG,CAAC,KAAK,EACT,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAiB,CAAC,EAChC,MAAM,CAAC,OAAO,CACf,CAAA;QACD,OAAO,GAAG,CAAC,IAAI,CAAA;IACjB,CAAC;IAeD,OAAO,CACL,IAAc,EACd,IAAoB,EACpB,MAA4B,EAC5B,aAAa,GAAG,KAAK;QAErB,IAAI,KAAK,GAAS,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,EAAU,CAAA;QACnD,IAAI,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAgC,CAAA;QAEhD,gBAAgB;QAChB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;gBACtE,KAAK,CAAC,MAAM,CAAC,aAAa,EAAgB,CAAC,GAAG,MAAM,CAAC,YAAgC,CAAA;aACtF;SACF;QAED,gBAAgB;QAChB,OAAO,KAAK,CAAC,MAAM,EAAE;YACnB,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAG,CAAA;YAC1B,0BAA0B;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;YACxD,IAAI,KAAK,EAAE;gBACT,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBACpC,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;gBAClC,SAAQ;aACT;YAED,oCAAoC;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;YACpF,IAAI,OAAO,EAAE;gBACX,6BAA6B;gBAC7B,IAAI,CAAC,aAAa,EAAE;oBAClB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,IAAI,EAAE,KAAK,CAAC,CAAA;oBAC/D,QAAQ;iBACT;gBACD,sDAAsD;gBACtD,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,CAAA;aACvD;YACD,2DAA2D;YAC3D,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAC3D,IAAI,aAAa,EAAE;gBACjB,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAA;gBACpE,SAAQ;aACT;YACD,2CAA2C;YAC3C,EAAE,CAAC,KAAK,KAAK,EAAE,CAAA;YACf,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACnB;QACD,aAAa;QACb,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,KAAK,EAAE,CAAA;QACtC,qBAAqB;QACrB,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,IAAI,CAAC,IAAY,CAAA;SACzB;QAED,yCAAyC;QACzC,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAY,EAAE,MAAM,IAAI,IAAI,CAAC,CAAA;SAC7C;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,oBAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;IAC3C,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;IAChC,CAAC;CACF;AAvUD,wCAuUC;AAED,MAAa,kBAEX,SAAQ,cAAiB;IACzB,YAAY,SAAiD,EAAE;QAC7D,KAAK,CAAC;YACJ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,GAAG,CAAC;YACd,WAAW,EAAE,2DAA2D;YACxE,GAAG,EAAE,CAAC,IAA0B,EAAE,MAAM,EAAE,EAAE;gBAC1C,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,CAAA;oBACpE,IAAI,OAAO,EAAE;wBACX,OAAO,CAAC,SAAS,EAAE,CAAA;wBACnB,OAAM;qBACP;yBAAM;wBACL,MAAM,IAAI,kBAAU,CAAC;4BACnB,IAAI,EAAE,CAAC,SAAS,CAAC;4BACjB,IAAI,EAAE,iBAAiB;4BACvB,OAAO,EAAE,iBAAiB;4BAC1B,QAAQ,EAAE,IAAI,CAAC,OAAO;yBACvB,CAAC,CAAA;qBACH;iBACF;gBACD,MAAM,CAAC,SAAS,EAAE,CAAA;YACpB,CAAC;YACD,GAAG,MAAM;SACV,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC,GAAG,CAAC;YACd,WAAW,EAAE,2BAA2B;YACxC,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;IACJ,CAAC;CACF;AAlCD,gDAkCC"}

package/error.d.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export type ValidationErrorOptions = {
+    path: string[];
+    code: string;
+    message: string;
+};
+/** This error is thrown when a validation fails. */
+export declare class ValidationError extends Error {
+    /** The path to the value that failed validation. */
+    path: string[];
+    /** The error code. */
+    code: string;
+    /** The error message. */
+    message: string;
+    constructor({ path, code, message }: ValidationErrorOptions);
+}
+export type ParseErrorOptions = {
+    path: string[];
+    code: string;
+    message: string;
+    received?: unknown;
+};
+/** This error is thrown when a parse fails on an option value. */
+export declare class ParseError extends Error {
+    /** The path to the value that failed parsing. */
+    path: string[];
+    /** The error code. */
+    code: string;
+    /** The error message. */
+    message: string;
+    /** The value that failed parsing. */
+    received: unknown;
+    constructor({ path, code, message, received }: ParseErrorOptions);
+}
+export declare function isZodError(e: unknown): e is z.ZodError;
+//# sourceMappingURL=error.d.ts.map

package/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,sBAAsB,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtF,oDAAoD;AACpD,qBAAa,eAAgB,SAAQ,KAAK;IACxC,oDAAoD;IACpD,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAA;gBAEH,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,sBAAsB;CAQ5D;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,kEAAkE;AAClE,qBAAa,UAAW,SAAQ,KAAK;IACnC,iDAAiD;IACjD,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,qCAAqC;IACrC,QAAQ,EAAE,OAAO,CAAA;gBAEL,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,iBAAiB;CAYjE;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAEtD"}

package/error.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isZodError = exports.ParseError = exports.ValidationError = void 0;
+const zod_1 = require("zod");
+/** This error is thrown when a validation fails. */
+class ValidationError extends Error {
+    constructor({ path, code, message }) {
+        const msg = `${path.join('.')}: ${message}`;
+        super(msg);
+        this.path = path;
+        this.code = code;
+        this.message = msg;
+        this.name = 'ValidationError';
+    }
+}
+exports.ValidationError = ValidationError;
+/** This error is thrown when a parse fails on an option value. */
+class ParseError extends Error {
+    constructor({ path, code, message, received }) {
+        let msg = `${path.join('.')}: ${message}`;
+        if (received) {
+            msg += ` (received: ${received})`;
+        }
+        super(msg);
+        this.path = path;
+        this.code = code;
+        this.message = msg;
+        this.name = 'ParseError';
+        this.received = received;
+    }
+}
+exports.ParseError = ParseError;
+function isZodError(e) {
+    return e instanceof zod_1.z.ZodError;
+}
+exports.isZodError = isZodError;
+//# sourceMappingURL=error.js.map

package/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAIvB,oDAAoD;AACpD,MAAa,eAAgB,SAAQ,KAAK;IAQxC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAA0B;QACzD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAA;QAC3C,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAA;QAClB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;AAhBD,0CAgBC;AASD,kEAAkE;AAClE,MAAa,UAAW,SAAQ,KAAK;IAUnC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAqB;QAC9D,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAA;QACzC,IAAI,QAAQ,EAAE;YACZ,GAAG,IAAI,eAAe,QAAQ,GAAG,CAAA;SAClC;QACD,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAA;QAClB,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAtBD,gCAsBC;AAED,SAAgB,UAAU,CAAC,CAAU;IACnC,OAAO,CAAC,YAAY,OAAC,CAAC,QAAQ,CAAA;AAChC,CAAC;AAFD,gCAEC"}

package/example.d.ts

@@ -0,0 +1,31 @@
+import z from 'zod';
+export declare const ExampleConfig: z.ZodObject<{
+    /** Description of the example. This will appear as a title above the input/output line(s). */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * Input of the example. This will appear as a line below the description, with a `$` prefix.
+     * The prefix can be changed using the `help()` function on the command.
+     */
+    input: z.ZodOptional<z.ZodString>;
+    /**
+     * Output of the example. This will appear as a line below the input, with a `>` prefix.
+     * The prefix can be changed using the `help()` function on the command.
+     */
+    output: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    description?: string | undefined;
+    input?: string | undefined;
+    output?: string | undefined;
+}, {
+    description?: string | undefined;
+    input?: string | undefined;
+    output?: string | undefined;
+}>;
+export type ExampleConfig = z.infer<typeof ExampleConfig>;
+export declare class MassargExample {
+    description: string | undefined;
+    input: string | undefined;
+    output: string | undefined;
+    constructor(config: ExampleConfig);
+}
+//# sourceMappingURL=example.d.ts.map

package/example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAGnB,eAAO,MAAM,aAAa;IACxB,8FAA8F;;IAE9F;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD,qBAAa,cAAc;IACzB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;gBAEd,MAAM,EAAE,aAAa;CAiBlC"}

package/example.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MassargExample = exports.ExampleConfig = void 0;
+const zod_1 = __importDefault(require("zod"));
+const error_1 = require("./error");
+exports.ExampleConfig = zod_1.default.object({
+    /** Description of the example. This will appear as a title above the input/output line(s). */
+    description: zod_1.default.string().optional(),
+    /**
+     * Input of the example. This will appear as a line below the description, with a `$` prefix.
+     * The prefix can be changed using the `help()` function on the command.
+     */
+    input: zod_1.default.string().optional(),
+    /**
+     * Output of the example. This will appear as a line below the input, with a `>` prefix.
+     * The prefix can be changed using the `help()` function on the command.
+     */
+    output: zod_1.default.string().optional(),
+});
+class MassargExample {
+    constructor(config) {
+        exports.ExampleConfig.parse(config);
+        if (config.description === undefined &&
+            config.input === undefined &&
+            config.output === undefined) {
+            throw new error_1.ValidationError({
+                code: 'invalid_example',
+                message: 'Example must have at least one of description, input, or output',
+                path: ['example'],
+            });
+        }
+        this.description = config.description;
+        this.input = config.input;
+        this.output = config.output;
+    }
+}
+exports.MassargExample = MassargExample;
+//# sourceMappingURL=example.js.map

package/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmB;AACnB,mCAAyC;AAE5B,QAAA,aAAa,GAAG,aAAC,CAAC,MAAM,CAAC;IACpC,8FAA8F;IAC9F,WAAW,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC;;;OAGG;IACH,KAAK,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B;;;OAGG;IACH,MAAM,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAA;AAGF,MAAa,cAAc;IAKzB,YAAY,MAAqB;QAC/B,qBAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3B,IACE,MAAM,CAAC,WAAW,KAAK,SAAS;YAChC,MAAM,CAAC,KAAK,KAAK,SAAS;YAC1B,MAAM,CAAC,MAAM,KAAK,SAAS,EAC3B;YACA,MAAM,IAAI,uBAAe,CAAC;gBACxB,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,iEAAiE;gBAC1E,IAAI,EAAE,CAAC,SAAS,CAAC;aAClB,CAAC,CAAA;SACH;QACD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;QACrC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;IAC7B,CAAC;CACF;AAtBD,wCAsBC"}