feat: warn on hidden, deprecated aliases#1555
Merged
jfeingold35 merged 1 commit intooclif:mainfrom Mar 12, 2026
Merged
Conversation
3 tasks
Contributor
|
@rexxars , thanks for creating this. I'll get it reviewed, QA'd, and let you know if anything needs to change or if it's good to merge. |
jfeingold35
approved these changes
Mar 12, 2026
Contributor
|
@rexxars , I've QA'd this and all the tests are green, so I'm going to go ahead and merge this. Thank you so much! |
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.
In my opinion,
deprecateAliasesshould also checkhiddenAliasesWhen deprecating a command alias, the natural combination is:
Currently,
deprecateAliasesonly checksaliases:This means there's no way to get both behaviors. You either:
aliases+deprecateAliases: true→ warns, but still shows in helphiddenAliases+deprecateAliases: true→ hidden, but no warningaliasesandhiddenAliases→aliaseswins, still shows in helpProposed fix:
warnIfCommandDeprecatedshould check both arrays.This would let you do the standard deprecation flow: move an alias from
aliasestohiddenAliases, setdeprecateAliases: true, and get the expected behavior - hidden from help, warns on use.