Fix detection of the implicit help option - #1371
Open
czpilar wants to merge 1 commit into
Open
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Signed-off-by: David Pilar <david@czpilar.net>
czpilar
force-pushed
the
patches/1370-help-option-detection
branch
from
63a99dc to
6a18816
Compare
August 23, 2026 15:41
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #1370
isHelp() now ignores options the command declares itself, so a declared -h is no longer hijacked as help. The dispatch condition is relaxed from options.size() == 1 to anyMatch, so help is honoured alongside other options - the two defects cannot be fixed separately, see the issue for why.
Case sensitivity
isHelp() also matched the long form case-insensitively, unlike every other option comparison in the codebase. This PR changes it to "help".equals(...), so --HELP is no longer treated as help. Repro and details in #1370.
The alternative - making the long form consistently case-insensitive - would imply -H is help, and -H is an established distinct flag elsewhere (curl -H, grep -H, ls -H), which is exactly the hijack this PR fixes. Nothing documents the uppercase spelling: the built-in help prints --help or -h for every command, and the reference docs mention only
--help / -h.
Note on the dispatch condition
commands/help.adoc already states that help short-circuits execution "regardless what other command-line options are typed", so relaxing options.size() == 1 to anyMatch brings the code in line with documented behaviour rather than changing it.