Skip to content

Strict optionals#1984

Closed
shadowspawn wants to merge 3 commits intotj:developfrom
shadowspawn:feature/strict-optionals
Closed

Strict optionals#1984
shadowspawn wants to merge 3 commits intotj:developfrom
shadowspawn:feature/strict-optionals

Conversation

@shadowspawn
Copy link
Copy Markdown
Collaborator

@shadowspawn shadowspawn commented Aug 26, 2023 •
edited
Loading

Pull Request

Problem

Commander does not support strict optional option-arguments per POSIX. This is an interesting mode as it resolves the ambiguity between an optional option-argument and a (positional) command-argument.

program -p
program -pPORT
program --port
program --port=PORT
program ARG
program -p ARG
program --port ARG

See #1901 (also #1951)

Solution

Add .strictOptionalOptionArguments() to enable the POSIX treatment.

Example:

import { Command } from 'commander';
const program = new Command();

program
  .strictOptionalOptionArguments()
  .option('-C[num], --context[=num]', 'grep style flag help')
  .option('-t, --track[=(direct|inherit)]', 'git style flag help');

program.parse();
console.log({ opts: program.opts(), args: program.args });

Note: the flags displayed in the help are as specified in the .option() call, so author can describe them in their preferred usage style .

% node index.mjs --help
Usage: index [options]

Options:
  -C[num], --context[=num]        grep style flag help
  -t, --track[=(direct|inherit)]  git style flag help
  -h, --help                      display help for command
% node index.mjs -C -t 
{ opts: { context: true, track: true }, args: [] }
% node index.mjs -C 1 -t 2
{ opts: { context: true, track: true }, args: [ '1', '2' ] }
% node index.mjs -C1 -t2  
{ opts: { context: '1', track: '2' }, args: [] }
% node index.mjs --context 1 --track 2
{ opts: { context: true, track: true }, args: [ '1', '2' ] }
% node index.mjs --context=1 --track=2
{ opts: { context: '1', track: '2' }, args: [] }

ChangeLog

@shadowspawn shadowspawn mentioned this pull request Sep 23, 2023
Closed
@shadowspawn
Copy link
Copy Markdown
Collaborator Author

shadowspawn commented Sep 23, 2023

Not sure if there is enough interest in the POSIX compatible processing to make it worth adding. Leaving #1901 open to gather up-votes and/or compelling use cases. Can reopen this if there is support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shadowspawn