https://github.com/fardjad/node-parse-my-command
Parse argv with Commander.js without executing the command
https://github.com/fardjad/node-parse-my-command
argv commander commanderjs nodejs parser
Last synced: 6 months ago
JSON representation
Parse argv with Commander.js without executing the command
- Host: GitHub
- URL: https://github.com/fardjad/node-parse-my-command
- Owner: fardjad
- License: mit
- Created: 2023-09-02T18:27:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T13:13:17.000Z (6 months ago)
- Last Synced: 2024-11-14T06:36:32.149Z (6 months ago)
- Topics: argv, commander, commanderjs, nodejs, parser
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/parse-my-command
- Size: 744 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Parse My Command
Parse `argv` with **Commander.js** without executing the command
[Commander.js](https://github.com/tj/commander.js) doesn't support parsing
`argv` without executing the command. This module provides a workaround for that.
## Installation
```bash
npm install --save parse-my-command
```
## Usage
```js
import { Command } from "commander";
import { partialParse } from "parse-my-command";
const rootCommand = new Command("root")
.requiredOption("-a, --option-a ", "option a")
.action(() => {
throw new Error("This should never get called");
});
const childCommand = rootCommand
.command("child")
.requiredOption("-b, --option-b ", "option b")
.requiredOption("-c, --option-c ", "option c")
.action(() => {
throw new Error("This should never get called");
});
const argv = ["node", "index.mjs", "-a", "value1", "child", "-b", "value2"];
const {
matchedCommand,
providedOptions,
missingOptions,
providedOptionsSources,
} = partialParse(rootCommand, argv);
console.log(matchedCommand.name()); // child
console.log(providedOptions.get(childCommand)); // { optionB: 'value2' }
console.log(missingOptions.get(childCommand)); // Set(1) { 'optionC' }
console.log(providedOptionsSources.get(childCommand)); // Map(1) { 'optionB' => 'cli' }
```
More examples can be found in the [examples](/examples/) directory.
## Error Handling
`partialParse` throws in the following cases:
1. In all cases where your `Command` with the
[default `exitCallback`](https://github.com/tj/commander.js#override-exit-and-output-handling)
would throw an error (e.g. when displaying help)
2. In all cases where your command would throw an error before an action is
executed except for when a required `Option` (not to be confused with an
`Argument`) is missing (missing options are returned in the result object
instead).
## How It Works and Limitations
This module works by creating a (best-effort) clone of the command and its
subcommands, setting the actions to no-op functions, and then parsing the
`argv` with the cloned instance. This approach might have some limitations:
1. The implementation might break if Commander.js changes its internals
2. Custom argument and option processors are assumed to be pure functions
3. Hook listeners attached to the commands will be ignored
4. Some edge cases might not be handled correctly (please feel free to open an
issue/PR in case you find any)