@villedemontreal/caporal 3.1.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Matthias ETIENNE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+<p align="center">
+    <img src="https://github.com/mattallty/Caporal.js/blob/6a8bd68b454ff6327df310d290ee453e0efc087b/assets/caporal.svg?raw=true" width="437" height="127">
+</p>
+
+# Caporal
+
+> A full-featured framework for building command line applications (cli) with node.js,
+> including help generation, colored output, verbosity control, custom logger, coercion
+> and casting, typos suggestions, and auto-complete for bash/zsh/fish.
+
+## Install
+
+Simply add Caporal as a dependency:
+
+```bash
+$ npm install @caporal/core
+
+# Or if you are using yarn (https://yarnpkg.com/lang/en/)
+$ yarn add caporal @caporal/core
+```
+
+## Documentation
+
+[**Checkout our website https://caporal.io for docs.**](https://caporal.io)
+
+## License
+
+MIT License, see [LICENSE](./LICENSE) file.
+Copyright (c) 2017-present Matthias ETIENNE.

package/dist/src/__tests__/issue-163.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=issue-163.spec.d.ts.map

package/dist/src/__tests__/issue-163.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue-163.spec.d.ts","sourceRoot":"","sources":["../../../src/__tests__/issue-163.spec.ts"],"names":[],"mappings":""}

package/dist/src/__tests__/issue-163.spec.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const parser_1 = require("../parser");
+(0, vitest_1.describe)("issue #163", () => {
+    (0, vitest_1.it)("should combine short and long versions of option flag when using array option", () => {
+        const results = (0, parser_1.parseArgv)({
+            variadic: ["file"],
+            alias: {
+                f: "file",
+            },
+        }, ["-f", "my-value", "--file", "joe", "--file", "1", "-f", "xxx"]);
+        (0, vitest_1.expect)(results.options.f).toEqual(["my-value", "joe", 1, "xxx"]);
+        (0, vitest_1.expect)(results.options.file).toEqual(["my-value", "joe", 1, "xxx"]);
+    });
+});
+//# sourceMappingURL=issue-163.spec.js.map

package/dist/src/__tests__/issue-163.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue-163.spec.js","sourceRoot":"","sources":["../../../src/__tests__/issue-163.spec.ts"],"names":[],"mappings":";;AAAA,mCAA6C;AAC7C,sCAAqC;AAErC,IAAA,iBAAQ,EAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAA,WAAE,EAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,OAAO,GAAG,IAAA,kBAAS,EACvB;YACE,QAAQ,EAAE,CAAC,MAAM,CAAC;YAClB,KAAK,EAAE;gBACL,CAAC,EAAE,MAAM;aACV;SACF,EACD,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAChE,CAAA;QACD,IAAA,eAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;QAChE,IAAA,eAAM,EAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IACrE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/argument/__tests__/argument.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=argument.spec.d.ts.map

package/dist/src/argument/__tests__/argument.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"argument.spec.d.ts","sourceRoot":"","sources":["../../../../src/argument/__tests__/argument.spec.ts"],"names":[],"mappings":""}

package/dist/src/argument/__tests__/argument.spec.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("createArgument()", () => {
+    (0, vitest_1.it)("should create a basic required arg", () => {
+        const arg = (0, __1.createArgument)("<my-argument>", "My test argument");
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: [],
+            name: "myArgument",
+            required: true,
+            synopsis: "<my-argument>",
+            variadic: false,
+        });
+    });
+    (0, vitest_1.it)("should create a basic optional arg", () => {
+        const arg = (0, __1.createArgument)("[my-argument]", "My test argument");
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: [],
+            name: "myArgument",
+            required: false,
+            synopsis: "[my-argument]",
+            variadic: false,
+        });
+    });
+    (0, vitest_1.it)("should implicitly create an optional arg if no special character is set", () => {
+        const arg = (0, __1.createArgument)("my-argument", "My test argument");
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: [],
+            name: "myArgument",
+            required: false,
+            synopsis: "[my-argument]",
+            variadic: false,
+        });
+    });
+    (0, vitest_1.it)("arg.choices should equal the array validator when provided", () => {
+        const arg = (0, __1.createArgument)("[my-argument]", "My test argument", {
+            validator: ["one", "two"],
+        });
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: ["one", "two"],
+            name: "myArgument",
+            required: false,
+            typeHint: 'one of "one","two"',
+            synopsis: "[my-argument]",
+            validator: ["one", "two"],
+            variadic: false,
+        });
+    });
+    (0, vitest_1.it)("arg.variadic should be true for an optional variadic argument", () => {
+        const arg = (0, __1.createArgument)("[my-argument...]", "My test argument", {
+            validator: ["one", "two"],
+        });
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: ["one", "two"],
+            name: "myArgument",
+            required: false,
+            typeHint: 'one of "one","two"',
+            synopsis: "[my-argument...]",
+            validator: ["one", "two"],
+            variadic: true,
+        });
+    });
+    (0, vitest_1.it)("arg.variadic should be true for an required variadic argument", () => {
+        const arg = (0, __1.createArgument)("<my-argument...>", "My test argument", {
+            validator: ["one", "two"],
+        });
+        (0, vitest_1.expect)(arg).toMatchObject({
+            description: "My test argument",
+            choices: ["one", "two"],
+            name: "myArgument",
+            required: true,
+            typeHint: 'one of "one","two"',
+            synopsis: "<my-argument...>",
+            validator: ["one", "two"],
+            variadic: true,
+        });
+    });
+});
+//# sourceMappingURL=argument.spec.js.map

package/dist/src/argument/__tests__/argument.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"argument.spec.js","sourceRoot":"","sources":["../../../../src/argument/__tests__/argument.spec.ts"],"names":[],"mappings":";;AAAA,0BAAmC;AACnC,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;QAC/D,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;QAC/D,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,yEAAyE,EAAE,GAAG,EAAE;QACjF,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,aAAa,EAAE,kBAAkB,CAAC,CAAA;QAC7D,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,eAAe,EAAE,kBAAkB,EAAE;YAC9D,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;SAC1B,CAAC,CAAA;QACF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACvB,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,oBAAoB;YAC9B,QAAQ,EAAE,eAAe;YACzB,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,kBAAkB,EAAE,kBAAkB,EAAE;YACjE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;SAC1B,CAAC,CAAA;QACF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACvB,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,oBAAoB;YAC9B,QAAQ,EAAE,kBAAkB;YAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,EAAE,IAAI;SACf,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,IAAA,WAAE,EAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,GAAG,GAAG,IAAA,kBAAc,EAAC,kBAAkB,EAAE,kBAAkB,EAAE;YACjE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;SAC1B,CAAC,CAAA;QACF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;YACxB,WAAW,EAAE,kBAAkB;YAC/B,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACvB,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,oBAAoB;YAC9B,QAAQ,EAAE,kBAAkB;YAC5B,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YACzB,QAAQ,EAAE,IAAI;SACf,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/argument/find.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Argument } from "../types";
+import type { Command } from "../command";
+export declare function findArgument(cmd: Command, name: string): Argument | undefined;
+//# sourceMappingURL=find.d.ts.map

package/dist/src/argument/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/argument/find.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAE7E"}

package/dist/src/argument/find.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * @packageDocumentation
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findArgument = findArgument;
+function findArgument(cmd, name) {
+    return cmd.args.find((a) => a.name === name);
+}
+//# sourceMappingURL=find.js.map

package/dist/src/argument/find.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../src/argument/find.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAKH,oCAEC;AAFD,SAAgB,YAAY,CAAC,GAAY,EAAE,IAAY;IACrD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAC9C,CAAC"}

package/dist/src/argument/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Argument, CreateArgumentOpts } from "../types";
+/**
+ *
+ * @param synopsis - Argument synopsis
+ * @param description - Argument description
+ * @param [options] - Various argument options like validator and default value
+ */
+export declare function createArgument(synopsis: string, description: string, options?: CreateArgumentOpts): Argument;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/argument/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/argument/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAI5D;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAAuB,GAC/B,QAAQ,CAgBV"}

