feat: deprecate scopedEnvVarKey for scopedEnvVarKeys which accounts for binAliases #751
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
WillieRuemmele
commented
Jul 26, 2023
| @@ -22,7 +22,7 @@ const pjson = { | |||
| files: [], | |||
| commands: {}, | |||
| oclif: { | |||
| binAliases: ['foo', 'bar'], | |||
| binAliases: ['bar', 'baz'], | |||
There was a problem hiding this comment.
the bin is foo, changed to remove confusing assertions
This was referenced Jul 26, 2023
mdonnalley
reviewed
Jul 27, 2023
src/config/config.ts
Outdated
| return v === '1' || v === 'true' | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated - use scopedEnvVarKeys instead which will account for bin aliases, this could be private/removed in a major |
There was a problem hiding this comment.
I'm not sure how I feel about deprecating this since the overwhelming majority of oclif CLIs won't ever use bin aliases. For them it would be annoying to have to deal with an array when it's always going to be an array with one element in it
I wonder if it might be better to keep it un-deprecated and just document clearly in the jsdoc that if they're using bin aliases they should use the other method
What do you think?
mdonnalley
approved these changes
Jul 28, 2023
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.
@W-13825184@