feat: warn about alias deprecations #540
Merged
Conversation
This file contains 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
mshanemc
previously approved these changes
Oct 28, 2022
src/command.ts
Outdated
|
|
||
| const deprecateAliases = this.ctor.flags[flag]?.deprecateAliases | ||
| const aliases = this.ctor.flags[flag]?.aliases ?? [] | ||
| if (deprecateAliases && aliases) { |
There was a problem hiding this comment.
aliases will always be true since it's ?? [] (empty arrays are truthy).
Did you maybe want aliases.length?
src/command.ts
Outdated
| const deprecateAliases = this.ctor.flags[flag]?.deprecateAliases | ||
| const aliases = this.ctor.flags[flag]?.aliases ?? [] | ||
| if (deprecateAliases && aliases) { | ||
| const foundAliases = this.argv.filter(a => aliases.includes(a.replace(/-/g, ''))) |
There was a problem hiding this comment.
argv has the --/- on all the flag names e.g., ['--foo', '--bar', '-b']
But the flag aliases don't have the prefix, e.g. ['foo', 'bar', 'b']
So in order to find the intersection, we have to remove all the -s first
There was a problem hiding this comment.
what happens for target-org and no-prompt and the like?
src/flags.ts
Outdated
| @@ -37,7 +37,7 @@ export const help = (opts: Partial<BooleanFlag<boolean>> = {}) => { | |||
| description: 'Show CLI help.', | |||
| ...opts, | |||
| parse: async (_: any, cmd: Command) => { | |||
| new Help(cmd.config).showHelp(cmd.argv) | |||
| new Help(cmd.config).showHelp([cmd.id!, ...cmd.argv]) | |||
There was a problem hiding this comment.
I'm not sure if it matters or not, but I have seen scenarios where a command doesn't have an ID, particularly when we do weird things with them in UT.
One of those "I'm super cautious about asserting things to TS"
mshanemc
approved these changes
Oct 28, 2022
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.
deprecateAliasestoCommand- allowing you to emit warnings anytime a command alias is useddeprecateAliasesto all flags - allowing you to emit warnings anytime a flag alias is used