package/dist/src/argument/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createArgument = createArgument;
+const utils_1 = require("../validator/utils");
+const synopsis_1 = require("./synopsis");
+/**
+ *
+ * @param synopsis - Argument synopsis
+ * @param description - Argument description
+ * @param [options] - Various argument options like validator and default value
+ */
+function createArgument(synopsis, description, options = {}) {
+    const { validator, default: defaultValue } = options;
+    (0, utils_1.checkValidator)(validator);
+    const syno = (0, synopsis_1.parseArgumentSynopsis)(synopsis);
+    const arg = {
+        kind: "argument",
+        default: defaultValue,
+        description,
+        choices: Array.isArray(validator) ? validator : [],
+        validator,
+        ...syno,
+    };
+    arg.typeHint = (0, utils_1.getTypeHint)(arg);
+    return arg;
+}
+//# sourceMappingURL=index.js.map

package/dist/src/argument/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/argument/index.ts"],"names":[],"mappings":";;AAcA,wCAoBC;AA7BD,8CAAgE;AAChE,yCAAkD;AAElD;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,QAAgB,EAChB,WAAmB,EACnB,UAA8B,EAAE;IAEhC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAA;IACpD,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAA;IAEzB,MAAM,IAAI,GAAG,IAAA,gCAAqB,EAAC,QAAQ,CAAC,CAAA;IAC5C,MAAM,GAAG,GAAa;QACpB,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,YAAY;QACrB,WAAW;QACX,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;QAClD,SAAS;QACT,GAAG,IAAI;KACR,CAAA;IACD,GAAG,CAAC,QAAQ,GAAG,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAA;IAE/B,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/dist/src/argument/synopsis.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { ArgumentSynopsis } from "../types";
+/**
+ * Check if the argument is explicitly required
+ *
+ * @ignore
+ * @param synopsis
+ */
+export declare function isRequired(synopsis: string): boolean;
+/**
+ *
+ * @param synopsis
+ */
+export declare function isVariadic(synopsis: string): boolean;
+export declare function parseArgumentSynopsis(synopsis: string): ArgumentSynopsis;
+//# sourceMappingURL=synopsis.d.ts.map

package/dist/src/argument/synopsis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synopsis.d.ts","sourceRoot":"","sources":["../../../src/argument/synopsis.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAGhD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAexE"}

package/dist/src/argument/synopsis.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRequired = isRequired;
+exports.isVariadic = isVariadic;
+exports.parseArgumentSynopsis = parseArgumentSynopsis;
+const utils_1 = require("../option/utils");
+/**
+ * Check if the argument is explicitly required
+ *
+ * @ignore
+ * @param synopsis
+ */
+function isRequired(synopsis) {
+    return synopsis.substring(0, 1) === "<";
+}
+/**
+ *
+ * @param synopsis
+ */
+function isVariadic(synopsis) {
+    return synopsis.substr(-4, 3) === "..." || synopsis.endsWith("...");
+}
+function parseArgumentSynopsis(synopsis) {
+    synopsis = synopsis.trim();
+    const rawName = (0, utils_1.getCleanNameFromNotation)(synopsis, false);
+    const name = (0, utils_1.getCleanNameFromNotation)(synopsis);
+    const required = isRequired(synopsis);
+    const variadic = isVariadic(synopsis);
+    const cleanSynopsis = required
+        ? `<${rawName}${variadic ? "..." : ""}>`
+        : `[${rawName}${variadic ? "..." : ""}]`;
+    return {
+        name,
+        synopsis: cleanSynopsis,
+        required,
+        variadic,
+    };
+}
+//# sourceMappingURL=synopsis.js.map

package/dist/src/argument/synopsis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synopsis.js","sourceRoot":"","sources":["../../../src/argument/synopsis.ts"],"names":[],"mappings":";;AAaA,gCAEC;AAMD,gCAEC;AAED,sDAeC;AAnCD,2CAA0D;AAE1D;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,QAAgB;IACzC,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAA;AACzC,CAAC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,QAAgB;IACzC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACrE,CAAC;AAED,SAAgB,qBAAqB,CAAC,QAAgB;IACpD,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC1B,MAAM,OAAO,GAAG,IAAA,gCAAwB,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IACzD,MAAM,IAAI,GAAG,IAAA,gCAAwB,EAAC,QAAQ,CAAC,CAAA;IAC/C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;IACrC,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;IACrC,MAAM,aAAa,GAAG,QAAQ;QAC5B,CAAC,CAAC,IAAI,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG;QACxC,CAAC,CAAC,IAAI,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAA;IAC1C,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,aAAa;QACvB,QAAQ;QACR,QAAQ;KACT,CAAA;AACH,CAAC"}

package/dist/src/argument/validate.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import { BaseError, CommonError } from "../error";
+import type { ArgumentsRange, ParsedArguments, ParsedArgumentsObject } from "../types";
+import type { Command } from "../command";
+/**
+ * Get the number of required argument for a given command
+ *
+ * @param cmd
+ */
+export declare function getRequiredArgsCount(cmd: Command): number;
+export declare function getArgsObjectFromArray(cmd: Command, args: ParsedArguments): ParsedArgumentsObject;
+/**
+ * Check if the given command has at leat one variadic argument
+ *
+ * @param cmd
+ */
+export declare function hasVariadicArgument(cmd: Command): boolean;
+export declare function getArgsRange(cmd: Command): ArgumentsRange;
+export declare function checkRequiredArgs(cmd: Command, args: ParsedArgumentsObject, parsedArgv: ParsedArguments): BaseError[];
+export declare function removeCommandFromArgs(cmd: Command, args: ParsedArguments): ParsedArguments;
+interface ArgsValidationResult {
+    args: ParsedArgumentsObject;
+    errors: CommonError[];
+}
+/**
+ *
+ * @param cmd
+ * @param parsedArgv
+ *
+ * @todo Bugs:
+ *
+ *
+ * ts-node examples/pizza/pizza.ts cancel my-order jhazd hazd
+ *
+ * -> result ok, should be too many arguments
+ *
+ */
+export declare function validateArgs(cmd: Command, parsedArgv: ParsedArguments): Promise<ArgsValidationResult>;
+export {};
+//# sourceMappingURL=validate.d.ts.map

package/dist/src/argument/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/argument/validate.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGL,SAAS,EACT,WAAW,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAEV,cAAc,EACd,eAAe,EACf,qBAAqB,EAGtB,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAIzC;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAEzD;AAED,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,eAAe,GACpB,qBAAqB,CAUvB;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAEzD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAIzD;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,qBAAqB,EAC3B,UAAU,EAAE,eAAe,GAC1B,SAAS,EAAE,CAiBb;AAaD,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,eAAe,GACpB,eAAe,CAGjB;AASD,UAAU,oBAAoB;IAC5B,IAAI,EAAE,qBAAqB,CAAA;IAC3B,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,OAAO,EACZ,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,oBAAoB,CAAC,CAyC/B"}

package/dist/src/argument/validate.js

