parse-my-command 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Fardjad Davari
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,54 @@
1
+ # Parse My Command
2
+
3
+ Parse `argv` with **Commander.js** without executing the command
4
+
5
+ <div class="paragraph">
6
+
7
+ <span class="image"><a href="https://www.npmjs.com/package/parse-my-command" class="image"><img src="https://img.shields.io/npm/v/parse-my-command" alt="NPM Version" /></a></span> <span class="image"><a href="https://www.npmjs.com/package/parse-my-command" class="image"><img src="https://img.shields.io/npm/dm/parse-my-command" alt="Monthly Downloads" /></a></span> <span class="image"><a href="https://github.com/fardjad/node-parse-my-command/actions" class="image"><img src="https://img.shields.io/github/actions/workflow/status/fardjad/node-parse-my-command/test-and-release.yml?branch=main" alt="test-and-release Workflow Status" /></a></span>
8
+
9
+ </div>
10
+
11
+ <hr />
12
+
13
+ [Commander.js](https://github.com/tj/commander.js) doesn't support parsing
14
+ `argv` without executing the command. This package provides a workaround for that.
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ npm install --save parse-my-command
20
+ ```
21
+
22
+ ## Usage
23
+
24
+ ```js
25
+ import { Command } from "commander";
26
+ import { partialParse } from "parse-my-command";
27
+
28
+ const rootCommand = new Command("root")
29
+ .requiredOption("-a, --option-a <value>", "option a")
30
+ .action(() => {
31
+ throw new Error("This should never get called");
32
+ });
33
+
34
+ const childCommand = rootCommand
35
+ .command("child")
36
+ .requiredOption("-b, --option-b <value>", "option b")
37
+ .requiredOption("-c, --option-c <value>", "option c")
38
+ .action(() => {
39
+ throw new Error("This should never get called");
40
+ });
41
+
42
+ const argv = ["node", "index.mjs", "-a", "value1", "child", "-b", "value2"];
43
+
44
+ const { matchedCommand, providedOptions, missingOptions } = partialParse(
45
+ rootCommand,
46
+ argv,
47
+ );
48
+
49
+ console.log(matchedCommand.name()); // child
50
+ console.log(providedOptions.get(childCommand)); // { optionB: 'value2' }
51
+ console.log(missingOptions.get(childCommand)); // Set(1) { 'optionC' }
52
+ ```
53
+
54
+ More examples can be found in the [examples](/examples/) directory.
package/dist/index.cjs ADDED
@@ -0,0 +1,95 @@
1
+ var __create = Object.create;
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __getProtoOf = Object.getPrototypeOf;
6
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
7
+ var __export = (target, all) => {
8
+ for (var name in all)
9
+ __defProp(target, name, { get: all[name], enumerable: true });
10
+ };
11
+ var __copyProps = (to, from, except, desc) => {
12
+ if (from && typeof from === "object" || typeof from === "function") {
13
+ for (let key of __getOwnPropNames(from))
14
+ if (!__hasOwnProp.call(to, key) && key !== except)
15
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
16
+ }
17
+ return to;
18
+ };
19
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
20
+ // If the importer is in node compatibility mode or this is not an ESM
21
+ // file that has been converted to a CommonJS file using a Babel-
22
+ // compatible transform (i.e. "__esModule" has not been set), then set
23
+ // "default" to the CommonJS "module.exports" for node compatibility.
24
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
25
+ mod
26
+ ));
27
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
28
+
29
+ // src/index.ts
30
+ var src_exports = {};
31
+ __export(src_exports, {
32
+ findMissingOptions: () => findMissingOptions,
33
+ partialParse: () => partialParse
34
+ });
35
+ module.exports = __toCommonJS(src_exports);
36
+ var import_camelcase = __toESM(require("camelcase"), 1);
37
+ var import_commander = require("commander");
38
+ var findMissingOptions = (command, providedOptionsByCommand) => {
39
+ const missingOptionsByCommand = /* @__PURE__ */ new Map();
40
+ let currentCommand = command;
41
+ while (currentCommand) {
42
+ const missingOptions = /* @__PURE__ */ new Set();
43
+ const providedOptions = providedOptionsByCommand.get(currentCommand);
44
+ for (const option of currentCommand.options) {
45
+ const key = (0, import_camelcase.default)(option.long ?? option.short);
46
+ if (providedOptions?.[key]) {
47
+ continue;
48
+ }
49
+ missingOptions.add(key);
50
+ }
51
+ missingOptionsByCommand.set(currentCommand, missingOptions);
52
+ currentCommand = currentCommand.parent;
53
+ }
54
+ return missingOptionsByCommand;
55
+ };
56
+ var partialParse = (command, argv, options) => {
57
+ const providedOptions = /* @__PURE__ */ new Map();
58
+ const commandsMap = /* @__PURE__ */ new Map();
59
+ let matchedCommand;
60
+ const createParserCommand = (parserCommand2, command2) => {
61
+ commandsMap.set(parserCommand2, command2);
62
+ for (const option of command2.options) {
63
+ parserCommand2.option(option.flags, option.description);
64
+ }
65
+ parserCommand2.hook("preSubcommand", (thisCommand, actionCommand) => {
66
+ providedOptions.set(commandsMap.get(parserCommand2), thisCommand.opts());
67
+ providedOptions.set(commandsMap.get(actionCommand), thisCommand.opts());
68
+ });
69
+ parserCommand2.action(() => {
70
+ providedOptions.set(
71
+ commandsMap.get(parserCommand2),
72
+ parserCommand2.opts()
73
+ );
74
+ matchedCommand = command2;
75
+ });
76
+ for (const subcommand of command2.commands) {
77
+ const parserSubcommand = parserCommand2.command(subcommand.name()).exitOverride();
78
+ createParserCommand(parserSubcommand, subcommand);
79
+ }
80
+ return parserCommand2;
81
+ };
82
+ const parserCommand = createParserCommand(
83
+ new import_commander.Command().exitOverride(),
84
+ command
85
+ );
86
+ parserCommand.parse(argv, options);
87
+ const missingOptions = matchedCommand ? findMissingOptions(matchedCommand, providedOptions) : /* @__PURE__ */ new Map();
88
+ return { matchedCommand, missingOptions, providedOptions };
89
+ };
90
+ // Annotate the CommonJS export names for ESM import in node:
91
+ 0 && (module.exports = {
92
+ findMissingOptions,
93
+ partialParse
94
+ });
95
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJpbXBvcnQgY2FtZWxDYXNlIGZyb20gXCJjYW1lbGNhc2VcIjtcbmltcG9ydCB7IHR5cGUgT3B0aW9uVmFsdWVzLCBDb21tYW5kLCB0eXBlIFBhcnNlT3B0aW9ucyB9IGZyb20gXCJjb21tYW5kZXJcIjtcblxuZXhwb3J0IGNvbnN0IGZpbmRNaXNzaW5nT3B0aW9ucyA9IChcbiAgY29tbWFuZDogQ29tbWFuZCxcbiAgcHJvdmlkZWRPcHRpb25zQnlDb21tYW5kOiBNYXA8Q29tbWFuZCwgT3B0aW9uVmFsdWVzPixcbikgPT4ge1xuICBjb25zdCBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZCA9IG5ldyBNYXA8Q29tbWFuZCwgU2V0PHN0cmluZz4+KCk7XG5cbiAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9iYW4tdHlwZXNcbiAgbGV0IGN1cnJlbnRDb21tYW5kOiBDb21tYW5kIHwgdW5kZWZpbmVkIHwgbnVsbCA9IGNvbW1hbmQ7XG5cbiAgd2hpbGUgKGN1cnJlbnRDb21tYW5kKSB7XG4gICAgY29uc3QgbWlzc2luZ09wdGlvbnMgPSBuZXcgU2V0PHN0cmluZz4oKTtcbiAgICBjb25zdCBwcm92aWRlZE9wdGlvbnMgPSBwcm92aWRlZE9wdGlvbnNCeUNvbW1hbmQuZ2V0KGN1cnJlbnRDb21tYW5kKTtcbiAgICBmb3IgKGNvbnN0IG9wdGlvbiBvZiBjdXJyZW50Q29tbWFuZC5vcHRpb25zKSB7XG4gICAgICBjb25zdCBrZXkgPSBjYW1lbENhc2UoKG9wdGlvbi5sb25nID8/IG9wdGlvbi5zaG9ydCkhKTtcbiAgICAgIGlmIChwcm92aWRlZE9wdGlvbnM/LltrZXldKSB7XG4gICAgICAgIGNvbnRpbnVlO1xuICAgICAgfVxuXG4gICAgICBtaXNzaW5nT3B0aW9ucy5hZGQoa2V5KTtcbiAgICB9XG5cbiAgICBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZC5zZXQoY3VycmVudENvbW1hbmQsIG1pc3NpbmdPcHRpb25zKTtcbiAgICBjdXJyZW50Q29tbWFuZCA9IGN1cnJlbnRDb21tYW5kLnBhcmVudDtcbiAgfVxuXG4gIHJldHVybiBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZDtcbn07XG5cbmV4cG9ydCB0eXBlIFBhcnRpYWxQYXJzZVJlc3VsdCA9IHtcbiAgLyoqXG4gICAqIFRoZSBjb21tYW5kIHdob3NlIGFjdGlvbiB3aWxsIGJlIGV4ZWN1dGVkXG4gICAqL1xuICBtYXRjaGVkQ29tbWFuZDogQ29tbWFuZCB8IHVuZGVmaW5lZDtcbiAgLyoqXG4gICAqIEEgbWFwIG9mIGNvbW1hbmRzIHRvIGEgc2V0IG9mIG1pc3Npbmcgb3B0aW9ucyBmb3IgdGhhdCBjb21tYW5kXG4gICAqL1xuICBtaXNzaW5nT3B0aW9uczogTWFwPENvbW1hbmQsIFNldDxzdHJpbmc+PjtcbiAgLyoqXG4gICAqIEEgbWFwIG9mIGNvbW1hbmRzIHRvIHRoZSBvcHRpb25zIHByb3ZpZGVkIGZvciB0aGF0IGNvbW1hbmRcbiAgICovXG4gIHByb3ZpZGVkT3B0aW9uczogTWFwPENvbW1hbmQsIE9wdGlvblZhbHVlcz47XG59O1xuXG4vKipcbiAqIFBhcnRpYWxseSBwYXJzZSBhcmd2IGZvciBhIGNvbW1hbmQgd2l0aG91dCBleGVjdXRpbmcgdGhlIGFjdGlvbi4gQHNlZSB7QGxpbmsgQ29tbWFuZC5wYXJzZX1cbiAqXG4gKiBAcmV0dXJucyBBbiBvYmplY3QgY29udGFpbmluZyB0aGUgbWF0Y2hlZCBjb21tYW5kLCB0aGUgcHJvdmlkZWQgb3B0aW9ucywgYW5kIHRoZSBtaXNzaW5nIG9wdGlvbnMuXG4gKi9cbmV4cG9ydCBjb25zdCBwYXJ0aWFsUGFyc2UgPSAoXG4gIGNvbW1hbmQ6IENvbW1hbmQsXG4gIGFyZ3Y6IHJlYWRvbmx5IHN0cmluZ1tdLFxuICBvcHRpb25zPzogUGFyc2VPcHRpb25zLFxuKTogUGFydGlhbFBhcnNlUmVzdWx0ID0+IHtcbiAgY29uc3QgcHJvdmlkZWRPcHRpb25zID0gbmV3IE1hcDxDb21tYW5kLCBPcHRpb25WYWx1ZXM+KCk7XG4gIGNvbnN0IGNvbW1hbmRzTWFwID0gbmV3IE1hcDxDb21tYW5kLCBDb21tYW5kPigpO1xuICBsZXQgbWF0Y2hlZENvbW1hbmQ6IENvbW1hbmQgfCB1bmRlZmluZWQ7XG5cbiAgY29uc3QgY3JlYXRlUGFyc2VyQ29tbWFuZCA9IChwYXJzZXJDb21tYW5kOiBDb21tYW5kLCBjb21tYW5kOiBDb21tYW5kKSA9PiB7XG4gICAgY29tbWFuZHNNYXAuc2V0KHBhcnNlckNvbW1hbmQsIGNvbW1hbmQpO1xuXG4gICAgZm9yIChjb25zdCBvcHRpb24gb2YgY29tbWFuZC5vcHRpb25zKSB7XG4gICAgICBwYXJzZXJDb21tYW5kLm9wdGlvbihvcHRpb24uZmxhZ3MsIG9wdGlvbi5kZXNjcmlwdGlvbik7XG4gICAgfVxuXG4gICAgcGFyc2VyQ29tbWFuZC5ob29rKFwicHJlU3ViY29tbWFuZFwiLCAodGhpc0NvbW1hbmQsIGFjdGlvbkNvbW1hbmQpID0+IHtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoY29tbWFuZHNNYXAuZ2V0KHBhcnNlckNvbW1hbmQpISwgdGhpc0NvbW1hbmQub3B0cygpKTtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoY29tbWFuZHNNYXAuZ2V0KGFjdGlvbkNvbW1hbmQpISwgdGhpc0NvbW1hbmQub3B0cygpKTtcbiAgICB9KTtcblxuICAgIHBhcnNlckNvbW1hbmQuYWN0aW9uKCgpID0+IHtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoXG4gICAgICAgIGNvbW1hbmRzTWFwLmdldChwYXJzZXJDb21tYW5kKSEsXG4gICAgICAgIHBhcnNlckNvbW1hbmQub3B0cygpLFxuICAgICAgKTtcbiAgICAgIG1hdGNoZWRDb21tYW5kID0gY29tbWFuZDtcbiAgICB9KTtcblxuICAgIGZvciAoY29uc3Qgc3ViY29tbWFuZCBvZiBjb21tYW5kLmNvbW1hbmRzIGFzIENvbW1hbmRbXSkge1xuICAgICAgY29uc3QgcGFyc2VyU3ViY29tbWFuZCA9IHBhcnNlckNvbW1hbmRcbiAgICAgICAgLmNvbW1hbmQoc3ViY29tbWFuZC5uYW1lKCkpXG4gICAgICAgIC5leGl0T3ZlcnJpZGUoKTtcbiAgICAgIGNyZWF0ZVBhcnNlckNvbW1hbmQocGFyc2VyU3ViY29tbWFuZCwgc3ViY29tbWFuZCk7XG4gICAgfVxuXG4gICAgcmV0dXJuIHBhcnNlckNvbW1hbmQ7XG4gIH07XG5cbiAgY29uc3QgcGFyc2VyQ29tbWFuZCA9IGNyZWF0ZVBhcnNlckNvbW1hbmQoXG4gICAgbmV3IENvbW1hbmQoKS5leGl0T3ZlcnJpZGUoKSxcbiAgICBjb21tYW5kLFxuICApO1xuICBwYXJzZXJDb21tYW5kLnBhcnNlKGFyZ3YsIG9wdGlvbnMpO1xuXG4gIGNvbnN0IG1pc3NpbmdPcHRpb25zID0gbWF0Y2hlZENvbW1hbmRcbiAgICA/IGZpbmRNaXNzaW5nT3B0aW9ucyhtYXRjaGVkQ29tbWFuZCwgcHJvdmlkZWRPcHRpb25zKVxuICAgIDogbmV3IE1hcDxDb21tYW5kLCBTZXQ8c3RyaW5nPj4oKTtcblxuICByZXR1cm4geyBtYXRjaGVkQ29tbWFuZCwgbWlzc2luZ09wdGlvbnMsIHByb3ZpZGVkT3B0aW9ucyB9O1xufTtcbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsdUJBQXNCO0FBQ3RCLHVCQUE4RDtBQUV2RCxJQUFNLHFCQUFxQixDQUNoQyxTQUNBLDZCQUNHO0FBQ0gsUUFBTSwwQkFBMEIsb0JBQUksSUFBMEI7QUFHOUQsTUFBSSxpQkFBNkM7QUFFakQsU0FBTyxnQkFBZ0I7QUFDckIsVUFBTSxpQkFBaUIsb0JBQUksSUFBWTtBQUN2QyxVQUFNLGtCQUFrQix5QkFBeUIsSUFBSSxjQUFjO0FBQ25FLGVBQVcsVUFBVSxlQUFlLFNBQVM7QUFDM0MsWUFBTSxVQUFNLGlCQUFBQSxTQUFXLE9BQU8sUUFBUSxPQUFPLEtBQU87QUFDcEQsVUFBSSxrQkFBa0IsR0FBRyxHQUFHO0FBQzFCO0FBQUEsTUFDRjtBQUVBLHFCQUFlLElBQUksR0FBRztBQUFBLElBQ3hCO0FBRUEsNEJBQXdCLElBQUksZ0JBQWdCLGNBQWM7QUFDMUQscUJBQWlCLGVBQWU7QUFBQSxFQUNsQztBQUVBLFNBQU87QUFDVDtBQXNCTyxJQUFNLGVBQWUsQ0FDMUIsU0FDQSxNQUNBLFlBQ3VCO0FBQ3ZCLFFBQU0sa0JBQWtCLG9CQUFJLElBQTJCO0FBQ3ZELFFBQU0sY0FBYyxvQkFBSSxJQUFzQjtBQUM5QyxNQUFJO0FBRUosUUFBTSxzQkFBc0IsQ0FBQ0MsZ0JBQXdCQyxhQUFxQjtBQUN4RSxnQkFBWSxJQUFJRCxnQkFBZUMsUUFBTztBQUV0QyxlQUFXLFVBQVVBLFNBQVEsU0FBUztBQUNwQyxNQUFBRCxlQUFjLE9BQU8sT0FBTyxPQUFPLE9BQU8sV0FBVztBQUFBLElBQ3ZEO0FBRUEsSUFBQUEsZUFBYyxLQUFLLGlCQUFpQixDQUFDLGFBQWEsa0JBQWtCO0FBQ2xFLHNCQUFnQixJQUFJLFlBQVksSUFBSUEsY0FBYSxHQUFJLFlBQVksS0FBSyxDQUFDO0FBQ3ZFLHNCQUFnQixJQUFJLFlBQVksSUFBSSxhQUFhLEdBQUksWUFBWSxLQUFLLENBQUM7QUFBQSxJQUN6RSxDQUFDO0FBRUQsSUFBQUEsZUFBYyxPQUFPLE1BQU07QUFDekIsc0JBQWdCO0FBQUEsUUFDZCxZQUFZLElBQUlBLGNBQWE7QUFBQSxRQUM3QkEsZUFBYyxLQUFLO0FBQUEsTUFDckI7QUFDQSx1QkFBaUJDO0FBQUEsSUFDbkIsQ0FBQztBQUVELGVBQVcsY0FBY0EsU0FBUSxVQUF1QjtBQUN0RCxZQUFNLG1CQUFtQkQsZUFDdEIsUUFBUSxXQUFXLEtBQUssQ0FBQyxFQUN6QixhQUFhO0FBQ2hCLDBCQUFvQixrQkFBa0IsVUFBVTtBQUFBLElBQ2xEO0FBRUEsV0FBT0E7QUFBQSxFQUNUO0FBRUEsUUFBTSxnQkFBZ0I7QUFBQSxJQUNwQixJQUFJLHlCQUFRLEVBQUUsYUFBYTtBQUFBLElBQzNCO0FBQUEsRUFDRjtBQUNBLGdCQUFjLE1BQU0sTUFBTSxPQUFPO0FBRWpDLFFBQU0saUJBQWlCLGlCQUNuQixtQkFBbUIsZ0JBQWdCLGVBQWUsSUFDbEQsb0JBQUksSUFBMEI7QUFFbEMsU0FBTyxFQUFFLGdCQUFnQixnQkFBZ0IsZ0JBQWdCO0FBQzNEOyIsCiAgIm5hbWVzIjogWyJjYW1lbENhc2UiLCAicGFyc2VyQ29tbWFuZCIsICJjb21tYW5kIl0KfQo=
@@ -0,0 +1,25 @@
1
+ import { Command, OptionValues, ParseOptions } from 'commander';
2
+
3
+ declare const findMissingOptions: (command: Command, providedOptionsByCommand: Map<Command, OptionValues>) => Map<Command, Set<string>>;
4
+ type PartialParseResult = {
5
+ /**
6
+ * The command whose action will be executed
7
+ */
8
+ matchedCommand: Command | undefined;
9
+ /**
10
+ * A map of commands to a set of missing options for that command
11
+ */
12
+ missingOptions: Map<Command, Set<string>>;
13
+ /**
14
+ * A map of commands to the options provided for that command
15
+ */
16
+ providedOptions: Map<Command, OptionValues>;
17
+ };
18
+ /**
19
+ * Partially parse argv for a command without executing the action. @see {@link Command.parse}
20
+ *
21
+ * @returns An object containing the matched command, the provided options, and the missing options.
22
+ */
23
+ declare const partialParse: (command: Command, argv: readonly string[], options?: ParseOptions) => PartialParseResult;
24
+
25
+ export { PartialParseResult, findMissingOptions, partialParse };
@@ -0,0 +1,25 @@
1
+ import { Command, OptionValues, ParseOptions } from 'commander';
2
+
3
+ declare const findMissingOptions: (command: Command, providedOptionsByCommand: Map<Command, OptionValues>) => Map<Command, Set<string>>;
4
+ type PartialParseResult = {
5
+ /**
6
+ * The command whose action will be executed
7
+ */
8
+ matchedCommand: Command | undefined;
9
+ /**
10
+ * A map of commands to a set of missing options for that command
11
+ */
12
+ missingOptions: Map<Command, Set<string>>;
13
+ /**
14
+ * A map of commands to the options provided for that command
15
+ */
16
+ providedOptions: Map<Command, OptionValues>;
17
+ };
18
+ /**
19
+ * Partially parse argv for a command without executing the action. @see {@link Command.parse}
20
+ *
21
+ * @returns An object containing the matched command, the provided options, and the missing options.
22
+ */
23
+ declare const partialParse: (command: Command, argv: readonly string[], options?: ParseOptions) => PartialParseResult;
24
+
25
+ export { PartialParseResult, findMissingOptions, partialParse };
package/dist/index.js ADDED
@@ -0,0 +1,60 @@
1
+ // src/index.ts
2
+ import camelCase from "camelcase";
3
+ import { Command } from "commander";
4
+ var findMissingOptions = (command, providedOptionsByCommand) => {
5
+ const missingOptionsByCommand = /* @__PURE__ */ new Map();
6
+ let currentCommand = command;
7
+ while (currentCommand) {
8
+ const missingOptions = /* @__PURE__ */ new Set();
9
+ const providedOptions = providedOptionsByCommand.get(currentCommand);
10
+ for (const option of currentCommand.options) {
11
+ const key = camelCase(option.long ?? option.short);
12
+ if (providedOptions?.[key]) {
13
+ continue;
14
+ }
15
+ missingOptions.add(key);
16
+ }
17
+ missingOptionsByCommand.set(currentCommand, missingOptions);
18
+ currentCommand = currentCommand.parent;
19
+ }
20
+ return missingOptionsByCommand;
21
+ };
22
+ var partialParse = (command, argv, options) => {
23
+ const providedOptions = /* @__PURE__ */ new Map();
24
+ const commandsMap = /* @__PURE__ */ new Map();
25
+ let matchedCommand;
26
+ const createParserCommand = (parserCommand2, command2) => {
27
+ commandsMap.set(parserCommand2, command2);
28
+ for (const option of command2.options) {
29
+ parserCommand2.option(option.flags, option.description);
30
+ }
31
+ parserCommand2.hook("preSubcommand", (thisCommand, actionCommand) => {
32
+ providedOptions.set(commandsMap.get(parserCommand2), thisCommand.opts());
33
+ providedOptions.set(commandsMap.get(actionCommand), thisCommand.opts());
34
+ });
35
+ parserCommand2.action(() => {
36
+ providedOptions.set(
37
+ commandsMap.get(parserCommand2),
38
+ parserCommand2.opts()
39
+ );
40
+ matchedCommand = command2;
41
+ });
42
+ for (const subcommand of command2.commands) {
43
+ const parserSubcommand = parserCommand2.command(subcommand.name()).exitOverride();
44
+ createParserCommand(parserSubcommand, subcommand);
45
+ }
46
+ return parserCommand2;
47
+ };
48
+ const parserCommand = createParserCommand(
49
+ new Command().exitOverride(),
50
+ command
51
+ );
52
+ parserCommand.parse(argv, options);
53
+ const missingOptions = matchedCommand ? findMissingOptions(matchedCommand, providedOptions) : /* @__PURE__ */ new Map();
54
+ return { matchedCommand, missingOptions, providedOptions };
55
+ };
56
+ export {
57
+ findMissingOptions,
58
+ partialParse
59
+ };
60
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJpbXBvcnQgY2FtZWxDYXNlIGZyb20gXCJjYW1lbGNhc2VcIjtcbmltcG9ydCB7IHR5cGUgT3B0aW9uVmFsdWVzLCBDb21tYW5kLCB0eXBlIFBhcnNlT3B0aW9ucyB9IGZyb20gXCJjb21tYW5kZXJcIjtcblxuZXhwb3J0IGNvbnN0IGZpbmRNaXNzaW5nT3B0aW9ucyA9IChcbiAgY29tbWFuZDogQ29tbWFuZCxcbiAgcHJvdmlkZWRPcHRpb25zQnlDb21tYW5kOiBNYXA8Q29tbWFuZCwgT3B0aW9uVmFsdWVzPixcbikgPT4ge1xuICBjb25zdCBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZCA9IG5ldyBNYXA8Q29tbWFuZCwgU2V0PHN0cmluZz4+KCk7XG5cbiAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9iYW4tdHlwZXNcbiAgbGV0IGN1cnJlbnRDb21tYW5kOiBDb21tYW5kIHwgdW5kZWZpbmVkIHwgbnVsbCA9IGNvbW1hbmQ7XG5cbiAgd2hpbGUgKGN1cnJlbnRDb21tYW5kKSB7XG4gICAgY29uc3QgbWlzc2luZ09wdGlvbnMgPSBuZXcgU2V0PHN0cmluZz4oKTtcbiAgICBjb25zdCBwcm92aWRlZE9wdGlvbnMgPSBwcm92aWRlZE9wdGlvbnNCeUNvbW1hbmQuZ2V0KGN1cnJlbnRDb21tYW5kKTtcbiAgICBmb3IgKGNvbnN0IG9wdGlvbiBvZiBjdXJyZW50Q29tbWFuZC5vcHRpb25zKSB7XG4gICAgICBjb25zdCBrZXkgPSBjYW1lbENhc2UoKG9wdGlvbi5sb25nID8/IG9wdGlvbi5zaG9ydCkhKTtcbiAgICAgIGlmIChwcm92aWRlZE9wdGlvbnM/LltrZXldKSB7XG4gICAgICAgIGNvbnRpbnVlO1xuICAgICAgfVxuXG4gICAgICBtaXNzaW5nT3B0aW9ucy5hZGQoa2V5KTtcbiAgICB9XG5cbiAgICBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZC5zZXQoY3VycmVudENvbW1hbmQsIG1pc3NpbmdPcHRpb25zKTtcbiAgICBjdXJyZW50Q29tbWFuZCA9IGN1cnJlbnRDb21tYW5kLnBhcmVudDtcbiAgfVxuXG4gIHJldHVybiBtaXNzaW5nT3B0aW9uc0J5Q29tbWFuZDtcbn07XG5cbmV4cG9ydCB0eXBlIFBhcnRpYWxQYXJzZVJlc3VsdCA9IHtcbiAgLyoqXG4gICAqIFRoZSBjb21tYW5kIHdob3NlIGFjdGlvbiB3aWxsIGJlIGV4ZWN1dGVkXG4gICAqL1xuICBtYXRjaGVkQ29tbWFuZDogQ29tbWFuZCB8IHVuZGVmaW5lZDtcbiAgLyoqXG4gICAqIEEgbWFwIG9mIGNvbW1hbmRzIHRvIGEgc2V0IG9mIG1pc3Npbmcgb3B0aW9ucyBmb3IgdGhhdCBjb21tYW5kXG4gICAqL1xuICBtaXNzaW5nT3B0aW9uczogTWFwPENvbW1hbmQsIFNldDxzdHJpbmc+PjtcbiAgLyoqXG4gICAqIEEgbWFwIG9mIGNvbW1hbmRzIHRvIHRoZSBvcHRpb25zIHByb3ZpZGVkIGZvciB0aGF0IGNvbW1hbmRcbiAgICovXG4gIHByb3ZpZGVkT3B0aW9uczogTWFwPENvbW1hbmQsIE9wdGlvblZhbHVlcz47XG59O1xuXG4vKipcbiAqIFBhcnRpYWxseSBwYXJzZSBhcmd2IGZvciBhIGNvbW1hbmQgd2l0aG91dCBleGVjdXRpbmcgdGhlIGFjdGlvbi4gQHNlZSB7QGxpbmsgQ29tbWFuZC5wYXJzZX1cbiAqXG4gKiBAcmV0dXJucyBBbiBvYmplY3QgY29udGFpbmluZyB0aGUgbWF0Y2hlZCBjb21tYW5kLCB0aGUgcHJvdmlkZWQgb3B0aW9ucywgYW5kIHRoZSBtaXNzaW5nIG9wdGlvbnMuXG4gKi9cbmV4cG9ydCBjb25zdCBwYXJ0aWFsUGFyc2UgPSAoXG4gIGNvbW1hbmQ6IENvbW1hbmQsXG4gIGFyZ3Y6IHJlYWRvbmx5IHN0cmluZ1tdLFxuICBvcHRpb25zPzogUGFyc2VPcHRpb25zLFxuKTogUGFydGlhbFBhcnNlUmVzdWx0ID0+IHtcbiAgY29uc3QgcHJvdmlkZWRPcHRpb25zID0gbmV3IE1hcDxDb21tYW5kLCBPcHRpb25WYWx1ZXM+KCk7XG4gIGNvbnN0IGNvbW1hbmRzTWFwID0gbmV3IE1hcDxDb21tYW5kLCBDb21tYW5kPigpO1xuICBsZXQgbWF0Y2hlZENvbW1hbmQ6IENvbW1hbmQgfCB1bmRlZmluZWQ7XG5cbiAgY29uc3QgY3JlYXRlUGFyc2VyQ29tbWFuZCA9IChwYXJzZXJDb21tYW5kOiBDb21tYW5kLCBjb21tYW5kOiBDb21tYW5kKSA9PiB7XG4gICAgY29tbWFuZHNNYXAuc2V0KHBhcnNlckNvbW1hbmQsIGNvbW1hbmQpO1xuXG4gICAgZm9yIChjb25zdCBvcHRpb24gb2YgY29tbWFuZC5vcHRpb25zKSB7XG4gICAgICBwYXJzZXJDb21tYW5kLm9wdGlvbihvcHRpb24uZmxhZ3MsIG9wdGlvbi5kZXNjcmlwdGlvbik7XG4gICAgfVxuXG4gICAgcGFyc2VyQ29tbWFuZC5ob29rKFwicHJlU3ViY29tbWFuZFwiLCAodGhpc0NvbW1hbmQsIGFjdGlvbkNvbW1hbmQpID0+IHtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoY29tbWFuZHNNYXAuZ2V0KHBhcnNlckNvbW1hbmQpISwgdGhpc0NvbW1hbmQub3B0cygpKTtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoY29tbWFuZHNNYXAuZ2V0KGFjdGlvbkNvbW1hbmQpISwgdGhpc0NvbW1hbmQub3B0cygpKTtcbiAgICB9KTtcblxuICAgIHBhcnNlckNvbW1hbmQuYWN0aW9uKCgpID0+IHtcbiAgICAgIHByb3ZpZGVkT3B0aW9ucy5zZXQoXG4gICAgICAgIGNvbW1hbmRzTWFwLmdldChwYXJzZXJDb21tYW5kKSEsXG4gICAgICAgIHBhcnNlckNvbW1hbmQub3B0cygpLFxuICAgICAgKTtcbiAgICAgIG1hdGNoZWRDb21tYW5kID0gY29tbWFuZDtcbiAgICB9KTtcblxuICAgIGZvciAoY29uc3Qgc3ViY29tbWFuZCBvZiBjb21tYW5kLmNvbW1hbmRzIGFzIENvbW1hbmRbXSkge1xuICAgICAgY29uc3QgcGFyc2VyU3ViY29tbWFuZCA9IHBhcnNlckNvbW1hbmRcbiAgICAgICAgLmNvbW1hbmQoc3ViY29tbWFuZC5uYW1lKCkpXG4gICAgICAgIC5leGl0T3ZlcnJpZGUoKTtcbiAgICAgIGNyZWF0ZVBhcnNlckNvbW1hbmQocGFyc2VyU3ViY29tbWFuZCwgc3ViY29tbWFuZCk7XG4gICAgfVxuXG4gICAgcmV0dXJuIHBhcnNlckNvbW1hbmQ7XG4gIH07XG5cbiAgY29uc3QgcGFyc2VyQ29tbWFuZCA9IGNyZWF0ZVBhcnNlckNvbW1hbmQoXG4gICAgbmV3IENvbW1hbmQoKS5leGl0T3ZlcnJpZGUoKSxcbiAgICBjb21tYW5kLFxuICApO1xuICBwYXJzZXJDb21tYW5kLnBhcnNlKGFyZ3YsIG9wdGlvbnMpO1xuXG4gIGNvbnN0IG1pc3NpbmdPcHRpb25zID0gbWF0Y2hlZENvbW1hbmRcbiAgICA/IGZpbmRNaXNzaW5nT3B0aW9ucyhtYXRjaGVkQ29tbWFuZCwgcHJvdmlkZWRPcHRpb25zKVxuICAgIDogbmV3IE1hcDxDb21tYW5kLCBTZXQ8c3RyaW5nPj4oKTtcblxuICByZXR1cm4geyBtYXRjaGVkQ29tbWFuZCwgbWlzc2luZ09wdGlvbnMsIHByb3ZpZGVkT3B0aW9ucyB9O1xufTtcbiJdLAogICJtYXBwaW5ncyI6ICI7QUFBQSxPQUFPLGVBQWU7QUFDdEIsU0FBNEIsZUFBa0M7QUFFdkQsSUFBTSxxQkFBcUIsQ0FDaEMsU0FDQSw2QkFDRztBQUNILFFBQU0sMEJBQTBCLG9CQUFJLElBQTBCO0FBRzlELE1BQUksaUJBQTZDO0FBRWpELFNBQU8sZ0JBQWdCO0FBQ3JCLFVBQU0saUJBQWlCLG9CQUFJLElBQVk7QUFDdkMsVUFBTSxrQkFBa0IseUJBQXlCLElBQUksY0FBYztBQUNuRSxlQUFXLFVBQVUsZUFBZSxTQUFTO0FBQzNDLFlBQU0sTUFBTSxVQUFXLE9BQU8sUUFBUSxPQUFPLEtBQU87QUFDcEQsVUFBSSxrQkFBa0IsR0FBRyxHQUFHO0FBQzFCO0FBQUEsTUFDRjtBQUVBLHFCQUFlLElBQUksR0FBRztBQUFBLElBQ3hCO0FBRUEsNEJBQXdCLElBQUksZ0JBQWdCLGNBQWM7QUFDMUQscUJBQWlCLGVBQWU7QUFBQSxFQUNsQztBQUVBLFNBQU87QUFDVDtBQXNCTyxJQUFNLGVBQWUsQ0FDMUIsU0FDQSxNQUNBLFlBQ3VCO0FBQ3ZCLFFBQU0sa0JBQWtCLG9CQUFJLElBQTJCO0FBQ3ZELFFBQU0sY0FBYyxvQkFBSSxJQUFzQjtBQUM5QyxNQUFJO0FBRUosUUFBTSxzQkFBc0IsQ0FBQ0EsZ0JBQXdCQyxhQUFxQjtBQUN4RSxnQkFBWSxJQUFJRCxnQkFBZUMsUUFBTztBQUV0QyxlQUFXLFVBQVVBLFNBQVEsU0FBUztBQUNwQyxNQUFBRCxlQUFjLE9BQU8sT0FBTyxPQUFPLE9BQU8sV0FBVztBQUFBLElBQ3ZEO0FBRUEsSUFBQUEsZUFBYyxLQUFLLGlCQUFpQixDQUFDLGFBQWEsa0JBQWtCO0FBQ2xFLHNCQUFnQixJQUFJLFlBQVksSUFBSUEsY0FBYSxHQUFJLFlBQVksS0FBSyxDQUFDO0FBQ3ZFLHNCQUFnQixJQUFJLFlBQVksSUFBSSxhQUFhLEdBQUksWUFBWSxLQUFLLENBQUM7QUFBQSxJQUN6RSxDQUFDO0FBRUQsSUFBQUEsZUFBYyxPQUFPLE1BQU07QUFDekIsc0JBQWdCO0FBQUEsUUFDZCxZQUFZLElBQUlBLGNBQWE7QUFBQSxRQUM3QkEsZUFBYyxLQUFLO0FBQUEsTUFDckI7QUFDQSx1QkFBaUJDO0FBQUEsSUFDbkIsQ0FBQztBQUVELGVBQVcsY0FBY0EsU0FBUSxVQUF1QjtBQUN0RCxZQUFNLG1CQUFtQkQsZUFDdEIsUUFBUSxXQUFXLEtBQUssQ0FBQyxFQUN6QixhQUFhO0FBQ2hCLDBCQUFvQixrQkFBa0IsVUFBVTtBQUFBLElBQ2xEO0FBRUEsV0FBT0E7QUFBQSxFQUNUO0FBRUEsUUFBTSxnQkFBZ0I7QUFBQSxJQUNwQixJQUFJLFFBQVEsRUFBRSxhQUFhO0FBQUEsSUFDM0I7QUFBQSxFQUNGO0FBQ0EsZ0JBQWMsTUFBTSxNQUFNLE9BQU87QUFFakMsUUFBTSxpQkFBaUIsaUJBQ25CLG1CQUFtQixnQkFBZ0IsZUFBZSxJQUNsRCxvQkFBSSxJQUEwQjtBQUVsQyxTQUFPLEVBQUUsZ0JBQWdCLGdCQUFnQixnQkFBZ0I7QUFDM0Q7IiwKICAibmFtZXMiOiBbInBhcnNlckNvbW1hbmQiLCAiY29tbWFuZCJdCn0K
package/package.json ADDED
@@ -0,0 +1,77 @@
1
+ {
2
+ "name": "parse-my-command",
3
+ "version": "0.1.0",
4
+ "description": "Parse argv with Commander.js without executing the command",
5
+ "keywords": [],
6
+ "homepage": "https://github.com/fardjad/node-parse-my-command",
7
+ "bugs": {
8
+ "url": "https://github.com/fardjad/node-parse-my-command/issues"
9
+ },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+ssh://git@github.com/fardjad/node-parse-my-command.git"
13
+ },
14
+ "license": "MIT",
15
+ "author": "Fardjad Davari <public@fardjad.com>",
16
+ "type": "module",
17
+ "exports": {
18
+ ".": {
19
+ "require": {
20
+ "default": "./dist/index.cjs",
21
+ "types": "./dist/index.d.cts"
22
+ },
23
+ "import": {
24
+ "default": "./dist/index.js",
25
+ "types": "./dist/index.d.ts"
26
+ }
27
+ }
28
+ },
29
+ "main": "dist/index.cjs",
30
+ "types": "dist/index.d.ts",
31
+ "files": [
32
+ "dist/index.cjs",
33
+ "dist/index.d.cts",
34
+ "dist/index.d.ts",
35
+ "dist/index.js"
36
+ ],
37
+ "scripts": {
38
+ "fix": "prettier --write . && eslint --ext .js --ext .cjs --ext .mjs --ext .ts --ext .cts --ext .mts --ext .d.ts --fix .",
39
+ "lint": "prettier --check . && eslint --ext .js --ext .cjs --ext .mjs --ext .ts --ext .cts --ext .mts --ext .d.ts .",
40
+ "prepare": "tsup ./src/index.ts --format esm,cjs --dts --clean --sourcemap inline --silent",
41
+ "pretest": "tsc",
42
+ "test": "glob -c \"tsx --test --test-reporter spec\" \"src/**/*.test.ts\"",
43
+ "posttest": "npm run lint",
44
+ "test:coverage": "c8 npm run test"
45
+ },
46
+ "c8": {
47
+ "reporter": [
48
+ "lcov"
49
+ ]
50
+ },
51
+ "dependencies": {
52
+ "camelcase": "^8.0.0",
53
+ "commander": "^11.0.0"
54
+ },
55
+ "devDependencies": {
56
+ "@trivago/prettier-plugin-sort-imports": "^4.2.0",
57
+ "@types/node": "^20.5.8",
58
+ "@typescript-eslint/eslint-plugin": "^6.5.0",
59
+ "@typescript-eslint/parser": "^6.5.0",
60
+ "c8": "^8.0.1",
61
+ "eslint": "^8.48.0",
62
+ "eslint-config-prettier": "^9.0.0",
63
+ "eslint-config-xo": "^0.43.1",
64
+ "eslint-config-xo-typescript": "^1.0.1",
65
+ "eslint-plugin-unicorn": "^48.0.1",
66
+ "glob": "^10.3.4",
67
+ "npm-check-updates": "^16.13.2",
68
+ "prettier": "^3.0.3",
69
+ "prettier-plugin-packagejson": "^2.4.5",
70
+ "tsup": "^7.2.0",
71
+ "tsx": "^3.12.8",
72
+ "typescript": "^5.2.2"
73
+ },
74
+ "engines": {
75
+ "node": ">=18"
76
+ }
77
+ }