Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): improve --help printout by removing defunct --browser option #11914

Merged
merged 3 commits into from Sep 30, 2021

Conversation

@mrazauskas
Copy link
Contributor

@mrazauskas mrazauskas commented Sep 30, 2021

Summary

It seems like --browser flag 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 yargs is including it in the printout of --help option. 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 use yargs’s deprecation mechanism as an alternative.

Test plan

yarn jest --help to see that --browser is included without deprecation note.

SimenB
SimenB approved these changes Sep 30, 2021
Copy link
Collaborator

@SimenB SimenB left a comment

Oops yeah, good catch!

Loading

@SimenB SimenB merged commit ba55fe7 into facebook:main Sep 30, 2021
30 checks passed
Loading
@mrazauskas mrazauskas deleted the fix-cli-remove-browser-option branch Sep 30, 2021
@github-actions
Copy link

@github-actions github-actions bot commented Oct 31, 2021

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

Loading

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants