feat: support hiding selected command aliases from help#2361
Open
pixel365 wants to merge 1 commit intospf13:mainfrom
Open
feat: support hiding selected command aliases from help#2361pixel365 wants to merge 1 commit intospf13:mainfrom
pixel365 wants to merge 1 commit intospf13:mainfrom
Conversation
Introduce MarkAliasesHidden and HasVisibleAliases to allow commands to retain deprecated or compatibility aliases without displaying them in help and usage output.
1668fad to
9b9fbff
Compare
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
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.
Summary
Support hiding selected command aliases from help output.
Motivation
Some commands may retain deprecated or compatibility aliases
that should remain functional but not be displayed in help
and usage text.
Currently, aliases are always shown if defined, which makes it
impossible to keep backward-compatible aliases without exposing
them in help output.
Changes
MarkAliasesHiddento allow marking specific aliases as hidden.HasVisibleAliasesto determine whether aliases should be rendered.NameAndAliasesand usage rendering to exclude hidden aliases.