Add support for synonyms in subcommands and options#208
Open
ianloic wants to merge 2 commits intogoogle:masterfrom
Open
Add support for synonyms in subcommands and options#208ianloic wants to merge 2 commits intogoogle:masterfrom
ianloic wants to merge 2 commits intogoogle:masterfrom
Conversation
This commit introduces the `synonyms` attribute to `#[argh()]`, allowing users to specify alternative names for subcommands, options, and switches. Synonyms are hidden from the help output but are accepted during parsing. Key changes: - Added `synonyms = ["..."]` attribute support in argh_derive. - Extended `SubCommand` trait with `SYNONYMS` constant. - Extended `SubCommands` trait with `COMMAND_SYNONYMS` constant. - Updated `ParseStructSubCommand::parse` to check synonyms. - Updated documentation with examples. This implementation avoids breaking changes to the public `CommandInfo` API by storing synonym information in the `SubCommand` trait instead.
erickt
requested changes
Feb 20, 2026
| ); | ||
| errors.err_span_tokens(field.field, "Later usage here."); | ||
| } | ||
| // Synonyms are treated as long names, so we don't check against short names unless we want to support short synonyms (which we don't seem to support explicitly as short flags). |
Collaborator
There was a problem hiding this comment.
can you remove this comment?
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
2 participants
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.
This commit introduces the
synonymsattribute to#[argh()], allowing users to specify alternative names for subcommands, options, and switches. Synonyms are hidden from the help output but are accepted during parsing.Key changes:
synonyms = ["..."]attribute support in argh_derive.SubCommandtrait withSYNONYMSconstant.SubCommandstrait withCOMMAND_SYNONYMSconstant.ParseStructSubCommand::parseto check synonyms.This implementation avoids breaking changes to the public
CommandInfoAPI by storing synonym information in theSubCommandtrait instead.