@@ -0,0 +1,127 @@
+"use strict";
+/**
+ * @packageDocumentation
+ * @internal
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredArgsCount = getRequiredArgsCount;
+exports.getArgsObjectFromArray = getArgsObjectFromArray;
+exports.hasVariadicArgument = hasVariadicArgument;
+exports.getArgsRange = getArgsRange;
+exports.checkRequiredArgs = checkRequiredArgs;
+exports.removeCommandFromArgs = removeCommandFromArgs;
+exports.validateArgs = validateArgs;
+const reduce_1 = __importDefault(require("lodash/reduce"));
+const error_1 = require("../error");
+const validate_1 = require("../validator/validate");
+const find_1 = require("./find");
+/**
+ * Get the number of required argument for a given command
+ *
+ * @param cmd
+ */
+function getRequiredArgsCount(cmd) {
+    return cmd.args.filter((a) => a.required).length;
+}
+function getArgsObjectFromArray(cmd, args) {
+    const result = {};
+    return cmd.args.reduce((acc, arg, index) => {
+        if (args[index] !== undefined) {
+            acc[arg.name] = args[index];
+        }
+        else if (arg.default !== undefined) {
+            acc[arg.name] = arg.default;
+        }
+        return acc;
+    }, result);
+}
+/**
+ * Check if the given command has at leat one variadic argument
+ *
+ * @param cmd
+ */
+function hasVariadicArgument(cmd) {
+    return cmd.args.some((a) => a.variadic);
+}
+function getArgsRange(cmd) {
+    const min = getRequiredArgsCount(cmd);
+    const max = hasVariadicArgument(cmd) ? Infinity : cmd.args.length;
+    return { min, max };
+}
+function checkRequiredArgs(cmd, args, parsedArgv) {
+    const errors = cmd.args.reduce((acc, arg) => {
+        if (args[arg.name] === undefined && arg.required) {
+            acc.push(new error_1.MissingArgumentError(arg, cmd));
+        }
+        return acc;
+    }, []);
+    // Check if there is more args than specified
+    if (cmd.strictArgsCount) {
+        const numArgsError = checkNumberOfArgs(cmd, parsedArgv);
+        if (numArgsError) {
+            errors.push(numArgsError);
+        }
+    }
+    return errors;
+}
+function checkNumberOfArgs(cmd, args) {
+    const range = getArgsRange(cmd);
+    const argsCount = Object.keys(args).length;
+    if (range.max !== Infinity && range.max < Object.keys(args).length) {
+        return new error_1.TooManyArgumentsError(cmd, range, argsCount);
+    }
+}
+function removeCommandFromArgs(cmd, args) {
+    const words = cmd.name.split(" ").length;
+    return args.slice(words);
+}
+function validateArg(arg, value) {
+    return arg.validator ? (0, validate_1.validate)(value, arg.validator, arg) : value;
+}
+/**
+ *
+ * @param cmd
+ * @param parsedArgv
+ *
+ * @todo Bugs:
+ *
+ *
+ * ts-node examples/pizza/pizza.ts cancel my-order jhazd hazd
+ *
+ * -> result ok, should be too many arguments
+ *
+ */
+async function validateArgs(cmd, parsedArgv) {
+    // remove the command from the argv array
+    const formatedArgs = cmd.isProgramCommand()
+        ? parsedArgv
+        : removeCommandFromArgs(cmd, parsedArgv);
+    // transfrom args array to object, and set defaults for arguments not passed
+    const argsObj = getArgsObjectFromArray(cmd, formatedArgs);
+    const errors = [];
+    const validations = (0, reduce_1.default)(argsObj, (acc, value, key) => {
+        const arg = (0, find_1.findArgument)(cmd, key);
+        try {
+            /* istanbul ignore if -- should not happen */
+            if (!arg) {
+                throw new error_1.BaseError(`Unknown argumment ${key}`);
+            }
+            acc[key] = validateArg(arg, value);
+        }
+        catch (e) {
+            errors.push(e);
+        }
+        return acc;
+    }, {});
+    const result = await (0, reduce_1.default)(validations, async (prevPromise, value, key) => {
+        const collection = await prevPromise;
+        collection[key] = await value;
+        return collection;
+    }, Promise.resolve({}));
+    errors.push(...checkRequiredArgs(cmd, result, formatedArgs));
+    return { args: result, errors };
+}
+//# sourceMappingURL=validate.js.map

package/dist/src/argument/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../src/argument/validate.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AA2BH,oDAEC;AAED,wDAaC;AAOD,kDAEC;AAED,oCAIC;AAED,8CAqBC;AAaD,sDAMC;AA2BD,oCA4CC;AA1KD,2DAAkC;AAClC,oCAKiB;AAWjB,oDAAgD;AAChD,iCAAqC;AAErC;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,GAAY;IAC/C,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAA;AAClD,CAAC;AAED,SAAgB,sBAAsB,CACpC,GAAY,EACZ,IAAqB;IAErB,MAAM,MAAM,GAA0B,EAAE,CAAA;IACxC,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QACzC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;YAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;aAAM,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACrC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,OAAO,CAAA;QAC7B,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,GAAY;IAC9C,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;AACzC,CAAC;AAED,SAAgB,YAAY,CAAC,GAAY;IACvC,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;IACrC,MAAM,GAAG,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAA;IACjE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;AACrB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,GAAY,EACZ,IAA2B,EAC3B,UAA2B;IAE3B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACjD,GAAG,CAAC,IAAI,CAAC,IAAI,4BAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QAC9C,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC,EAAE,EAAiB,CAAC,CAAA;IAErB,6CAA6C;IAC7C,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC;QACxB,MAAM,YAAY,GAAG,iBAAiB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QACvD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,GAAY,EACZ,IAAqB;IAErB,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;IAC/B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;IAC1C,IAAI,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACnE,OAAO,IAAI,6BAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;AACH,CAAC;AAED,SAAgB,qBAAqB,CACnC,GAAY,EACZ,IAAqB;IAErB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;IACxC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,GAAa,EAAE,KAAqB;IACvD,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,KAAK,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACpE,CAAC;AAUD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,YAAY,CAChC,GAAY,EACZ,UAA2B;IAE3B,yCAAyC;IACzC,MAAM,YAAY,GAAG,GAAG,CAAC,gBAAgB,EAAE;QACzC,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,qBAAqB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IAE1C,4EAA4E;IAC5E,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;IACzD,MAAM,MAAM,GAAkB,EAAE,CAAA;IAEhC,MAAM,WAAW,GAAG,IAAA,gBAAM,EACxB,OAAO,EACP,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAClB,MAAM,GAAG,GAAG,IAAA,mBAAY,EAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QAClC,IAAI,CAAC;YACH,6CAA6C;YAC7C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,iBAAS,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAA;YACjD,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAChB,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC,EACD,EAA8B,CAC/B,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,IAAA,gBAAM,EACzB,WAAW,EACX,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAkC,EAAE;QAChE,MAAM,UAAU,GAAG,MAAM,WAAW,CAAA;QACpC,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,KAAK,CAAA;QAC7B,OAAO,UAAU,CAAA;IACnB,CAAC,EACD,OAAO,CAAC,OAAO,CAAC,EAAE,CAAmC,CACtD,CAAA;IAED,MAAM,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAE5D,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;AACjC,CAAC"}

package/dist/src/autocomplete/__fixtures__/prog-autocomplete.d.ts

@@ -0,0 +1,3 @@
+import { program } from "../..";
+export { program };
+//# sourceMappingURL=prog-autocomplete.d.ts.map

package/dist/src/autocomplete/__fixtures__/prog-autocomplete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prog-autocomplete.d.ts","sourceRoot":"","sources":["../../../../src/autocomplete/__fixtures__/prog-autocomplete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAuB/B,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/dist/src/autocomplete/__fixtures__/prog-autocomplete.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.program = void 0;
+const __1 = require("../..");
+Object.defineProperty(exports, "program", { enumerable: true, get: function () { return __1.program; } });
+__1.program
+    .bin("pizza")
+    // First possible command: "order"
+    .command("order", "Order a pizza")
+    .argument("<type>", "Type of pizza", {
+    validator: ["margherita", "caprese", "quattro fromaggi"],
+})
+    .option("-e, --extra-ingredients <ingredients>", "Extra ingredients")
+    // Another command: "cancel"
+    .command("cancel", "Cancel an order")
+    .argument("<order-id>", "Order id")
+    .complete(function () {
+    return ["1234", "5678"];
+})
+    .option("-c, --cash-out <type>", "Cash out type")
+    .complete(() => {
+    return Promise.resolve(["cash", "paypal", "credit-card"]);
+});
+//# sourceMappingURL=prog-autocomplete.js.map

package/dist/src/autocomplete/__fixtures__/prog-autocomplete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prog-autocomplete.js","sourceRoot":"","sources":["../../../../src/autocomplete/__fixtures__/prog-autocomplete.ts"],"names":[],"mappings":";;;AAAA,6BAA+B;AAuBtB,wFAvBA,WAAO,OAuBA;AArBhB,WAAO;KACJ,GAAG,CAAC,OAAO,CAAC;IAEb,kCAAkC;KACjC,OAAO,CAAC,OAAO,EAAE,eAAe,CAAC;KACjC,QAAQ,CAAC,QAAQ,EAAE,eAAe,EAAE;IACnC,SAAS,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,kBAAkB,CAAC;CACzD,CAAC;KACD,MAAM,CAAC,uCAAuC,EAAE,mBAAmB,CAAC;IAErE,4BAA4B;KAC3B,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC;KACpC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;KAClC,QAAQ,CAAC;IACR,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACzB,CAAC,CAAC;KACD,MAAM,CAAC,uBAAuB,EAAE,eAAe,CAAC;KAChD,QAAQ,CAAC,GAAG,EAAE;IACb,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAA;AAC3D,CAAC,CAAC,CAAA"}

package/dist/src/autocomplete/__tests__/autocomplete.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=autocomplete.spec.d.ts.map

package/dist/src/autocomplete/__tests__/autocomplete.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autocomplete.spec.d.ts","sourceRoot":"","sources":["../../../../src/autocomplete/__tests__/autocomplete.spec.ts"],"names":[],"mappings":""}