Skip to content

[CLI-300] Parse -opt=value for multi-character short options - #440

Draft
tanvir-ux wants to merge 1 commit into
apache:masterfrom
tanvir-ux:CLI-300-multi-char-short-equals
Draft

[CLI-300] Parse -opt=value for multi-character short options#440
tanvir-ux wants to merge 1 commit into
apache:masterfrom
tanvir-ux:CLI-300-multi-char-short-equals

Conversation

@tanvir-ux

Copy link
Copy Markdown

Fixes https://issues.apache.org/jira/browse/CLI-300

Summary

DefaultParser.handleShortAndLongOption only treated the left-hand side of an equals token as a short option when it was a single character (opt.length() == 1). A multi-character short option such as Option.builder("foo").hasArg() therefore failed on -foo=bar with UnrecognizedOptionException, while -f=bar and -foo bar already worked.

Change

Use Options.hasShortOption(opt) for the equals path, matching the non-equals short-option lookup already used a few lines above. Single-character short options, Java-property style (-Dkey=value), and long options with a single dash (-foo=bar with longOpt("foo")) keep the same behavior.

Tests

  • DefaultParserTest#testMultiCharShortOptionWithEqual — regression for the reported case

  • DefaultParserTest#testMultiCharShortOptionWithoutEqual — paired non-equals path

  • Full mvn build succeeds locally

  • Read the contribution guidelines for this project.

  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).

  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute? Assisted with drafting the patch and PR text; change and tests authored and verified locally as Md Tanvir Alam.

  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.

  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.

  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.

  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

DefaultParser.handleShortAndLongOption only treated the left-hand side of
an equals token as a short option when it was a single character, so a
multi-character short option such as Option.builder("foo").hasArg() failed
on "-foo=bar" with UnrecognizedOptionException. Match short options with
Options.hasShortOption instead, which already works for the non-equals path.
@garydgregory
garydgregory marked this pull request as draft August 27, 2026 14:16
@garydgregory

Copy link
Copy Markdown
Member

A short option is, IIRC, by definition of length one, and allows for grouping -a -b -c into -abc.

@tanvir-ux

Copy link
Copy Markdown
Author

Thanks. POSIX short options are one character, agreed. Commons CLI currently still documents multi-character opt in OptionValidator and already parses -foo bar via hasShortOption; CLI-300 is only the missing -foo=bar path. Happy to close this if you'd rather keep the equals path limited to length-1 short options.

@garydgregory

Copy link
Copy Markdown
Member

I'll have to review the issue again later.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants