docs: remove deprecated setupTestFrameworkScriptFile option and `se…

…tupFilesAfterEnv` instead (#11910)

docs/CLI.md

@@ -290,9 +290,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

docs/JestObjectAPI.md

@@ -276,7 +276,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
 

packages/jest-types/src/Config.ts

@@ -211,6 +211,9 @@ export type InitialOptions = Partial<{
   runTestsByPath: boolean;
   scriptPreprocessor: string;
   setupFiles: Array<Path>;
+  /**
+   * @deprecated Use `setupFilesAfterEnv` options instead.
+   */
   setupTestFrameworkScriptFile: Path;
   setupFilesAfterEnv: Array<Path>;
   silent: boolean;

website/versioned_docs/version-25.x/CLI.md

@@ -274,9 +274,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

website/versioned_docs/version-25.x/JestObjectAPI.md

@@ -272,7 +272,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
 

website/versioned_docs/version-26.x/CLI.md

@@ -290,9 +290,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

website/versioned_docs/version-26.x/Configuration.md

@@ -898,8 +898,6 @@ If you want a path to be [relative to the root directory of your project](#rootd
 
 For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in these modules.
 
-_Note: `setupTestFrameworkScriptFile` is deprecated in favor of `setupFilesAfterEnv`._
-
 Example `setupFilesAfterEnv` array in a jest.config.js:
 
 ```js

website/versioned_docs/version-26.x/JestObjectAPI.md

@@ -276,7 +276,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
 

website/versioned_docs/version-27.0/CLI.md

@@ -290,9 +290,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

website/versioned_docs/version-27.0/Configuration.md

@@ -925,8 +925,6 @@ If you want a path to be [relative to the root directory of your project](#rootd
 
 For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in these modules.
 
-_Note: `setupTestFrameworkScriptFile` is deprecated in favor of `setupFilesAfterEnv`._
-
 Example `setupFilesAfterEnv` array in a jest.config.js:
 
 ```js

website/versioned_docs/version-27.0/JestObjectAPI.md

@@ -276,7 +276,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
 

website/versioned_docs/version-27.1/CLI.md

@@ -290,9 +290,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

website/versioned_docs/version-27.1/Configuration.md

@@ -925,8 +925,6 @@ If you want a path to be [relative to the root directory of your project](#rootd
 
 For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in these modules.
 
-_Note: `setupTestFrameworkScriptFile` is deprecated in favor of `setupFilesAfterEnv`._
-
 Example `setupFilesAfterEnv` array in a jest.config.js:
 
 ```js

website/versioned_docs/version-27.1/JestObjectAPI.md

@@ -276,7 +276,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
 

website/versioned_docs/version-27.2/CLI.md

@@ -290,9 +290,9 @@ Run only the tests that were specified with their exact paths.
 
 _Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
 
-### `--setupTestFrameworkScriptFile=<file>`
+### `--setupFilesAfterEnv <path1> ... <pathN>`
 
-The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.
+A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
 
 ### `--showConfig`
 

website/versioned_docs/version-27.2/Configuration.md

@@ -929,8 +929,6 @@ If you want a path to be [relative to the root directory of your project](#rootd
 
 For example, Jest ships with several plug-ins to `jasmine` that work by monkey-patching the jasmine API. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in these modules.
 
-_Note: `setupTestFrameworkScriptFile` is deprecated in favor of `setupFilesAfterEnv`._
-
 Example `setupFilesAfterEnv` array in a jest.config.js:
 
 ```js

website/versioned_docs/version-27.2/JestObjectAPI.md

@@ -276,7 +276,7 @@ jest.mock(
 );
 ```
 
-> **Warning:** Importing a module in a setup file (as specified by `setupTestFrameworkScriptFile`) will prevent mocking for the module in question, as well as all the modules that it imports.
+> **Warning:** Importing a module in a setup file (as specified by `setupFilesAfterEnv`) will prevent mocking for the module in question, as well as all the modules that it imports.
 
 Modules that are mocked with `jest.mock` are mocked only for the file that calls `jest.mock`. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.