@rickosborne/clamp 2025.1.7

package/README.md

@@ -0,0 +1,216 @@
+# @rickosborne/clamp
+
+Yet another command-line parameter handling tool.
+
+Built on:
+
+- [@rickosborne/typical](https://www.npmjs.com/package/@rickosborne/typical) for types
+- [@rickosborne/guard](https://www.npmjs.com/package/@rickosborne/guard) for guards
+- [@rickosborne/foundation](https://www.npmjs.com/package/@rickosborne/foundation) for basic data structures and algorithms
+- [@rickosborne/term](https://www.npmjs.com/package/@rickosborne/term) for console/terminal tools.
+
+***
+
+## API
+
+### Functions
+
+#### commandParams
+
+<a id="api-commandparams"></a>
+
+```typescript
+commandParams: <Spec extends CommandParamsSpec>(spec: Spec, { args, ignoreUnknown, onError, }?: {
+    args?: string[];
+    ignoreUnknown?: boolean;
+    onError?: (error: Error) => void;
+}) => CommandParamsReturn<Spec>
+```
+
+Parse the (maybe-given) command-line arguments according to the given param specs and construct a return type of the converted values.
+
+
+### TypeAliases
+
+#### BooleanCommandParam
+
+<a id="api-booleancommandparam"></a>
+
+```typescript
+type BooleanCommandParam = CommandParamBase & {
+    falses?: string[];
+    falseText?: string;
+    parse?: (this: void, text: string, param: BooleanCommandParam) => boolean;
+    placeholder?: undefined;
+    trues?: string[];
+    trueText?: string;
+    type: typeof Boolean;
+};
+```
+
+A command-line parameter which will be converted to a Boolean.
+
+
+#### CommandParam
+
+<a id="api-commandparam"></a>
+
+```typescript
+type CommandParam = StringCommandParam | NumberCommandParam | BooleanCommandParam | FileCommandParam | DateCommandParam;
+```
+
+One of the built-in param types.
+
+
+#### CommandParamBase
+
+<a id="api-commandparambase"></a>
+
+```typescript
+type CommandParamBase = Either<CommandParamWithNames, PositionalCommandParam> & Partial<OptionalParam> & Partial<RepeatedParam> & DescribedParam;
+```
+
+Mixin for any type of command-line parameter.
+
+
+#### CommandParamParser
+
+<a id="api-commandparamparser"></a>
+
+```typescript
+type CommandParamParser<Param extends CommandParam, Return> = (text: string, param: Param) => Return;
+```
+
+A parser function for a specific type of param.
+
+
+#### CommandParamReturn
+
+<a id="api-commandparamreturn"></a>
+
+```typescript
+type CommandParamReturn<Param extends CommandParam> = Param extends HasCommandParamParser<Param, infer Return> ? IfRepeated<Param, Return> : Param["type"] extends typeof Boolean ? IfOptional<Param, IfRepeated<Param, boolean>> : Param["type"] extends typeof Date ? IfOptional<Param, IfRepeated<Param, Date>> : Param["type"] extends typeof Number ? IfOptional<Param, IfRepeated<Param, number>> : Param["type"] extends "file" ? IfOptional<Param, IfRepeated<Param, FileArg>> : Param["type"] extends typeof String ? IfOptional<Param, IfRepeated<Param, string>> : undefined extends Param["type"] ? IfOptional<Param, IfRepeated<Param, string>> : never;
+```
+
+Computed return type for a param.
+
+
+#### CommandParamsReturn
+
+<a id="api-commandparamsreturn"></a>
+
+```typescript
+type CommandParamsReturn<Params extends object> = {
+    [K in keyof Params]: Params[K] extends CommandParam ? CommandParamReturn<Params[K]> : never;
+};
+```
+
+Computed return (Record) type for a Record of params.
+
+
+#### DateCommandParam
+
+<a id="api-datecommandparam"></a>
+
+```typescript
+type DateCommandParam = CommandParamBase & ParseLocalDateConfig & {
+    maximum?: Date;
+    minimum?: Date;
+    parse?: (this: void, text: string, param: DateCommandParam) => Date;
+    type: typeof Date;
+};
+```
+
+Command-line parameter which can accept a date (and optionally time) value.
+
+
+#### DescribedParam
+
+<a id="api-describedparam"></a>
+
+```typescript
+type DescribedParam = {
+    help?: string;
+    placeholder?: string;
+};
+```
+
+Mixin of properties which can be used to build `--help` text.
+
+
+#### FileArg
+
+<a id="api-filearg"></a>
+
+```typescript
+type FileArg = {
+    filePath: string;
+    stats: Stats | undefined;
+};
+```
+
+File argument resolved from a file command-line parameter.
+
+
+#### FileCommandParam
+
+<a id="api-filecommandparam"></a>
+
+```typescript
+type FileCommandParam = CommandParamBase & {
+    existing?: boolean;
+    parse?: (this: void, text: string, param: FileCommandParam) => FileArg;
+    path?: string;
+    type: "file";
+};
+```
+
+A command-line parameter which references a file.
+
+
+#### NumberCommandParam
+
+<a id="api-numbercommandparam"></a>
+
+```typescript
+type NumberCommandParam = CommandParamBase & {
+    integer?: boolean;
+    maximum?: number;
+    minimum?: number;
+    parse?: (this: void, text: string, param: NumberCommandParam) => number;
+    radix?: number;
+    type: typeof Number;
+};
+```
+
+A parameter which should be converted into a number.
+
+
+#### PositionalCommandParam
+
+<a id="api-positionalcommandparam"></a>
+
+```typescript
+type PositionalCommandParam = {
+    positional: true;
+};
+```
+
+A parameter which accepts positional values.
+
+
+#### StringCommandParam
+
+<a id="api-stringcommandparam"></a>
+
+```typescript
+type StringCommandParam = CommandParamBase & {
+    parse?: (this: void, text: string, param: StringCommandParam) => string;
+    trim?: boolean;
+    type?: typeof String;
+};
+```
+
+A parameter which accepts a text value.
+
+

package/cjs/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ts/boolean-param.js"), exports);
+__exportStar(require("./ts/command-params.js"), exports);
+__exportStar(require("./ts/common.js"), exports);
+__exportStar(require("./ts/date-param.js"), exports);
+__exportStar(require("./ts/file-param.js"), exports);
+__exportStar(require("./ts/help-for-param.js"), exports);
+__exportStar(require("./ts/label-for-param.js"), exports);
+__exportStar(require("./ts/number-param.js"), exports);
+__exportStar(require("./ts/param-handler.js"), exports);
+__exportStar(require("./ts/string-param.js"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,yDAAuC;AACvC,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,yDAAuC;AACvC,0DAAwC;AACxC,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC"}

package/cjs/package.json

@@ -0,0 +1,6 @@
+{
+	"engines": {
+		"node": ">=14"
+	},
+	"type": "commonjs"
+}

package/cjs/ts/boolean-param.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.booleanParamHandler = exports.parseBooleanArg = exports.FALSES = exports.TRUES = void 0;
+const label_for_param_js_1 = require("./label-for-param.js");
+/**
+ * Default possible values for true.
+ * @internal
+ */
+exports.TRUES = Object.freeze(["t", "true", "1", "y", "yes"]);
+// noinspection SpellCheckingInspection
+/**
+ * Default possible values for false.
+ * @internal
+ */
+exports.FALSES = Object.freeze(["f", "false", "0", "n", "no"]);
+/**
+ * @internal
+ */
+const parseBooleanArg = (text, param) => {
+    var _a, _b;
+    const lower = text.toLocaleLowerCase();
+    const trueValues = (_a = param.trues) !== null && _a !== void 0 ? _a : exports.TRUES;
+    if (trueValues.includes(lower)) {
+        return true;
+    }
+    const falseValues = (_b = param.falses) !== null && _b !== void 0 ? _b : exports.FALSES;
+    if (falseValues.includes(lower)) {
+        return false;
+    }
+    throw new RangeError(`${(0, label_for_param_js_1.labelForParam)(param)}: invalid value`);
+};
+exports.parseBooleanArg = parseBooleanArg;
+/**
+ * @internal
+ */
+exports.booleanParamHandler = {
+    matchesParam(param) {
+        return param.type === Boolean;
+    },
+    parseArg: exports.parseBooleanArg,
+    placeholderForParam() {
+        return undefined;
+    },
+};
+//# sourceMappingURL=boolean-param.js.map

package/cjs/ts/boolean-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean-param.js","sourceRoot":"","sources":["../../../ts/boolean-param.ts"],"names":[],"mappings":";;;AACA,6DAAqD;AAErD;;;GAGG;AACU,QAAA,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,CAAE,CAAC,CAAC;AAErE,uCAAuC;AACvC;;;GAGG;AACU,QAAA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAE,CAAC,CAAC;AAkCtE;;GAEG;AACI,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,KAA0B,EAAW,EAAE;;IACpF,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACvC,MAAM,UAAU,GAAG,MAAA,KAAK,CAAC,KAAK,mCAAI,aAAK,CAAC;IACxC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IACD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,MAAM,mCAAI,cAAM,CAAC;IAC3C,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,IAAI,UAAU,CAAC,GAAI,IAAA,kCAAa,EAAC,KAAK,CAAE,iBAAiB,CAAC,CAAC;AAClE,CAAC,CAAC;AAXW,QAAA,eAAe,mBAW1B;AAEF;;GAEG;AACU,QAAA,mBAAmB,GAA+C;IAC9E,YAAY,CAAC,KAAwB;QACpC,OAAO,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;IAC/B,CAAC;IACD,QAAQ,EAAE,uBAAe;IACzB,mBAAmB;QAClB,OAAO,SAAS,CAAC;IAClB,CAAC;CACD,CAAC"}

package/cjs/ts/command-params.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commandParams = void 0;
+const guard_1 = require("@rickosborne/guard");
+const boolean_param_js_1 = require("./boolean-param.js");
+const label_for_param_js_1 = require("./label-for-param.js");
+const param_handler_js_1 = require("./param-handler.js");
+const toReturnType = (text, param) => {
+    var _a;
+    const paramHandler = (0, param_handler_js_1.findParamHandler)(param);
+    const parser = ((_a = param.parse) !== null && _a !== void 0 ? _a : paramHandler.parseArg);
+    if (parser != null) {
+        return parser(text, param);
+    }
+    throw new Error(`Unhandled param type: ${String(param.type)}`);
+};
+/**
+ * Parse the (maybe-given) command-line arguments according to the
+ * given param specs and construct a return type of the converted values.
+ */
+const commandParams = (spec, { args = process.argv.slice(2), ignoreUnknown, onError, } = {}) => {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const result = {};
+    const positionals = Object.entries(spec)
+        .filter(([, s]) => s.positional === true)
+        .map(([key, s]) => ({ key, spec: s }));
+    if (positionals.length > 1) {
+        throw new Error(`Too many positionals: ${positionals.map(({ key }) => key).join(" ")}`);
+    }
+    const positional = positionals.shift();
+    let onlyPositionalsRemain = false;
+    try {
+        while (args.length > 0) {
+            const arg = args.shift();
+            let param;
+            let resultKey;
+            let typedValue;
+            if (arg === "--" && !onlyPositionalsRemain) {
+                onlyPositionalsRemain = true;
+                continue;
+            }
+            if (onlyPositionalsRemain || !arg.startsWith("-")) {
+                if (positional == null) {
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`Unexpected positional: ${JSON.stringify(arg)}`);
+                }
+                param = positional.spec;
+                resultKey = positional.key;
+                typedValue = toReturnType(arg, positional.spec);
+            }
+            else {
+                let no = false;
+                let name;
+                if (arg.startsWith("--no-")) {
+                    name = arg.substring(5);
+                    no = true;
+                }
+                else if (arg.startsWith("--")) {
+                    name = arg.substring(2);
+                }
+                else if (arg.startsWith("-no-")) {
+                    name = arg.substring(4);
+                    no = true;
+                }
+                else {
+                    name = arg.substring(1);
+                }
+                let suffix;
+                if (name.includes("=")) {
+                    [name, suffix] = name.split("=", 2);
+                }
+                const specs = Object.entries(spec)
+                    .filter(([n, s]) => { var _a, _b; return "name" in s && s.name === name || ("names" in s && ((_b = (_a = s.names) === null || _a === void 0 ? void 0 : _a.includes(name)) !== null && _b !== void 0 ? _b : false)) || n === name; });
+                if (specs.length < 1) {
+                    if (ignoreUnknown) {
+                        continue;
+                    }
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`Unexpected arg: ${JSON.stringify(name)}`);
+                }
+                if (specs.length > 1) {
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`More than one matching spec: ${name}`);
+                }
+                [resultKey, param] = specs[0];
+                (0, guard_1.assertDefined)(param, `param: ${name}`);
+                let stringValue;
+                if (param.type === Boolean) {
+                    if (no) {
+                        if (suffix != null) {
+                            // noinspection ExceptionCaughtLocallyJS
+                            throw new Error(`Combo of "no" plus "=" does not make any sense for ${(0, label_for_param_js_1.labelForParam)(param)}`);
+                        }
+                        stringValue = (_c = (_a = param.falseText) !== null && _a !== void 0 ? _a : (_b = param.falses) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : boolean_param_js_1.FALSES[0];
+                    }
+                    else {
+                        stringValue = (_f = (_d = suffix !== null && suffix !== void 0 ? suffix : param.trueText) !== null && _d !== void 0 ? _d : (_e = param.trues) === null || _e === void 0 ? void 0 : _e[0]) !== null && _f !== void 0 ? _f : boolean_param_js_1.TRUES[0];
+                    }
+                }
+                else if (no) {
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`"no" does not make sense for ${(0, label_for_param_js_1.labelForParam)(param)}`);
+                }
+                else {
+                    stringValue = suffix !== null && suffix !== void 0 ? suffix : args.shift();
+                }
+                (0, guard_1.assertDefined)(stringValue, () => `value for ${(0, label_for_param_js_1.labelForParam)(param)}`);
+                typedValue = toReturnType(stringValue, param);
+            }
+            if (param == null || resultKey == null) {
+                if (ignoreUnknown) {
+                    continue;
+                }
+                // noinspection ExceptionCaughtLocallyJS
+                throw new Error(`Unexpected arg: ${JSON.stringify(arg)}`);
+            }
+            (0, guard_1.assertDefined)(typedValue, `typedValue for ${resultKey}`);
+            const existing = result[resultKey];
+            if (param.multiple === true) {
+                const values = existing !== null && existing !== void 0 ? existing : [];
+                if (!Array.isArray(values)) {
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`Expected an array: ${resultKey}`);
+                }
+                (_g = result[resultKey]) !== null && _g !== void 0 ? _g : (result[resultKey] = values);
+                values.push(typedValue);
+            }
+            else {
+                if (existing != null) {
+                    // noinspection ExceptionCaughtLocallyJS
+                    throw new Error(`Too many ${(0, label_for_param_js_1.labelForParam)(param)}: ${JSON.stringify(existing)} ${JSON.stringify(arg)}`);
+                }
+                result[resultKey] = typedValue;
+            }
+        }
+        const requiredKeys = Object.entries(spec)
+            .filter(([, s]) => s.optional !== true)
+            .map(([key]) => key);
+        const missing = requiredKeys.filter((key) => !(key in result));
+        if (missing.length > 0) {
+            const message = missing.map((key) => (0, label_for_param_js_1.labelForParam)(spec[key])).join(" ");
+            // noinspection ExceptionCaughtLocallyJS
+            throw new Error(`Missing required params: ${message}`);
+        }
+    }
+    catch (err) {
+        const error = err instanceof Error ? err : new Error("Unknown error");
+        if (onError != null) {
+            onError(error);
+            return undefined;
+        }
+        else {
+            console.error(error.message);
+            process.exit(1);
+        }
+    }
+    return result;
+};
+exports.commandParams = commandParams;
+//# sourceMappingURL=command-params.js.map

package/cjs/ts/command-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-params.js","sourceRoot":"","sources":["../../../ts/command-params.ts"],"names":[],"mappings":";;;AAAA,8CAAmD;AACnD,yDAA6E;AAI7E,6DAAqD;AAErD,yDAAsD;AA0CtD,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAmB,EAAW,EAAE;;IACnE,MAAM,YAAY,GAAG,IAAA,mCAAgB,EAAC,KAAK,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,CAAC,MAAA,KAAK,CAAC,KAAK,mCAAI,YAAY,CAAC,QAAQ,CAA0D,CAAC;IAC/G,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,yBAA0B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAE,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,CAC5B,IAAU,EACV,EACC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAC5B,aAAa,EACb,OAAO,MAKJ,EAAE,EACsB,EAAE;;IAC9B,MAAM,MAAM,GAAG,EAA6B,CAAC;IAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACtC,MAAM,CAAC,CAAC,CAAE,AAAD,EAAG,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC;SAC1C,GAAG,CAAC,CAAC,CAAE,GAAG,EAAE,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAA0B,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;IACvC,IAAI,qBAAqB,GAAG,KAAK,CAAC;IAClC,IAAI,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAG,CAAC;YAC1B,IAAI,KAA+B,CAAC;YACpC,IAAI,SAA6B,CAAC;YAClC,IAAI,UAAmB,CAAC;YACxB,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC5C,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,SAAS;YACV,CAAC;YACD,IAAI,qBAAqB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnD,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;oBACxB,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,0BAA2B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAE,EAAE,CAAC,CAAC;gBACpE,CAAC;gBACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC;gBACxB,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC;gBAC3B,UAAU,GAAG,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;iBAAM,CAAC;gBACP,IAAI,EAAE,GAAG,KAAK,CAAC;gBACf,IAAI,IAAwB,CAAC;gBAC7B,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACxB,EAAE,GAAG,IAAI,CAAC;gBACX,CAAC;qBAAM,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACzB,CAAC;qBAAM,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACnC,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACxB,EAAE,GAAG,IAAI,CAAC;gBACX,CAAC;qBAAM,CAAC;oBACP,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACzB,CAAC;gBACD,IAAI,MAA0B,CAAC;gBAC/B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxB,CAAE,IAAI,EAAE,MAAM,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACvC,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;qBAChC,MAAM,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC,CAAE,EAAE,EAAE,eAAC,OAAA,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAA,MAAA,CAAC,CAAC,KAAK,0CAAE,QAAQ,CAAC,IAAI,CAAC,mCAAI,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,CAAA,EAAA,CAAC,CAAC;gBAC7H,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,IAAI,aAAa,EAAE,CAAC;wBACnB,SAAS;oBACV,CAAC;oBACD,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,mBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAE,EAAE,CAAC,CAAC;gBAC9D,CAAC;gBACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,gCAAiC,IAAK,EAAE,CAAC,CAAC;gBAC3D,CAAC;gBACD,CAAE,SAAS,EAAE,KAAK,CAAE,GAAG,KAAK,CAAE,CAAC,CAAE,CAAC;gBAClC,IAAA,qBAAa,EAAC,KAAK,EAAE,UAAW,IAAK,EAAE,CAAC,CAAC;gBACzC,IAAI,WAA+B,CAAC;gBACpC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC5B,IAAI,EAAE,EAAE,CAAC;wBACR,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;4BACpB,wCAAwC;4BACxC,MAAM,IAAI,KAAK,CAAC,sDAAuD,IAAA,kCAAa,EAAC,KAAK,CAAE,EAAE,CAAC,CAAC;wBACjG,CAAC;wBACD,WAAW,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,mCAAI,MAAA,KAAK,CAAC,MAAM,0CAAI,CAAC,CAAE,mCAAI,yBAAM,CAAE,CAAC,CAAE,CAAC;oBACrE,CAAC;yBAAM,CAAC;wBACP,WAAW,GAAG,MAAA,MAAA,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC,QAAQ,mCAAI,MAAA,KAAK,CAAC,KAAK,0CAAI,CAAC,CAAE,mCAAI,wBAAK,CAAE,CAAC,CAAE,CAAC;oBAC5E,CAAC;gBACF,CAAC;qBAAM,IAAI,EAAE,EAAE,CAAC;oBACf,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,gCAAiC,IAAA,kCAAa,EAAC,KAAK,CAAE,EAAE,CAAC,CAAC;gBAC3E,CAAC;qBAAM,CAAC;oBACP,WAAW,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACtC,CAAC;gBACD,IAAA,qBAAa,EAAC,WAAW,EAAE,GAAG,EAAE,CAAC,aAAc,IAAA,kCAAa,EAAC,KAAM,CAAE,EAAE,CAAC,CAAC;gBACzE,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC/C,CAAC;YACD,IAAI,KAAK,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACxC,IAAI,aAAa,EAAE,CAAC;oBACnB,SAAS;gBACV,CAAC;gBACD,wCAAwC;gBACxC,MAAM,IAAI,KAAK,CAAC,mBAAoB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAE,EAAE,CAAC,CAAC;YAC7D,CAAC;YACD,IAAA,qBAAa,EAAC,UAAU,EAAE,kBAAmB,SAAU,EAAE,CAAC,CAAC;YAC3D,MAAM,QAAQ,GAAG,MAAM,CAAE,SAAS,CAAE,CAAC;YACrC,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC;gBAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5B,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,sBAAuB,SAAU,EAAE,CAAC,CAAC;gBACtD,CAAC;gBACD,MAAA,MAAM,CAAE,SAAS,qCAAjB,MAAM,CAAE,SAAS,IAAO,MAAM,EAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACP,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;oBACtB,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,YAAa,IAAA,kCAAa,EAAC,KAAK,CAAE,KAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAE,IAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAE,EAAE,CAAC,CAAC;gBAC/G,CAAC;gBACD,MAAM,CAAE,SAAS,CAAE,GAAG,UAAU,CAAC;YAClC,CAAC;QACF,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;aACvC,MAAM,CAAC,CAAC,CAAE,AAAD,EAAG,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC;aACxC,GAAG,CAAC,CAAC,CAAE,GAAG,CAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,kCAAa,EAAC,IAAI,CAAE,GAAG,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3E,wCAAwC;YACxC,MAAM,IAAI,KAAK,CAAC,4BAA6B,OAAQ,EAAE,CAAC,CAAC;QAC1D,CAAC;IACF,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACtE,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,CAAC;YACf,OAAO,SAAiD,CAAC;QAC1D,CAAC;aAAM,CAAC;YACP,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;IACF,CAAC;IACD,OAAO,MAAmC,CAAC;AAC5C,CAAC,CAAC;AAzIW,QAAA,aAAa,iBAyIxB"}

package/cjs/ts/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/cjs/ts/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../ts/common.ts"],"names":[],"mappings":""}

package/cjs/ts/date-param.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateParamHandler = exports.isDateParam = exports.parseDateArg = void 0;
+const foundation_1 = require("@rickosborne/foundation");
+const label_for_param_js_1 = require("./label-for-param.js");
+/**
+ * @internal
+ */
+const parseDateArg = (text, param) => {
+    const date = (0, foundation_1.parseLocalDate)(text, param);
+    if (param.minimum != null && date < param.minimum) {
+        throw new RangeError(`${(0, label_for_param_js_1.labelForParam)(param)}: minimum=${param.minimum.toISOString()}`);
+    }
+    if (param.maximum != null && date > param.maximum) {
+        throw new RangeError(`${(0, label_for_param_js_1.labelForParam)(param)}: maximum=${param.maximum.toISOString()}`);
+    }
+    return date;
+};
+exports.parseDateArg = parseDateArg;
+/**
+ * @internal
+ */
+const isDateParam = (param) => {
+    return param.type === Date;
+};
+exports.isDateParam = isDateParam;
+/**
+ * @internal
+ */
+exports.dateParamHandler = {
+    matchesParam: exports.isDateParam,
+    parseArg: exports.parseDateArg,
+    placeholderForParam(param) {
+        var _a;
+        return ((_a = param.placeholder) !== null && _a !== void 0 ? _a : param.time) ? "(datetime)" : "(date)";
+    },
+};
+//# sourceMappingURL=date-param.js.map

package/cjs/ts/date-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-param.js","sourceRoot":"","sources":["../../../ts/date-param.ts"],"names":[],"mappings":";;;AAAA,wDAAoF;AAEpF,6DAAqD;AAsBrD;;GAEG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAuB,EAAQ,EAAE;IAC3E,MAAM,IAAI,GAAG,IAAA,2BAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACzC,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,IAAI,UAAU,CAAC,GAAI,IAAA,kCAAa,EAAC,KAAK,CAAE,aAAc,KAAK,CAAC,OAAO,CAAC,WAAW,EAAG,EAAE,CAAC,CAAC;IAC7F,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,IAAI,UAAU,CAAC,GAAI,IAAA,kCAAa,EAAC,KAAK,CAAE,aAAc,KAAK,CAAC,OAAO,CAAC,WAAW,EAAG,EAAE,CAAC,CAAC;IAC7F,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AATW,QAAA,YAAY,gBASvB;AAEF;;GAEG;AACI,MAAM,WAAW,GAAG,CAAC,KAAwB,EAA6B,EAAE;IAClF,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;AAC5B,CAAC,CAAC;AAFW,QAAA,WAAW,eAEtB;AAEF;;GAEG;AACU,QAAA,gBAAgB,GAAyC;IACrE,YAAY,EAAE,mBAAW;IACzB,QAAQ,EAAE,oBAAY;IACtB,mBAAmB,CAAC,KAAuB;;QAC1C,OAAO,CAAA,MAAA,KAAK,CAAC,WAAW,mCAAI,KAAK,CAAC,IAAI,EAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC;IAClE,CAAC;CACD,CAAC"}

package/cjs/ts/file-param.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileParamHandler = exports.isFileParam = exports.parseFileArg = void 0;
+const term_1 = require("@rickosborne/term");
+const path = require("node:path");
+/**
+ * Validate and transform the argument before it is returned.
+ * @internal
+ */
+const parseFileArg = (text, param) => {
+    let filePath = text;
+    if (param.path != null && !filePath.startsWith(param.path)) {
+        filePath = path.join(param.path, filePath);
+    }
+    const stats = (0, term_1.statsForFile)(filePath);
+    const exists = stats != null;
+    if (param.existing !== undefined) {
+        if (exists !== param.existing) {
+            throw new Error(`File ${exists ? "exists" : "does not exist"}: ${filePath}`);
+        }
+    }
+    return { filePath, stats };
+};
+exports.parseFileArg = parseFileArg;
+/**
+ * @internal
+ */
+const isFileParam = (param) => {
+    return param.type === "file";
+};
+exports.isFileParam = isFileParam;
+/**
+ * @internal
+ */
+exports.fileParamHandler = {
+    matchesParam: exports.isFileParam,
+    parseArg: exports.parseFileArg,
+    placeholderForParam(param) {
+        var _a;
+        return (_a = param.placeholder) !== null && _a !== void 0 ? _a : "(path)";
+    },
+};
+//# sourceMappingURL=file-param.js.map

package/cjs/ts/file-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-param.js","sourceRoot":"","sources":["../../../ts/file-param.ts"],"names":[],"mappings":";;;AAAA,4CAAiD;AAEjD,kCAAkC;AAuClC;;;GAGG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAuB,EAAW,EAAE;IAC9E,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,KAAK,GAAG,IAAA,mBAAY,EAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,KAAK,IAAI,IAAI,CAAC;IAC7B,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,MAAM,KAAK,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,QAAS,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAiB,KAAM,QAAS,EAAE,CAAC,CAAC;QAClF,CAAC;IACF,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAEF;;GAEG;AACI,MAAM,WAAW,GAAG,CAAC,KAAwB,EAA6B,EAAE;IAClF,OAAO,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC;AAC9B,CAAC,CAAC;AAFW,QAAA,WAAW,eAEtB;AAEF;;GAEG;AACU,QAAA,gBAAgB,GAA4C;IACxE,YAAY,EAAE,mBAAW;IACzB,QAAQ,EAAE,oBAAY;IACtB,mBAAmB,CAAC,KAAuB;;QAC1C,OAAO,MAAA,KAAK,CAAC,WAAW,mCAAI,QAAQ,CAAC;IACtC,CAAC;CACD,CAAC"}

package/cjs/ts/help-for-param.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helpForParam = void 0;
+const param_handler_js_1 = require("./param-handler.js");
+/**
+ * @internal
+ */
+const helpForParam = (names, param) => {
+    const { help } = param;
+    if (help == null) {
+        return undefined;
+    }
+    const handler = (0, param_handler_js_1.findParamHandler)(param);
+    const placeholder = handler.placeholderForParam(param);
+    const lines = [];
+    for (const name of names.slice().sort()) {
+        let line = "  ";
+        if (name.length === 1) {
+            line = line.concat("-", name);
+        }
+        else {
+            line = line.concat("--", name);
+        }
+        if (placeholder != null) {
+            line = line.concat(" ", placeholder);
+        }
+        lines.push(line);
+    }
+    lines.push("    ".concat(help));
+    return lines.join("\n");
+};
+exports.helpForParam = helpForParam;
+//# sourceMappingURL=help-for-param.js.map

package/cjs/ts/help-for-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-for-param.js","sourceRoot":"","sources":["../../../ts/help-for-param.ts"],"names":[],"mappings":";;;AACA,yDAAsD;AAEtD;;GAEG;AACI,MAAM,YAAY,GAAG,CAAC,KAAe,EAAE,KAAmB,EAAsB,EAAE;IACxF,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,IAAA,mCAAgB,EAAC,KAAK,CAAC,CAAC;IACxC,MAAM,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACvD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QACzC,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAChC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC,CAAC;AAtBW,QAAA,YAAY,gBAsBvB"}

package/cjs/ts/label-for-param.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.labelForParam = void 0;
+/**
+ * @internal
+ */
+const labelForParam = (param) => {
+    var _a;
+    if (param.positional === true) {
+        return "...";
+    }
+    const names = ((_a = param.names) !== null && _a !== void 0 ? _a : param.name == null) ? [] : [param.name];
+    return names
+        .map((name) => (name.length === 1 ? "-" : "--").concat(name))
+        .join("|");
+};
+exports.labelForParam = labelForParam;
+//# sourceMappingURL=label-for-param.js.map

package/cjs/ts/label-for-param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"label-for-param.js","sourceRoot":"","sources":["../../../ts/label-for-param.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACI,MAAM,aAAa,GAAG,CAAC,KAAmB,EAAU,EAAE;;IAC5D,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,CAAA,MAAA,KAAK,CAAC,KAAK,mCAAI,KAAK,CAAC,IAAI,IAAI,IAAI,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,KAAK,CAAC,IAAI,CAAE,CAAC;IACtE,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;AACb,CAAC,CAAC;AARW,QAAA,aAAa,iBAQxB"}