fix(cli): improve --help printout by removing defunct --browser option#11914
Merged
SimenB merged 3 commits intojestjs:mainfrom Sep 30, 2021
mrazauskas:fix-cli-remove-browser-option
Merged
fix(cli): improve --help printout by removing defunct --browser option#11914SimenB merged 3 commits intojestjs:mainfrom mrazauskas:fix-cli-remove-browser-option
--help printout by removing defunct --browser option#11914SimenB merged 3 commits intojestjs:mainfrom
mrazauskas:fix-cli-remove-browser-option
Conversation
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Summary
It seems like
--browserflag was left by mistake in the CLI API. @SimenB Wasn’t it supposed to be remove in #9943? Or is this intentional?The flag does nothing and is not documented. But
yargsis including it in the printout of--helpoption. That’s misleading. This PR is an attempt to improve the printout. If the removal looks like a breaking change, it might be better to useyargs’s deprecation mechanism as an alternative.Test plan
yarn jest --helpto see that--browseris included without deprecation note.