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: remove deprecated setupTestFrameworkScriptFile option and setupFilesAfterEnv instead #11910

Merged
merged 2 commits into from
Sep 29, 2021
Merged

docs: remove deprecated setupTestFrameworkScriptFile option and setupFilesAfterEnv instead #11910

merged 2 commits into from
Sep 29, 2021

Conversation

mrazauskas
Copy link
Contributor

Summary

setupTestFrameworkScriptFile option is deprecated in favor of setupFilesAfterEnv since v24: https://github.com/facebook/jest/releases/tag/v24.0.0

It was still present in the CLI API docs. Time to say good bye?

In the CLI API docs I simply replaced it with setupFilesAfterEnv which was not documented before.

Also:

  • removed a note on deprecation of setupTestFrameworkScriptFile in Configuration docs. Only v26 and v27. Did not touch earlier ones on purpose. The note is good to have in v24 docs (and perhaps 25?).
  • replaced setupTestFrameworkScriptFile -> setupFilesAfterEnv elsewhere.
  • and added @deprecated in typings.

Test plan

The code was not touched. Just in case, I tryout out if the CLI option works as documented. It does.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! long overdue 🙂

@SimenB SimenB merged commit aaed73a into jestjs:main Sep 29, 2021
@mrazauskas mrazauskas deleted the docs-remove-setupTestFrameworkScriptFile branch September 29, 2021 14:02
@github-actions
Copy link

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.

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

Successfully merging this pull request may close these issues.

3 participants