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

[docs, babel-jest] Getting started: "regenerator-runtime is not explicitly required" #7082

Closed
twisty opened this issue Oct 1, 2018 · 7 comments

Comments

@twisty
Copy link

twisty commented Oct 1, 2018

The example commands to install babel-jest (in “Additional Configuration > Using Babel”) all include installing the regenerator-runtime package.

Then, there is a note that reads:

Note: Explicitly installing regenerator-runtime is not needed if you use npm 3 or 4 or Yarn

Does this mean regenerator-runtime is required on npm@<3||>4, or this documentation outdated?

If this is the case, maybe we should not include installing regenerator-runtime in the yarn add example, and change the note to mandate installing regenerator-runtime for the minority still using npm version 1.x or 2.x?

@twisty
Copy link
Author

twisty commented Oct 9, 2018

Are we asking users to superfluously add regenerator-runtime dependency to their projects, when this is only required for users running outdated versions of npm?

I'm happy to rewrite the doc and send a PR if this is the case.

I don't have the capacity to dig into the technical facts, maybe someone reading this can shed some light?

@rickhanlonii
Copy link
Member

Hey @twisty, thanks for working to improve this

Check out the discussion here I think that's where this originated

@twisty
Copy link
Author

twisty commented Oct 12, 2018

@rickhanlonii Will check that out, thanks.

@ifoi
Copy link

ifoi commented Feb 22, 2022

Is this still an issue .. and if so .. Can i take this up?
and what is the verdict on Babel section of the docs regarding regenerator-runtime?

@mrazauskas
Copy link
Contributor

The documentation related to regenerator-runtime was removed in #7016. Most probably this is not an issue any more.

@SimenB
Copy link
Member

SimenB commented Feb 22, 2022

Yep, this is no longer relevant. Thanks for the offer, though! #7595 removed it from Jest

@SimenB SimenB closed this as completed Feb 22, 2022
@github-actions
Copy link

This issue 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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants